API reference

API reference · Public

The shape this instance is running in

GET/api/relay/statusNo key

Which node answered, whether its rate limit windows are shared with the other instances or counted on its own, whether storage is a local file or a networked database, whether the catalog is restricted by a deployment allowlist, and what the per instance cache layer is doing. It names no secret, no database url and no allowlist pattern. Send the operator secret in x-admin-secret for the counts an operator needs while wiring a relay up.

Answer 200

The deployment shape of the instance that answered.

Fields of the 200 answer
FieldTypeWhat it is
regionstringThe operator's label for where this instance runs, or null.
instancestringThis process, for a log line. Never an authentication.
rateLimitobject
storagestring"file" or "remote".
catalogobject
cacheobject
operatorobject
Antimatter