API reference / Operations by tag

status

Status page components, incidents and maintenance windows.

21 operations. Base URL https://api.metrixed.com/v1; see authentication, errors and pagination.

Operations

GET /status/components

List status components

Operation getStatusComponents. Auth: API key (Bearer) or session cookie.

curl 'https://api.metrixed.com/v1/status/components' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

POST /status/components

Create a status component

Operation postStatusComponents. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): StatusDoc

curl -X POST 'https://api.metrixed.com/v1/status/components' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 201 response:

{}

PATCH /status/components/{id}

Update a status component

Operation patchStatusComponentsId. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): StatusDoc

curl -X PATCH 'https://api.metrixed.com/v1/status/components/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 200 response:

{}

DELETE /status/components/{id}

Delete a status component

Operation deleteStatusComponentsId. Auth: API key (Bearer) or session cookie.

curl -X DELETE 'https://api.metrixed.com/v1/status/components/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

{
  "ok": false
}

GET /status/health

Live System health: service readiness, consumer lag, postback outcomes, latest synthetic run

Operation getStatusHealth. Auth: API key (Bearer) or session cookie.

curl 'https://api.metrixed.com/v1/status/health' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

GET /status/incidents

List incidents (state=open|resolved)

Operation getStatusIncidents. Auth: API key (Bearer) or session cookie.

curl 'https://api.metrixed.com/v1/status/incidents' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

POST /status/incidents

Open an incident; affected components change status

Operation postStatusIncidents. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): StatusDoc

curl -X POST 'https://api.metrixed.com/v1/status/incidents' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 201 response:

{}

GET /status/incidents/{id}

Get an incident with its timeline

Operation getStatusIncidentsId. Auth: API key (Bearer) or session cookie.

curl 'https://api.metrixed.com/v1/status/incidents/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

POST /status/incidents/{id}/updates

Post an incident update (status investigating|identified|monitoring|resolved); subscribers are emailed

Operation postStatusIncidentsIdUpdates. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): StatusDoc

curl -X POST 'https://api.metrixed.com/v1/status/incidents/<id>/updates' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 201 response:

{}

GET /status/maintenance

List status maintenance windows List status maintenance windows. WP-71: paged with page/page_size (page.total over the whole match); unpaged returns the previous bound with total and capped/cap.

Operation getStatusMaintenance. Auth: API key (Bearer) or session cookie.

curl 'https://api.metrixed.com/v1/status/maintenance?page=1&page_size=50' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

POST /status/maintenance

Create a status maintenance window

Operation postStatusMaintenance. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): StatusDoc

curl -X POST 'https://api.metrixed.com/v1/status/maintenance' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 201 response:

{}

PATCH /status/maintenance/{id}

Update a status maintenance window

Operation patchStatusMaintenanceId. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): StatusDoc

curl -X PATCH 'https://api.metrixed.com/v1/status/maintenance/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 200 response:

{}

GET /status/public/{tenant}

Public: status page document (no auth, cacheable)

Operation getStatusPublicTenant. Auth: none (public endpoint).

curl 'https://api.metrixed.com/v1/status/public/<tenant>' \
  -H 'Accept: application/json'

Example 200 response:

{
  "ok": false
}

GET /status/public/{tenant}/confirm

Public: confirm a subscription

Operation getStatusPublicTenantConfirm. Auth: none (public endpoint).

curl 'https://api.metrixed.com/v1/status/public/<tenant>/confirm' \
  -H 'Accept: application/json'

Example 200 response:

{
  "ok": false
}

POST /status/public/{tenant}/subscribe

Public: subscribe an email to incident updates (double opt-in)

Operation postStatusPublicTenantSubscribe. Auth: none (public endpoint).

Request body (application/json, required): StatusDoc

curl -X POST 'https://api.metrixed.com/v1/status/public/<tenant>/subscribe' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 202 response:

{
  "ok": false
}

GET /status/public/{tenant}/unsubscribe

Public: unsubscribe

Operation getStatusPublicTenantUnsubscribe. Auth: none (public endpoint).

curl 'https://api.metrixed.com/v1/status/public/<tenant>/unsubscribe' \
  -H 'Accept: application/json'

Example 200 response:

{
  "ok": false
}

GET /status/settings

Status page settings (title, description, public flag)

Operation getStatusSettings. Auth: API key (Bearer) or session cookie.

curl 'https://api.metrixed.com/v1/status/settings' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

PUT /status/settings

Update status page settings

Operation putStatusSettings. Auth: API key (Bearer) or session cookie.

Request body (application/json, required): StatusDoc

curl -X PUT 'https://api.metrixed.com/v1/status/settings' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Example 200 response:

{}

GET /status/subscribers

List email subscribers List email subscribers. WP-67: paged; q matches the email; state confirmed|pending|unsubscribed; counts per state.

Operation getStatusSubscribers. Auth: API key (Bearer) or session cookie.

curl 'https://api.metrixed.com/v1/status/subscribers?page=1&page_size=50' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}

DELETE /status/subscribers/{id}

Remove a subscriber

Operation deleteStatusSubscribersId. Auth: API key (Bearer) or session cookie.

curl -X DELETE 'https://api.metrixed.com/v1/status/subscribers/<id>' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 204 response:

{
  "ok": false
}

GET /status/synthetic

Synthetic monitor results (recent + latest per region)

Operation getStatusSynthetic. Auth: API key (Bearer) or session cookie.

curl 'https://api.metrixed.com/v1/status/synthetic' \
  -H "Authorization: Bearer $DT_API_KEY" \
  -H 'Accept: application/json'

Example 200 response:

{}