Skip to content
RSXDocs
RSX · API · Reference

status v1

Public operational state for RSX services: current status, uptime, incidents, and scheduled maintenance.

openapi.json
Current
Base URL
https://api.rsx.group/status/v1
Self-grantable scopes
None. Every endpoint here needs a key issued by a platform admin.
Machine readable
openapi.json
01

admin

11 operations under /status/v1/admin.

GET/status/v1/admin/services/list

The service catalogue, including services taken off the page

Scope
status:admin:services:list Admin-issued keys only.

Query parameters

Query parameters of adminListStatusServices

  • includeDisabled
    Type
    boolean, or null
    Description
    default true

Response 200The catalogue in display order

Response of adminListStatusServices

  • datarequired
    Type
    array of StatusAdminService
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • hostnamerequired
    Type
    string, or null
    Description
  • grouprequired
    Type
    string, or null
    Description
  • displayOrderrequired
    Type
    integer
    Description
  • enabledrequired
    Type
    boolean
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description

Example

curl
curl "https://api.rsx.group/status/v1/admin/services/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "slug": "api",
      "name": "string",
      "description": "string",
      "hostname": "string",
      "group": "string",
      "displayOrder": 1,
      "enabled": true,
      "createdAt": "2026-09-01T21:43:00.000Z",
      "updatedAt": "2026-09-01T21:43:00.000Z"
    }
  ]
}
POST/status/v1/admin/services/add

Put a service on the status page

Scope
status:admin:services:add Admin-issued keys only.
Idempotency
Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

Request body of adminAddStatusService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
    1 to 120 characters
  • description
    Type
    string, or null
    Description
    up to 280 characters
  • hostname
    Type
    string, or null
    Description
    up to 253 characters
  • group
    Type
    string, or null
    Description
    up to 64 characters
  • displayOrder
    Type
    integer
    Description
    0 to 10000 · default 0
  • enabled
    Type
    boolean
    Description
    default true

Response 200The service as stored

Response of adminAddStatusService

  • datarequired
    Type
    StatusAdminService
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • hostnamerequired
    Type
    string, or null
    Description
  • grouprequired
    Type
    string, or null
    Description
  • displayOrderrequired
    Type
    integer
    Description
  • enabledrequired
    Type
    boolean
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/services/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "api",
  "name": "API",
  "description": "string",
  "hostname": "api.rsx.group",
  "group": "Platform",
  "displayOrder": 0,
  "enabled": true
}'
200 response
{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "slug": "api",
    "name": "string",
    "description": "string",
    "hostname": "string",
    "group": "string",
    "displayOrder": 1,
    "enabled": true,
    "createdAt": "2026-09-01T21:43:00.000Z",
    "updatedAt": "2026-09-01T21:43:00.000Z"
  }
}
POST/status/v1/admin/services/update

Amend a service on the status page

Scope
status:admin:services:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateStatusService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • name
    Type
    string
    Description
    1 to 120 characters
  • description
    Type
    string, or null
    Description
    up to 280 characters
  • hostname
    Type
    string, or null
    Description
    up to 253 characters
  • group
    Type
    string, or null
    Description
    up to 64 characters
  • displayOrder
    Type
    integer
    Description
    0 to 10000
  • enabled
    Type
    boolean
    Description

Response 200The service as stored

Response of adminUpdateStatusService

  • datarequired
    Type
    StatusAdminService
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • hostnamerequired
    Type
    string, or null
    Description
  • grouprequired
    Type
    string, or null
    Description
  • displayOrderrequired
    Type
    integer
    Description
  • enabledrequired
    Type
    boolean
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/services/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "api",
  "name": "string",
  "description": "string",
  "hostname": "string",
  "group": "string",
  "displayOrder": 1,
  "enabled": true
}'
200 response
{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "slug": "api",
    "name": "string",
    "description": "string",
    "hostname": "string",
    "group": "string",
    "displayOrder": 1,
    "enabled": true,
    "createdAt": "2026-09-01T21:43:00.000Z",
    "updatedAt": "2026-09-01T21:43:00.000Z"
  }
}
POST/status/v1/admin/services/remove

Take a service off the status page, or purge it entirely

Scope
status:admin:services:remove Admin-issued keys only.

Request bodyapplication/json

Request body of adminRemoveStatusService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • purge
    Type
    boolean
    Description
    default false

Response 200What happened to the service

Response of adminRemoveStatusService

  • datarequired
    Type
    object
    Description
  • slugrequired
    Type
    string
    Description
  • purgedrequired
    Type
    boolean
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/services/remove \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "api",
  "purge": false
}'
200 response
{
  "data": {
    "slug": "string",
    "purged": false
  }
}
POST/status/v1/admin/incidents/add

