Public & system API
Readiness check
Readiness probe: the database is reachable and migrations are applied.
GET
https://api.screamingdata.dev/ready- Authentication
- None
- Cost
- Free
- Body
- No request body
Overview
Returns 200 when the instance can serve traffic: the database is reachable and all migrations are applied. Otherwise it returns 503 and lists the pending migrations. Use it as the readiness probe of your orchestrator. The body is not wrapped in the response envelope.
Cost
Free.
Request
GET /ready.
This endpoint takes no parameters.
Request example
This endpoint does not need credentials.
curl --request GET \
--url "https://api.screamingdata.dev/import requests
response = requests.get(
"https://api.screamingdata.dev/const response = await fetch("https://api.screamingdata.dev/Response
HTTP 200. The body is plain JSON (not wrapped in the response envelope).
{
"status": "ready",
"database": true,
"pending_migrations": []
}Example: Not ready (HTTP 503)
{
"status": "not_ready",
"database": true,
"pending_migrations": [
"0002_engine.sql"
]
}Result fields
Readiness report. Not wrapped in the response envelope.
statusstring
ready or not_ready.
databaseboolean
Whether the database answered.
pending_migrationsarray of strings
Database migrations that are not applied yet (empty when ready).
HTTP status codes
- 200Ready to serve traffic.
- 503Not ready: the database is unreachable or migrations are pending.