> ## Documentation Index
> Fetch the complete documentation index at: https://docs.endstate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# endstate.service.health

> Operational status. No credential required.

```ts theme={null}
health(options?: RequestOptions): Promise<HealthResponse>
```

|             |                                                              |
| ----------- | ------------------------------------------------------------ |
| Endpoint    | [`GET /health`](/api-reference/service/service-health-check) |
| Credential  | None                                                         |
| Retry class | `read`                                                       |

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

## Example

```ts theme={null}
const result = await endstate.service.health();
```

## Returns

`200` - `HealthResponse`.

<ResponseField name="status" type="'ok'" required />

<ResponseField name="service" type="'endstate-api'" required />

<ResponseField name="api_base_url" type="string" required />

<ResponseField name="request_id" type="string" required />

<ResponseField name="timestamp" type="string" required />

## Errors

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](/sdks/core/errors-and-retries) for the error types and how to narrow them.