Publish an incident

Scope
status:admin:incidents:add Admin-issued keys only.
Idempotency
Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

Request body of adminAddStatusIncident

  • titlerequired
    Type
    string
    Description
    1 to 160 characters
  • severityrequired
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • status
    Type
    object
    Description
  • startedAt
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of string
    Description
    at least 1 item
  • bodyrequired
    Type
    string
    Description
    1 to 4000 characters

Response 200The published incident, with its opening timeline entry written

Response of adminAddStatusIncident

  • datarequired
    Type
    StatusIncident
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • severityrequired
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • startedAtrequired
    Type
    string, date-time
    Description
  • resolvedAtrequired
    Type
    string, date-time, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/incidents/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "severity": "partial-outage",
  "status": {},
  "startedAt": "2026-09-01T21:43:00.000Z",
  "services": [
    "api"
  ],
  "body": "string"
}'
200 response
{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "title": "Elevated API response times",
    "status": "investigating",
    "severity": "partial-outage",
    "startedAt": "2026-09-01T21:43:00.000Z",
    "resolvedAt": "2026-09-01T21:43:00.000Z",
    "createdAt": "2026-09-01T21:43:00.000Z",
    "updatedAt": "2026-09-01T21:43:00.000Z",
    "services": [
      {
        "slug": "api",
        "name": "API"
      }
    ]
  }
}
POST/status/v1/admin/incidents/update

Amend or resolve an incident

Scope
status:admin:incidents:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateStatusIncident

  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • title
    Type
    string
    Description
    1 to 160 characters
  • severity
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • status
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • services
    Type
    array of string
    Description
    at least 1 item
  • startedAt
    Type
    string, date-time
    Description
  • resolvedAt
    Type
    string, date-time, or null
    Description

Response 200The amended incident

Response of adminUpdateStatusIncident

  • datarequired
    Type
    StatusIncident
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • severityrequired
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • startedAtrequired
    Type
    string, date-time
    Description
  • resolvedAtrequired
    Type
    string, date-time, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/incidents/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
  "title": "string",
  "severity": "partial-outage",
  "status": "investigating",
  "services": [
    "api"
  ],
  "startedAt": "2026-09-01T21:43:00.000Z",
  "resolvedAt": "2026-09-01T21:43:00.000Z"
}'
200 response
{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "title": "Elevated API response times",
    "status": "investigating",
    "severity": "partial-outage",
    "startedAt": "2026-09-01T21:43:00.000Z",
    "resolvedAt": "2026-09-01T21:43:00.000Z",
    "createdAt": "2026-09-01T21:43:00.000Z",
    "updatedAt": "2026-09-01T21:43:00.000Z",
    "services": [
      {
        "slug": "api",
        "name": "API"
      }
    ]
  }
}
POST/status/v1/admin/incident-updates/add

Append an entry to an incident's timeline

Scope
status:admin:incident-updates:add Admin-issued keys only.
Idempotency
Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

Request body of adminAddStatusIncidentUpdate

  • incidentIdrequired
    Type
    string
    Description
    1 to 64 characters
  • status
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • bodyrequired
    Type
    string
    Description
    1 to 4000 characters

Response 200The timeline entry, and the incident status it moved to

Response of adminAddStatusIncidentUpdate

  • datarequired
    Type
    StatusIncidentUpdate
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • incidentIdrequired
    Type
    string
    Description
    1 to 64 characters
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • bodyrequired
    Type
    string
    Description
  • createdAtrequired
    Type
    string, date-time
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/incident-updates/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "incidentId": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
  "status": "investigating",
  "body": "string"
}'
200 response
{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "incidentId": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "status": "investigating",
    "body": "We are investigating elevated API response times.",
    "createdAt": "2026-09-01T21:43:00.000Z"
  }
}
POST/status/v1/admin/maintenance/add

Schedule a maintenance window

Scope
status:admin:maintenance:add Admin-issued keys only.
Idempotency
Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

Request body of adminAddStatusMaintenance

  • titlerequired
    Type
    string
    Description
    1 to 160 characters
  • description
    Type
    string, or null
    Description
    up to 4000 characters
  • startsAtrequired
    Type
    string, date-time
    Description
  • endsAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of string
    Description
    at least 1 item

Response 200The scheduled window

