API reference · Health

Readiness

Readiness. Checks the dependencies a request actually needs, so a load balancer stops sending traffic to an instance that cannot serve.

gethttps://api.integrable.cloud/health/ready

Authentication: None
Retries: Safe to repeat
Body: None
Version: 2026-09-03

Responses

200OKapplication/json
object
5 response headers
RateLimit-Limit
Requests permitted in the current window.
RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
RateLimit-Reset
Seconds until the current window resets.
X-API-Version
The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.
X-Request-ID
Quote this in a support request to identify the call.

Example request

curl

curl "https://api.integrable.cloud/health/ready"

Set INTEGRABLE_API_KEY first. The same call from the TypeScript or Python SDK takes the same fields.

Errors

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-bot limit on top.

More Health endpoints

get/healthLiveness

Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.