API reference/Ops: system

Describe this instance

GET/ops/system

Readiness checks, database pool and migrations, Go runtime and job workers of the instance that answers. A failing database still returns 200, with the failure in checks and database. Other instances: GET /ops/releases/instances.

bearer auth

Responses

200OKapplication/json

checksarray of objectrequired

Readiness checks, as /readyz runs them

databaseobjectrequired

errorstring

What failed; never the driver's message

migrationsobjectrequired

currentinteger (int64)required

Highest applied version

latestinteger (int64)required

Highest version in the app's migration files

pendinginteger (int64)required

ping_msinteger (int64)required

poolobjectrequired

acquiresinteger (int64)required

average_acquire_msnumber (double)required

canceled_acquiresinteger (int64)required

empty_acquiresinteger (int64)required

Acquires that waited because no connection was idle

idleinteger (int32)required

in_useinteger (int32)required

maxinteger (int32)required

totalinteger (int32)required

statusstringrequired

one of "ok", "error"

instanceobjectrequired

build_timestring

commitstring

idstringrequired

Random per process start; matches instance_id in /ops/releases/instances

modifiedbooleanrequired

Built with uncommitted changes

started_atstring (date-time)required

uptime_secondsinteger (int64)required

versionstringrequired

jobsobjectrequired

queuesarray of stringrequired

workersinteger (int64)required

Job workers this instance runs

runtimeobjectrequired

gcsinteger (int32)required

≥ 0

go_versionstringrequired

gomaxprocsinteger (int64)required

goroutinesinteger (int64)required

heap_in_use_bytesinteger (int64)required

≥ 0

last_gc_pause_msnumber (double)required

401Unauthorizedapplication/problem+json

codestringrequired

Stable machine-readable error code

detailstring

Human-readable explanation

errorsarray of object

Field-level validation errors

request_idstring

Correlates with server logs and traces

statusinteger (int64)required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

URI identifying the problem type

403Forbiddenapplication/problem+json

codestringrequired

Stable machine-readable error code

detailstring

Human-readable explanation

errorsarray of object

Field-level validation errors

request_idstring

Correlates with server logs and traces

statusinteger (int64)required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

URI identifying the problem type

500Internal Server Errorapplication/problem+json

codestringrequired

Stable machine-readable error code

detailstring

Human-readable explanation

errorsarray of object

Field-level validation errors

request_idstring

Correlates with server logs and traces

statusinteger (int64)required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

URI identifying the problem type

Was this page useful?

v0.5

Request

curl -X GET "https://api.example.com/ops/system" \
  -H "Authorization: Bearer $TOKEN"

req, _ := http.NewRequest("GET", "https://api.example.com/ops/system", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, err := http.DefaultClient.Do(req)
if err != nil {
	return err
}
defer resp.Body.Close()

const res = await fetch("https://api.example.com/ops/system", {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});
const data = await res.json();

Response

{
  "checks": [
    {
      "duration_ms": 1,
      "name": "postgres",
      "status": "ok"
    }
  ],
  "database": {
    "error": "string",
    "migrations": {
      "current": 1,
      "latest": 1,
      "pending": 1
    },
    "ping_ms": 1,
    "pool": {
      "acquires": 1,
      "average_acquire_ms": 1,
      "canceled_acquires": 1,
      "empty_acquires": 1,
      "idle": 1,
      "in_use": 1,
      "max": 1,
      "total": 1
    },
    "status": "ok"
  },
  "instance": {
    "build_time": "string",
    "commit": "3f9a1c2b7d4e8a90",
    "id": "string",
    "modified": true,
    "started_at": "2026-09-15T12:00:00Z",
    "uptime_seconds": 1,
    "version": "v1.4.0"
  },
  "jobs": {
    "queues": [
      "string"
    ],
    "workers": 1
  },
  "runtime": {
    "gcs": 0,
    "go_version": "go1.26.1",
    "gomaxprocs": 1,
    "goroutines": 1,
    "heap_in_use_bytes": 0,
    "last_gc_pause_ms": 1
  }
}

{
  "code": "project_name_taken",
  "detail": "project name is already taken",
  "errors": [
    {
      "location": "body.name",
      "message": "expected length >= 1"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "status": 409,
  "title": "Conflict",
  "type": "string"
}

{
  "code": "project_name_taken",
  "detail": "project name is already taken",
  "errors": [
    {
      "location": "body.name",
      "message": "expected length >= 1"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "status": 409,
  "title": "Conflict",
  "type": "string"
}

{
  "code": "project_name_taken",
  "detail": "project name is already taken",
  "errors": [
    {
      "location": "body.name",
      "message": "expected length >= 1"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "status": 409,
  "title": "Conflict",
  "type": "string"
}

Base URL: https://api.example.com
Auth: bearer