StatusMate - Status Page

Knowledge Base

Use Statusmate API for integration

The Statusmate API provides a simple and reliable way to integrate with our service status monitoring and management system.

Authentication

To make requests to the Statusmate API, you need to include your API token in the

Authorization

header:

Authorization: <API_TOKEN>

Get your page API token

You can get your API key on the page settings under the Integrations section.

Errors

Example response for an error

(HTTP 400)

{
  "name": ["This field may not be blank."],
  "email": ["Enter a valid email address."],
  "address": {
    "city": ["This field may not be blank."],
    "postal_code": ["Invalid postal code format."]
  }
}

Create Component

Example request:

POST https://status.statusmate.top/api-components-create/
Authorization: {API_TOKEN}
Content-Type: application/json

{
  "index": 0,
  "name": "Web-сайт",
  "description": "",
  "parent": null,
  "histogram": false,
  "start_date": "2025-05-24T11:02:11.963141+03:00",
  "collapse": false,
  "enabled": true,
  "private": false,
  "impact": "operational"
}

Example response:

{
  "uuid": "946e31f4-1daa-4c36-8e6f-bfd6780ec581",
  "index": 0,
  "name": "Web-сайт",
  "description": "",
  "parent": null,
  "histogram": false,
  "start_date": "2025-05-24T11:02:11.963141+03:00",
  "collapse": false,
  "enabled": true,
  "private": false,
  "impact": "operational"
}

Update Component

Example request:

POST https://status.statusmate.top/api-components-update/{UUID}/
Authorization: {API_TOKEN}
Content-Type: application/json

{
  "uuid": "946e31f4-1daa-4c36-8e6f-bfd6780ec581",
  "index": 0,
  "name": "Web-сайт",
  "description": "",
  "parent": null,
  "histogram": false,
  "start_date": "2025-05-24T11:02:11.963141+03:00",
  "collapse": false,
  "enabled": true,
  "private": false,
  "impact": "operational"
}

Example response:

{
  "uuid": "946e31f4-1daa-4c36-8e6f-bfd6780ec581",
  "index": 0,
  "name": "Web-сайт",
  "description": "",
  "parent": null,
  "histogram": false,
  "start_date": "2025-05-24T11:02:11.963141+03:00",
  "collapse": false,
  "enabled": true,
  "private": false,
  "impact": "operational"
}

Delete Component

Example request:

DELETE https://status.statusmate.top/api-components-delete/{UUID}/
Authorization: {API_TOKEN}
Content-Type: application/json

Response code:

Get Component List

Example request:

GET https://status.statusmate.top/api-components-list/
Authorization: {API_TOKEN}
Content-Type: application/json

Query Parameters:

parent	(string, UUID)	UUID of the parent component
component	(string, repeated UUID)	UUIDs of the components to retrieve

Example response:

[
  {
    "uuid": "f8936b24-6c4b-4ba9-aa11-9e14a2244cf9",
    "name": "Web-сайт",
    "description": "",
    "impact": "operational"
  },
  {
    "uuid": "946e31f4-1daa-4c36-8e6f-bfd6780ec581",
    "name": "API",
    "description": "",
    "impact": "operational"
  }
]

Next 🤓

WebhookLearn more about webhooks and how to use them

🍪

We use cookies

They help the site work better and analyze traffic.