Response of adminAddStatusMaintenance

  • datarequired
    Type
    StatusMaintenance
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • startsAtrequired
    Type
    string, date-time
    Description
  • endsAtrequired
    Type
    string, date-time
    Description
  • statusrequired
    Type
    StatusMaintenanceStatus
    Description
    one of "scheduled", "active", "completed", "cancelled"
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/maintenance/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string",
  "description": "string",
  "startsAt": "2026-09-01T21:43:00.000Z",
  "endsAt": "2026-09-01T21:43:00.000Z",
  "services": [
    "api"
  ]
}'
200 response
{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "title": "Database maintenance",
    "description": "Storage upgrade for the key store.",
    "startsAt": "2026-09-01T21:43:00.000Z",
    "endsAt": "2026-09-01T21:43:00.000Z",
    "status": "scheduled",
    "createdAt": "2026-09-01T21:43:00.000Z",
    "updatedAt": "2026-09-01T21:43:00.000Z",
    "services": [
      {
        "slug": "api",
        "name": "API"
      }
    ]
  }
}
POST/status/v1/admin/maintenance/update

Amend, complete or cancel a maintenance window

Scope
status:admin:maintenance:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateStatusMaintenance

  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • title
    Type
    string
    Description
    1 to 160 characters
  • description
    Type
    string, or null
    Description
    up to 4000 characters
  • startsAt
    Type
    string, date-time
    Description
  • endsAt
    Type
    string, date-time
    Description
  • status
    Type
    StatusMaintenanceDisposition
    Description
    one of "scheduled", "completed", "cancelled"
  • services
    Type
    array of string
    Description
    at least 1 item

Response 200The amended window

Response of adminUpdateStatusMaintenance

  • datarequired
    Type
    StatusMaintenance
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • startsAtrequired
    Type
    string, date-time
    Description
  • endsAtrequired
    Type
    string, date-time
    Description
  • statusrequired
    Type
    StatusMaintenanceStatus
    Description
    one of "scheduled", "active", "completed", "cancelled"
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/maintenance/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
  "title": "string",
  "description": "string",
  "startsAt": "2026-09-01T21:43:00.000Z",
  "endsAt": "2026-09-01T21:43:00.000Z",
  "status": "scheduled",
  "services": [
    "api"
  ]
}'
200 response
{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "title": "Database maintenance",
    "description": "Storage upgrade for the key store.",
    "startsAt": "2026-09-01T21:43:00.000Z",
    "endsAt": "2026-09-01T21:43:00.000Z",
    "status": "scheduled",
    "createdAt": "2026-09-01T21:43:00.000Z",
    "updatedAt": "2026-09-01T21:43:00.000Z",
    "services": [
      {
        "slug": "api",
        "name": "API"
      }
    ]
  }
}
POST/status/v1/admin/measurements/record

Append a probe run

Scope
status:admin:measurements:record Admin-issued keys only.

Request bodyapplication/json

Request body of adminRecordStatusMeasurements

  • sourcerequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • measurementsrequired
    Type
    array of StatusMeasurement
    Description
    1 to 200 items
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • statusrequired
    Type
    StatusMeasurementStatus
    Description
    one of "operational", "degraded", "down"
  • responseTimeMs
    Type
    integer, or null
    Description
    0 to 600000
  • observedAtrequired
    Type
    string, date-time
    Description

Response 200How many measurements were stored, and which slugs were not recognised

Response of adminRecordStatusMeasurements

  • datarequired
    Type
    object
    Description
  • recordedrequired
    Type
    integer
    Description
  • unknownrequired
    Type
    array of string
    Description

Example

curl
curl -X POST https://api.rsx.group/status/v1/admin/measurements/record \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "source": "dashboard-cron",
  "measurements": [
    {
      "slug": "api",
      "status": "operational",
      "responseTimeMs": 1,
      "observedAt": "2026-09-01T21:43:00.000Z"
    }
  ]
}'
200 response
{
  "data": {
    "recorded": 8,
    "unknown": []
  }
}
GET/status/v1/admin/audit/list

Who changed the status page, and what they changed

Every operator write, newest first: services put on and taken off the page, incidents opened, changed and posted to, maintenance scheduled and changed. The probe's measurements are not in it.

Scope
status:admin:audit:list Admin-issued keys only.

Query parameters

Query parameters of adminListStatusAudit

  • targetType
    Type
    string
    Description
    one of "service", "incident", "maintenance"
  • targetId
    Type
    string
    Description
    up to 128 characters
  • actor
    Type
    string
    Description
    up to 320 characters
  • action
    Type
    string
    Description
    one of "service.added", "service.updated", "service.removed", "service.purged", "incident.opened", "incident.updated", "incident.update-posted", "maintenance.scheduled", "maintenance.updated"
  • offset
    Type
    integer, or null
    Description
    at least 0 · default 0
  • limit
    Type
    integer
    Description
    1 to 100 · default 50

