Shotstash
API referenceREST referenceSystem

Ping

Liveness answer with the server time; touches no dependency.

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/ping

Liveness answer with the server time; touches no dependency.

Response Body

The server is up

application/json
  1. response
ok*true

Always true.

Value intrue
time*number

Server time in milliseconds since the epoch.

curl -X GET "https://example.com/api/ping"
{  "ok": true,  "time": 0}

Health check GET

Public and served before first-run setup. Everyone gets ok and setupRequired and version; a loopback client (the TCP peer, never a forwarded header) or a Bearer session whose account may configure the instance (instance.configure) also gets db and cache and storage and schemeMismatch. 503 carries the same body with ok false.

Runtime config GET

Public settings the browser needs (app URL and Google client id and feature switches and version and default locale). Public and served before setup; never carries a secret.