Skip to main content

System

GET /v2/health

Service health

Always answers 200, even during maintenance — the body carries the state. A MAINTENANCE status means every other route is returning 503, so poll this to know when to resume instead of probing a real endpoint.

Responses

CodeDescriptionBody
200Success.HealthResponse
500application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).

GET /v2/time

Server time for request signing and clock synchronization

Responses

CodeDescriptionBody
200Success.TimeResponse
500application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).

Schemas

HealthResponse

FieldTypeDescription
statusUP | MAINTENANCEUP when serving normally. MAINTENANCE when the API is in maintenance — every other route is returning 503 with the maintenance problem type, so retry later rather than treating it as an outage. e.g. UP.

Problem

FieldTypeDescription
typestringStable problem-type URI. Resolves to docs for this error. e.g. https://docs.skipo.com/errors/rate_limited.
titlestringShort, human-readable summary (stable, English). e.g. Rate limit exceeded.
statusnumberHTTP status code. e.g. 429.
codestringStable machine-readable error code (equals the last path segment of type). e.g. rate_limited.
retryablebooleanWhether retrying the identical request may succeed. e.g. true.
detail (optional)stringHuman-readable, possibly localized detail.
instance (optional)stringThe request path that produced the error.
traceId (optional)stringTrace id — joins BigQuery api_request and Cloud Logging.

TimeResponse

FieldTypeDescription
serverTimenumberServer time, milliseconds since Unix epoch. e.g. 1783003522123.
isostringThe same instant as ISO-8601 UTC. e.g. 2026-07-28T12:34:56.789Z.

Back to the endpoint reference. See also: Pagination · Errors · Ids and correlation.