Response 200Audit events

Response of adminListStatusAudit

  • datarequired
    Type
    array of StatusAuditEvent
    Description
  • idrequired
    Type
    string
    Description
  • actorrequired
    Type
    string
    Description
  • actionrequired
    Type
    string
    Description
    one of "service.added", "service.updated", "service.removed", "service.purged", "incident.opened", "incident.updated", "incident.update-posted", "maintenance.scheduled", "maintenance.updated"
  • targetTyperequired
    Type
    string
    Description
    one of "service", "incident", "maintenance"
  • targetIdrequired
    Type
    string
    Description
  • targetLabelrequired
    Type
    string, or null
    Description
  • atrequired
    Type
    string, date-time
    Description
  • detailrequired
    Type
    string, or null
    Description
  • metarequired
    Type
    object
    Description
  • offsetrequired
    Type
    integer
    Description
  • limitrequired
    Type
    integer
    Description
  • morerequired
    Type
    boolean
    Description

Example

curl
curl "https://api.rsx.group/status/v1/admin/audit/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d12",
      "actor": "ops@rsx.group",
      "action": "service.added",
      "targetType": "service",
      "targetId": "string",
      "targetLabel": "string",
      "at": "2026-09-12T10:16:30.000Z",
      "detail": "string"
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "more": true
  }
}
02

services

2 operations under /status/v1/services.

GET/status/v1/services/list

Current state of every service on the status page

Scope
status:services:list Admin-issued keys only.

Query parameters

Query parameters of listStatusServices

  • group
    Type
    string
    Description
    up to 64 characters

Response 200The overview: aggregate state, freshness, and every displayed service

Response of listStatusServices

  • datarequired
    Type
    StatusServiceList
    Description
  • overallrequired
    Type
    StatusOverallState
    Description
    Aggregate state across every displayed service. unavailable means the status data itself is missing or stale.one of "operational", "maintenance", "unavailable", "degraded", "partial-outage", "major-outage"
  • checkedAtrequired
    Type
    string, date-time, or null
    Description
  • stalerequired
    Type
    boolean
    Description
  • freshnessSecondsrequired
    Type
    integer
    Description
  • servicesrequired
    Type
    array of StatusService
    Description

Example

curl
curl "https://api.rsx.group/status/v1/services/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "overall": "operational",
    "checkedAt": "2026-09-01T21:43:00.000Z",
    "stale": false,
    "freshnessSeconds": 2700,
    "services": [
      {
        "slug": "api",
        "name": "API",
        "description": "The public API gateway.",
        "hostname": "api.rsx.group",
        "group": "Platform",
        "displayOrder": 10,
        "state": "operational",
        "observedAt": "2026-09-01T21:43:00.000Z",
        "responseTimeMs": 41,
        "stale": false,
        "activeIncidentIds": [],
        "activeMaintenanceIds": []
      }
    ]
  }
}
GET/status/v1/services/get

One service, with its uptime, incidents and maintenance

Scope
status:services:get Admin-issued keys only.

Query parameters

Query parameters of getStatusService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$

Response 200Everything the service detail page renders

Response of getStatusService

Example

curl
curl "https://api.rsx.group/status/v1/services/get?slug=api" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "service": {
      "slug": "api",
      "name": "API",
      "description": "The public API gateway.",
      "hostname": "api.rsx.group",
      "group": "Platform",
      "displayOrder": 10,
      "state": "operational",
      "observedAt": "2026-09-01T21:43:00.000Z",
      "responseTimeMs": 41,
      "stale": false,
      "activeIncidentIds": [],
      "activeMaintenanceIds": []
    },
    "uptime": [
      {
        "slug": "api",
        "period": "30d",
        "from": "2026-09-01T21:43:00.000Z",
        "to": "2026-09-01T21:43:00.000Z",
        "uptimePct": 99.98,
        "samples": 2880,
        "intervalSeconds": 900,
        "avgResponseTimeMs": 44
      }
    ],
    "incidents": [
      {
        "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
        "title": "Elevated API response times",
        "status": "investigating",
        "severity": "partial-outage",
        "startedAt": "2026-09-01T21:43:00.000Z",
        "resolvedAt": "2026-09-01T21:43:00.000Z",
        "createdAt": "2026-09-01T21:43:00.000Z",
        "updatedAt": "2026-09-01T21:43:00.000Z",
        "services": [
          {
            "slug": null,
            "name": null
          }
        ]
      }
    ],
    "maintenance": [
      {
        "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
        "title": "Database maintenance",
        "description": "Storage upgrade for the key store.",
        "startsAt": "2026-09-01T21:43:00.000Z",
        "endsAt": "2026-09-01T21:43:00.000Z",
        "status": "scheduled",
        "createdAt": "2026-09-01T21:43:00.000Z",
        "updatedAt": "2026-09-01T21:43:00.000Z",
        "services": [
          {
            "slug": null,
            "name": null
          }
        ]
      }
    ]
  }
}
03

