Shotstash
API referenceREST referenceSystem

Instance status

Version and storage and database and cache and search and the processing queue for the status page. Only for accounts that may configure the instance; everyone else gets 404.

Try the REST routes against the public demo at https://demostash.aldyernesto.my.id. Get a read-only token (valid for 60 minutes), then paste it as the Bearer token in the console of any route.

GET
/api/v1/status

Version and storage and database and cache and search and the processing queue for the status page. Only for accounts that may configure the instance; everyone else gets 404.

Authorization

SessionToken
headerAuthorizationBearer <token>

Session token from POST /api/v1/auth/login or the login mutation, sent as Authorization: Bearer <token>.

Response Body

Instance status

application/json
  1. response
version*string

Running version.

storage*

Storage backend status.

database*boolean

The database answers.

cache*boolean

Dragonfly answers.

search*boolean

Elasticsearch search is configured.

workers*|

Registered workers seen within the lease; null when the database cannot answer.

queuedJobs*|

Every queued job (with or without a live worker); null when the database cannot answer.

jobs*|

Queue figures by state; null when the database cannot answer.

curl -X GET "https://example.com/api/v1/status"
{  "version": "string",  "storage": {    "backend": "string",    "reachable": true  },  "database": true,  "cache": true,  "search": true,  "workers": 0,  "queuedJobs": 0,  "jobs": {    "queued": 0,    "waitingForWorker": 0,    "claimed": 0,    "running": 0,    "done24h": 0,    "failed24h": 0,    "cancelled24h": 0  }}