База знаний

Используйте API Статусмейт для интеграции

API Статусмейт предоставляет простой и надежный способ интеграции с нашей системой мониторинга и управления статусами сервисов
Аутентификация
Для выполнения запросов к API Статусмейт необходимо передавать токен API в заголовке
Authorization
:


Authorization: <API_TOKEN>
Получите ваш API токен страницы
Вы можете получить свой API-ключ на странице настроек страницы в разделе Интеграции.
Ошибки
Пример ответа при ошибке
(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."]
  }
}
1
Создание компонента
POST https://status.statusmate.ru/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"
}

Пример ответа:

{
  "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"
}
2
Обновление компонента
POST https://status.statusmate.ru/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"
}

Пример ответа:

{
  "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"
}
3
Удаление компонента
DELETE https://status.statusmate.ru/api-components-delete/<UUID>
Authorization: <API_TOKEN>
Content-Type: application/json

Код ответа:

204
4
Получить список компонентов
GET https://status.statusmate.ru/api-components-list/
Authorization: <API_TOKEN>
Content-Type: application/json

Параметры запроса:

  • parent

    (string, UUID)

    -

    UUID родительского компонента

  • component

    (string, repeated)

    -

    UUID компонентов которые нужно получить

    Пример:

    ?component=86966fd8-4d3a-40fe-ab1b-5af18e67dde5&component=98a0fb7c-6b34-4616-a091-deaae68f5aa3

Пример ответа:

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

Далее 🤓

WebhookУзнайте больше о webhook и его использовании