> ## 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.

# Readiness probe for Kubernetes and orchestration systems

> Returns 200 when the service is fully configured and ready to handle traffic. Returns 503 with a list of issues when the service is degraded or not ready…

Returns 200 when the service is fully configured and ready to handle traffic.
Returns 503 with a list of issues when the service is degraded or not ready.
**Checks Performed**

* API keys are configured (production safety)
* Persistence is configured (data safety)
* Database is reachable when `NSR_DATABASE_URL` is configured
* Engine is initialized and operational
  **Example**

```bash theme={null}
curl -X GET 'https://api.nsr.stateset.com/ready'
```

### Response

`ReadyResponse`

<ResponseField name="issues" type="string[]">
  List of issues blocking readiness
</ResponseField>

<ResponseField name="ready" type="boolean" required />

<ResponseField name="status" type="string" required>
  ready | degraded
</ResponseField>

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

<ResponseField name="warnings" type="string[]" />

### Status codes

| Code  | Meaning                             |
| ----- | ----------------------------------- |
| `200` | Service is ready to receive traffic |
| `503` | Service is not ready                |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.nsr.stateset.com/ready' \
    --header 'X-API-Key: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "issues": [
      "string"
    ],
    "ready": true,
    "status": "pending",
    "version": "2026-08-01",
    "warnings": [
      "string"
    ]
  }
  ```
</ResponseExample>