uptime

1 operation under /status/v1/uptime.

GET/status/v1/uptime/get

Uptime for one service over one period

Scope
status:uptime:get Admin-issued keys only.

Query parameters

Query parameters of getStatusUptime

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • period
    Type
    object
    Description

Response 200Uptime, with the window and sample count it was computed from

Response of getStatusUptime

  • datarequired
    Type
    StatusUptimeSummary
    Description
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • periodrequired
    Type
    StatusUptimePeriod
    Description
    one of "24h", "7d", "30d", "90d"
  • fromrequired
    Type
    string, date-time
    Description
  • torequired
    Type
    string, date-time
    Description
  • uptimePctrequired
    Type
    number, or null
    Description
  • samplesrequired
    Type
    integer
    Description
  • intervalSecondsrequired
    Type
    integer
    Description
  • avgResponseTimeMsrequired
    Type
    integer, or null
    Description

Example

curl
curl "https://api.rsx.group/status/v1/uptime/get?slug=api" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "slug": "api",
    "period": "30d",
    "from": "2026-09-01T21:43:00.000Z",
    "to": "2026-09-01T21:43:00.000Z",
    "uptimePct": 99.98,
    "samples": 2880,
    "intervalSeconds": 900,
    "avgResponseTimeMs": 44
  }
}
04

incidents

2 operations under /status/v1/incidents.

GET/status/v1/incidents/list

Incidents, newest first

Scope
status:incidents:list Admin-issued keys only.

Query parameters

Query parameters of listStatusIncidents

  • status
    Type
    string
    Description
    one of "active", "resolved"
  • slug
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • from
    Type
    string, date-time
    Description
  • to
    Type
    string, date-time
    Description
  • cursor
    Type
    string
    Description
  • limit
    Type
    integer
    Description
    1 to 100 · default 20

Response 200Incidents, newest first

Response of listStatusIncidents

  • datarequired
    Type
    array of StatusIncident
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • severityrequired
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • startedAtrequired
    Type
    string, date-time
    Description
  • resolvedAtrequired
    Type
    string, date-time, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description
  • metarequired
    Type
    object
    Description
  • cursorrequired
    Type
    string, or null
    Description

Example

curl
curl "https://api.rsx.group/status/v1/incidents/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "title": "Elevated API response times",
      "status": "investigating",
      "severity": "partial-outage",
      "startedAt": "2026-09-01T21:43:00.000Z",
      "resolvedAt": "2026-09-01T21:43:00.000Z",
      "createdAt": "2026-09-01T21:43:00.000Z",
      "updatedAt": "2026-09-01T21:43:00.000Z",
      "services": [
        {
          "slug": "api",
          "name": "API"
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET/status/v1/incidents/get

One incident and its timeline

Scope
status:incidents:get Admin-issued keys only.

Query parameters

Query parameters of getStatusIncident

  • idrequired
    Type
    string
    Description
    1 to 64 characters

Response 200The incident, its affected services, and its ordered timeline

Response of getStatusIncident

Example

curl
curl "https://api.rsx.group/status/v1/incidents/get?id=0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "incident": {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "title": "Elevated API response times",
      "status": "investigating",
      "severity": "partial-outage",
      "startedAt": "2026-09-01T21:43:00.000Z",
      "resolvedAt": "2026-09-01T21:43:00.000Z",
      "createdAt": "2026-09-01T21:43:00.000Z",
      "updatedAt": "2026-09-01T21:43:00.000Z",
      "services": [
        {
          "slug": "api",
          "name": "API"
        }
      ]
    },
    "updates": [
      {
        "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
        "incidentId": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
        "status": "investigating",
        "body": "We are investigating elevated API response times.",
        "createdAt": "2026-09-01T21:43:00.000Z"
      }
    ]
  }
}
05

maintenance

2 operations under /status/v1/maintenance.

GET/status/v1/maintenance/list

Maintenance windows, newest first

Scope
status:maintenance:list Admin-issued keys only.

Query parameters

Query parameters of listStatusMaintenance

  • status
    Type
    StatusMaintenanceStatus
    Description
    one of "scheduled", "active", "completed", "cancelled"
  • slug
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • from
    Type
    string, date-time
    Description
  • to
    Type
    string, date-time
    Description
  • cursor
    Type
    string
    Description
  • limit
    Type
    integer
    Description
    1 to 100 · default 20

