Skip to content

unavailable ​

A fact about the deployment, not the request, stopped the answer.

StatusTitletype
503Service unavailablehttps://substrat.net/errors/unavailable

What it means ​

The request may be fine. Something the platform needs in order to answer it is not in place, or is not answering right now. It is not the caller's fault and not a fault in the request.

When it is returned ​

  • A host started without configuration it needs, such as the key its secrets are sealed with.
  • A scope store that failed, or answered with a status that has no code of its own. storeCode carries the store's own code.
  • A scope that kept restarting under a module's system door (reason: system_door_wait).

What it carries ​

  • reason: A slug the refusing module owns, narrowing the code. The platform's own are snake_case, but the wire does not enforce a grammar, so compare it as an opaque string. Branch on it; never show it.

Relayed from a scope store, it may also carry storeCode and storeBody. See the body for the members any problem may carry.

What to do ​

Retry later, with backoff. A read is safe to repeat. A write is safe to repeat only when it was sent with an Idempotency-Key to an operation whose /openapi.json documents that header, and the retry sends the same key. Not every surface honours the header, so elsewhere check whether the first attempt took effect before sending it again. If it persists, it needs an operator: report it and quote requestId.

In /openapi.json ​

Documented on every operation's failure responses.

Every error code