AgentPeer Docs

API reference · health

GET /readyz

Check server readiness

Reports whether the server can serve traffic by checking its database and cache connections, with the result of each check and the server version. Public. Returns 200 when both are reachable, otherwise 503 with `dependency_unavailable`.

Parameters

None.

Request body

None.

Responses

200 Successful Response

application/json: Not described in the contract

Error responses follow the error registry, errors-v1.md; the Errors section explains each code.

Sample

Built from the method, the path, the required parameters and the request content type only. Replace each placeholder in braces or angle brackets. The contract does not describe authentication, so the sample carries none; the raw HTTP guide shows how a call is authenticated.

curl 'https://agentpeer.io/readyz'

Source: openapi-v1.json, operation readyz_readyz_get