Sluby
REST APIOps

Live platform status: database, redis, Sia indexer, reconciliation, cache.

Admins get the full report; members a health summary (see SystemStatus).

GET
/api/v1/system/status

Admins get the full report; members a health summary (see SystemStatus).

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Sluby API key (sluby_...) sent as Authorization: Bearer <key>. Keys carry scopes: upload, read, manage.

Response Body

Status report.

application/json
  1. response

Live status. Its shape depends on scope: admins (deployment) get the full report; members (account) get a health summary without the indexer account, the indexer url, probe error text, process uptime, the delivery cache or the deployment-wide reconciliation result.

scope*unknown
status*string
Value in"ok""degraded""down"
checked_at*string
Formatdate-time
version*string
uptime_seconds*integer
database*
redis*
indexer*
reconciliation*|null
cache*
Example Request
curl -X GET 'https://sluby.example.com/api/v1/system/status'
Example Response
{  "scope": "deployment",  "status": "ok",  "checked_at": "2019-08-24T14:15:22Z",  "version": "string",  "uptime_seconds": 0,  "database": {    "ok": true,    "latency_ms": 0,    "error": "string"  },  "redis": {    "ok": true,    "latency_ms": 0,    "error": "string"  },  "indexer": {    "ok": true,    "latency_ms": 0,    "error": "string",    "url": "string",    "network": "string",    "account": {      "account_key": "string",      "ready": true,      "app_name": "string",      "pinned_data": 0,      "pinned_size": 0,      "max_pinned_data": 0,      "remaining_storage": 0,      "last_used": "2019-08-24T14:15:22Z"    },    "hosts": {      "total": 0,      "good_for_upload": 0,      "countries": 0    }  },  "reconciliation": {    "status": "ok",    "finished_at": "2019-08-24T14:15:22Z",    "in_sync_count": 0,    "orphan_count": 0,    "missing_count": 0  },  "cache": {    "hits": 0,    "misses": 0,    "object_bytes": 0,    "object_max_bytes": 0,    "object_items": 0,    "manifest_items": 0  }}

Plays per day of the workspace’s videos. GET

Plays of the workspace’s videos per UTC day for the last `days` days, today included, oldest first, with days without plays as 0. What counts as a play is described on `play_count` of an asset.

Platform metrics (prometheus registry as JSON). GET

The registry counts the whole process, so only an admin may read it.