curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/health/ready' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"database": "string",
"status": "pending",
"tenant_cache": {
"cached_dbs": 1,
"enabled": true,
"evictions": 1,
"hits": 1,
"in_use_cached_dbs": 1,
"max_cached_dbs": 1,
"misses": 1,
"rejections": 1
}
}
Readiness
readiness probe that checks DB connectivity
GET
/
health
/
ready
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/health/ready' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"database": "string",
"status": "pending",
"tenant_cache": {
"cached_dbs": 1,
"enabled": true,
"evictions": 1,
"hits": 1,
"in_use_cached_dbs": 1,
"max_cached_dbs": 1,
"misses": 1,
"rejections": 1
}
}
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 and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Response
ReadyResponse
string
required
string
required
TenantCacheResponse,null
Tenant cache status included in health and readiness responses.
Status codes
| Code | Meaning |
|---|---|
200 | Service is ready |
503 | Service is not ready |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/health/ready' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"database": "string",
"status": "pending",
"tenant_cache": {
"cached_dbs": 1,
"enabled": true,
"evictions": 1,
"hits": 1,
"in_use_cached_dbs": 1,
"max_cached_dbs": 1,
"misses": 1,
"rejections": 1
}
}
Last modified on September 21, 2026