endstate.service.health

health(options?: RequestOptions): Promise<HealthResponse>

Retried on network failure, timeout, 429, and 5xx.

Example

const result = await endstate.service.health();

200 - HealthResponse.

'ok'

required

'endstate-api'

required

string

required

string

required

string

required

Branch on error.code, never on the HTTP status - several codes share one.

Code	HTTP	Retry
`internal.error`	500	Safe to retry

See Errors and retries for the error types and how to narrow them.