curl --request GET \
--url 'https://api.nsr.stateset.com/ready' \
--header "X-API-Key: $STATESET_NSR_API_KEY"
{
"issues": [
"string"
],
"ready": true,
"status": "pending",
"version": "2026-08-01",
"warnings": [
"string"
]
}
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…
GET
/
ready
curl --request GET \
--url 'https://api.nsr.stateset.com/ready' \
--header "X-API-Key: $STATESET_NSR_API_KEY"
{
"issues": [
"string"
],
"ready": true,
"status": "pending",
"version": "2026-08-01",
"warnings": [
"string"
]
}
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_URLis configured - Engine is initialized and operational Example
curl -X GET 'https://api.nsr.stateset.com/ready'
Response
ReadyResponse
string[]
List of issues blocking readiness
boolean
required
string
required
ready | degraded
string
required
string[]
Status codes
| Code | Meaning |
|---|---|
200 | Service is ready to receive traffic |
503 | Service is not ready |
curl --request GET \
--url 'https://api.nsr.stateset.com/ready' \
--header "X-API-Key: $STATESET_NSR_API_KEY"
{
"issues": [
"string"
],
"ready": true,
"status": "pending",
"version": "2026-08-01",
"warnings": [
"string"
]
}
Last modified on August 31, 2026