Response 200Maintenance windows, newest first

Response of listStatusMaintenance

  • datarequired
    Type
    array of StatusMaintenance
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • startsAtrequired
    Type
    string, date-time
    Description
  • endsAtrequired
    Type
    string, date-time
    Description
  • statusrequired
    Type
    StatusMaintenanceStatus
    Description
    one of "scheduled", "active", "completed", "cancelled"
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description
  • metarequired
    Type
    object
    Description
  • cursorrequired
    Type
    string, or null
    Description

Example

curl
curl "https://api.rsx.group/status/v1/maintenance/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "title": "Database maintenance",
      "description": "Storage upgrade for the key store.",
      "startsAt": "2026-09-01T21:43:00.000Z",
      "endsAt": "2026-09-01T21:43:00.000Z",
      "status": "scheduled",
      "createdAt": "2026-09-01T21:43:00.000Z",
      "updatedAt": "2026-09-01T21:43:00.000Z",
      "services": [
        {
          "slug": "api",
          "name": "API"
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET/status/v1/maintenance/get

One maintenance window and its affected services

Scope
status:maintenance:get Admin-issued keys only.

Query parameters

Query parameters of getStatusMaintenance

  • idrequired
    Type
    string
    Description
    1 to 64 characters

Response 200The maintenance window

Response of getStatusMaintenance

  • datarequired
    Type
    StatusMaintenance
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • startsAtrequired
    Type
    string, date-time
    Description
  • endsAtrequired
    Type
    string, date-time
    Description
  • statusrequired
    Type
    StatusMaintenanceStatus
    Description
    one of "scheduled", "active", "completed", "cancelled"
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description

Example

curl
curl "https://api.rsx.group/status/v1/maintenance/get?id=0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "title": "Database maintenance",
    "description": "Storage upgrade for the key store.",
    "startsAt": "2026-09-01T21:43:00.000Z",
    "endsAt": "2026-09-01T21:43:00.000Z",
    "status": "scheduled",
    "createdAt": "2026-09-01T21:43:00.000Z",
    "updatedAt": "2026-09-01T21:43:00.000Z",
    "services": [
      {
        "slug": "api",
        "name": "API"
      }
    ]
  }
}
06

Schemas

Every named shape in this reference, as the operations above refer to it.

StatusAdminService

StatusAdminService

  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • hostnamerequired
    Type
    string, or null
    Description
  • grouprequired
    Type
    string, or null
    Description
  • displayOrderrequired
    Type
    integer
    Description
  • enabledrequired
    Type
    boolean
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description

StatusAddService

StatusAddService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
    1 to 120 characters
  • description
    Type
    string, or null
    Description
    up to 280 characters
  • hostname
    Type
    string, or null
    Description
    up to 253 characters
  • group
    Type
    string, or null
    Description
    up to 64 characters
  • displayOrder
    Type
    integer
    Description
    0 to 10000 · default 0
  • enabled
    Type
    boolean
    Description
    default true

StatusUpdateService

StatusUpdateService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • name
    Type
    string
    Description
    1 to 120 characters
  • description
    Type
    string, or null
    Description
    up to 280 characters
  • hostname
    Type
    string, or null
    Description
    up to 253 characters
  • group
    Type
    string, or null
    Description
    up to 64 characters
  • displayOrder
    Type
    integer
    Description
    0 to 10000
  • enabled
    Type
    boolean
    Description

StatusRemoveService

StatusRemoveService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • purge
    Type
    boolean
    Description
    default false

StatusIncidentSeverity

Operational severity, expressed as the state the incident imposes on every service it affects.

string. Operational severity, expressed as the state the incident imposes on every service it affects.

StatusAffectedService

StatusAffectedService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description

StatusIncident

StatusIncident

  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • severityrequired
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • startedAtrequired
    Type
    string, date-time
    Description
  • resolvedAtrequired
    Type
    string, date-time, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description

StatusAddIncident

StatusAddIncident

  • titlerequired
    Type
    string
    Description
    1 to 160 characters
  • severityrequired
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • status
    Type
    object
    Description
  • startedAt
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of string
    Description
    at least 1 item
  • bodyrequired
    Type
    string
    Description
    1 to 4000 characters

StatusUpdateIncident

StatusUpdateIncident

  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • title
    Type
    string
    Description
    1 to 160 characters
  • severity
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • status
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • services
    Type
    array of string
    Description
    at least 1 item
  • startedAt
    Type
    string, date-time
    Description
  • resolvedAt
    Type
    string, date-time, or null
    Description

