Skip to content

Unavailable ​

unavailableHTTP 503Worth retrying

The server or something it depends on is down for the moment.

Why it happens ​

  • The service is restarting, overloaded, or cannot reach its database.

What to do ​

  • Try again after a short wait, backing off between attempts. Commands keep their idempotency key, so they never run twice.

What it looks like ​

Inside a batch, the operation's frame carries it:

json
{
  "id": 1,
  "error": {
    "code": "unavailable",
    "message": "Database unavailable"
  },
  "fin": true
}

retryable appears only where it differs from the code's default, which is the one at the top of this page.

When the whole request is refused over HTTP, the answer is a problem document:

json
{
  "type": "https://eddyboutros.github.io/rayfold/errors/unavailable",
  "title": "unavailable",
  "status": 503,
  "detail": "Database unavailable",
  "code": "unavailable"
}

See also all error types and the errors chapter of the specification.

Released under the Apache-2.0 license.