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

# V1 Health

> Return 200 with a minimal liveness payload, or 503 on db failure.

<Warning>
  **Confirm your deployment before running this request.** This page describes an API contract;
  a published reference does not establish hosted availability. Check the dated
  [host report](/api-reference/hosts) and obtain your deployment URL and credentials.
  Replace the example host if your provisioned service uses a different URL.
</Warning>

Return 200 with a minimal liveness payload, or 503 on db failure.

### Response

`HealthResponse`

<ResponseField name="status" type="string" required>
  Allowed values: `'ok'`, `'degraded'`.
</ResponseField>

<ResponseField name="service" type="string" required>
  Static service identifier.
</ResponseField>

<ResponseField name="timestamp" type="string" required>
  ISO 8601 UTC timestamp of the check.
</ResponseField>

<ResponseField name="checks" type="object" required>
  Per-component check results. Currently only `database`. Additional keys map to values of type `string`.
</ResponseField>

### Status codes

| Code | Meaning |
| - | - |
| `200` | Successful Response |

### Using this contract

Read the [source OpenAPI document](/spec/computer-use.json) for declared schemas and alternatives.
This page also includes documented corrections from the [spec overlays](https://github.com/stateset/docs/tree/main/spec/overlays).
Example IDs and values are illustrative; replace them with records from your workspace.

<RequestExample>
  ```bash cURL theme={null}
  curl --silent --show-error --fail-with-body --request GET \
    --url 'https://api.computer.stateset.app/api/v1/health' \
    --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "ok",
    "service": "string",
    "timestamp": "2026-08-31T14:22:05Z",
    "checks": {}
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.