StatusIncidentUpdate

StatusIncidentUpdate

  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • incidentIdrequired
    Type
    string
    Description
    1 to 64 characters
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • bodyrequired
    Type
    string
    Description
  • createdAtrequired
    Type
    string, date-time
    Description

StatusAddIncidentUpdate

StatusAddIncidentUpdate

  • incidentIdrequired
    Type
    string
    Description
    1 to 64 characters
  • status
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • bodyrequired
    Type
    string
    Description
    1 to 4000 characters

StatusMaintenance

StatusMaintenance

  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • startsAtrequired
    Type
    string, date-time
    Description
  • endsAtrequired
    Type
    string, date-time
    Description
  • statusrequired
    Type
    StatusMaintenanceStatus
    Description
    one of "scheduled", "active", "completed", "cancelled"
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description

StatusAddMaintenance

StatusAddMaintenance

  • titlerequired
    Type
    string
    Description
    1 to 160 characters
  • description
    Type
    string, or null
    Description
    up to 4000 characters
  • startsAtrequired
    Type
    string, date-time
    Description
  • endsAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of string
    Description
    at least 1 item

StatusUpdateMaintenance

StatusUpdateMaintenance

  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • title
    Type
    string
    Description
    1 to 160 characters
  • description
    Type
    string, or null
    Description
    up to 4000 characters
  • startsAt
    Type
    string, date-time
    Description
  • endsAt
    Type
    string, date-time
    Description
  • status
    Type
    StatusMaintenanceDisposition
    Description
    one of "scheduled", "completed", "cancelled"
  • services
    Type
    array of string
    Description
    at least 1 item

StatusMeasurement

StatusMeasurement

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • statusrequired
    Type
    StatusMeasurementStatus
    Description
    one of "operational", "degraded", "down"
  • responseTimeMs
    Type
    integer, or null
    Description
    0 to 600000
  • observedAtrequired
    Type
    string, date-time
    Description

StatusRecordMeasurements

StatusRecordMeasurements

  • sourcerequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • measurementsrequired
    Type
    array of StatusMeasurement
    Description
    1 to 200 items
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • statusrequired
    Type
    StatusMeasurementStatus
    Description
    one of "operational", "degraded", "down"
  • responseTimeMs
    Type
    integer, or null
    Description
    0 to 600000
  • observedAtrequired
    Type
    string, date-time
    Description

StatusAuditEvent

StatusAuditEvent

  • idrequired
    Type
    string
    Description
  • actorrequired
    Type
    string
    Description
  • actionrequired
    Type
    string
    Description
    one of "service.added", "service.updated", "service.removed", "service.purged", "incident.opened", "incident.updated", "incident.update-posted", "maintenance.scheduled", "maintenance.updated"
  • targetTyperequired
    Type
    string
    Description
    one of "service", "incident", "maintenance"
  • targetIdrequired
    Type
    string
    Description
  • targetLabelrequired
    Type
    string, or null
    Description
  • atrequired
    Type
    string, date-time
    Description
  • detailrequired
    Type
    string, or null
    Description

StatusOverallState

Aggregate state across every displayed service. unavailable means the status data itself is missing or stale.

string. Aggregate state across every displayed service. `unavailable` means the status data itself is missing or stale.

StatusServiceState

Current operational state of one service. unknown means there is no fresh measurement, which is never reported as operational.

string. Current operational state of one service. `unknown` means there is no fresh measurement, which is never reported as operational.

StatusService

StatusService

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • hostnamerequired
    Type
    string, or null
    Description
  • grouprequired
    Type
    string, or null
    Description
  • displayOrderrequired
    Type
    integer
    Description
  • staterequired
    Type
    StatusServiceState
    Description
    Current operational state of one service. unknown means there is no fresh measurement, which is never reported as operational.one of "operational", "maintenance", "unknown", "degraded", "partial-outage", "major-outage"
  • observedAtrequired
    Type
    string, date-time, or null
    Description
  • responseTimeMsrequired
    Type
    integer, or null
    Description
  • stalerequired
    Type
    boolean
    Description
  • activeIncidentIdsrequired
    Type
    array of string
    Description
  • activeMaintenanceIdsrequired
    Type
    array of string
    Description

StatusServiceList

