API

unavailable

HTTP 503. Service unavailable

What it means

Maintenance, or a dependency is down.

What to do

Wait retry_after seconds and retry. GET /api/v1/health reports the state of the dependencies.

Retrying

Retry after the delay in Retry-After (or retry_after).

Extra members

retry_after: Seconds to wait; mirrors Retry-After.

Example

json

{
  "type": "https://reuseforge.com/docs/api/errors/unavailable",
  "title": "Service unavailable",
  "status": 503,
  "detail": "The service is temporarily unavailable.",
  "instance": "/api/v1/items/acme/invoice-extractor",
  "code": "unavailable",
  "request_id": "req_c4v8n2m6x1z3",
  "retry_after": 30
}

Every error is application/problem+json (RFC 9457). Branch on code, show detail to people and quote request_id when you ask for help. See the error catalogue.