Interface StatusPing

Health check response confirming the API is reachable and indicating whether the caller's token is valid.

interface StatusPing {
    deployment?: Deployment;
    success: boolean;
    token: Record<string, unknown>;
    user?: User | null;
}

Properties

deployment?: Deployment

Deployment metadata.

success: boolean

true when the platform is reachable and the request was processed successfully.

token: Record<string, unknown>

Details about the authentication token used in this request.

user?: User | null

The authenticated user associated with the token. null when the token is invalid or absent.