StatusServiceList

  • overallrequired
    Type
    StatusOverallState
    Description
    Aggregate state across every displayed service. unavailable means the status data itself is missing or stale.one of "operational", "maintenance", "unavailable", "degraded", "partial-outage", "major-outage"
  • checkedAtrequired
    Type
    string, date-time, or null
    Description
  • stalerequired
    Type
    boolean
    Description
  • freshnessSecondsrequired
    Type
    integer
    Description
  • servicesrequired
    Type
    array of StatusService
    Description
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • hostnamerequired
    Type
    string, or null
    Description
  • grouprequired
    Type
    string, or null
    Description
  • displayOrderrequired
    Type
    integer
    Description
  • staterequired
    Type
    StatusServiceState
    Description
    Current operational state of one service. unknown means there is no fresh measurement, which is never reported as operational.one of "operational", "maintenance", "unknown", "degraded", "partial-outage", "major-outage"
  • observedAtrequired
    Type
    string, date-time, or null
    Description
  • responseTimeMsrequired
    Type
    integer, or null
    Description
  • stalerequired
    Type
    boolean
    Description
  • activeIncidentIdsrequired
    Type
    array of string
    Description
  • activeMaintenanceIdsrequired
    Type
    array of string
    Description

StatusUptimeSummary

StatusUptimeSummary

  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • periodrequired
    Type
    StatusUptimePeriod
    Description
    one of "24h", "7d", "30d", "90d"
  • fromrequired
    Type
    string, date-time
    Description
  • torequired
    Type
    string, date-time
    Description
  • uptimePctrequired
    Type
    number, or null
    Description
  • samplesrequired
    Type
    integer
    Description
  • intervalSecondsrequired
    Type
    integer
    Description
  • avgResponseTimeMsrequired
    Type
    integer, or null
    Description

StatusServiceDetail

StatusServiceDetail

  • servicerequired
    Type
    StatusService
    Description
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • namerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • hostnamerequired
    Type
    string, or null
    Description
  • grouprequired
    Type
    string, or null
    Description
  • displayOrderrequired
    Type
    integer
    Description
  • staterequired
    Type
    StatusServiceState
    Description
    Current operational state of one service. unknown means there is no fresh measurement, which is never reported as operational.one of "operational", "maintenance", "unknown", "degraded", "partial-outage", "major-outage"
  • observedAtrequired
    Type
    string, date-time, or null
    Description
  • responseTimeMsrequired
    Type
    integer, or null
    Description
  • stalerequired
    Type
    boolean
    Description
  • activeIncidentIdsrequired
    Type
    array of string
    Description
  • activeMaintenanceIdsrequired
    Type
    array of string
    Description
  • uptimerequired
    Type
    array of StatusUptimeSummary
    Description
  • slugrequired
    Type
    string
    Description
    1 to 64 characters · matches ^[a-z][a-z0-9-]*$
  • periodrequired
    Type
    StatusUptimePeriod
    Description
    one of "24h", "7d", "30d", "90d"
  • fromrequired
    Type
    string, date-time
    Description
  • torequired
    Type
    string, date-time
    Description
  • uptimePctrequired
    Type
    number, or null
    Description
  • samplesrequired
    Type
    integer
    Description
  • intervalSecondsrequired
    Type
    integer
    Description
  • avgResponseTimeMsrequired
    Type
    integer, or null
    Description
  • incidentsrequired
    Type
    array of StatusIncident
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • severityrequired
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • startedAtrequired
    Type
    string, date-time
    Description
  • resolvedAtrequired
    Type
    string, date-time, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description
  • maintenancerequired
    Type
    array of StatusMaintenance
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • descriptionrequired
    Type
    string, or null
    Description
  • startsAtrequired
    Type
    string, date-time
    Description
  • endsAtrequired
    Type
    string, date-time
    Description
  • statusrequired
    Type
    StatusMaintenanceStatus
    Description
    one of "scheduled", "active", "completed", "cancelled"
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description

StatusIncidentDetail

StatusIncidentDetail

  • incidentrequired
    Type
    StatusIncident
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • titlerequired
    Type
    string
    Description
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • severityrequired
    Type
    StatusIncidentSeverity
    Description
    Operational severity, expressed as the state the incident imposes on every service it affects.one of "degraded", "partial-outage", "major-outage"
  • startedAtrequired
    Type
    string, date-time
    Description
  • resolvedAtrequired
    Type
    string, date-time, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • servicesrequired
    Type
    array of StatusAffectedService
    Description
  • updatesrequired
    Type
    array of StatusIncidentUpdate
    Description
  • idrequired
    Type
    string
    Description
    1 to 64 characters
  • incidentIdrequired
    Type
    string
    Description
    1 to 64 characters
  • statusrequired
    Type
    StatusIncidentStatus
    Description
    one of "investigating", "identified", "monitoring", "resolved"
  • bodyrequired
    Type
    string
    Description
  • createdAtrequired
    Type
    string, date-time
    Description