Инциденты

Примечания
Для опытных пользователей
Передавайте ключ API как токен Bearer в заголовке Authorization. Получить ключ API.
Список

Адрес API:

GET 
https://api.tuptime.ru/v1/incidents

Пример запроса: 

curl --location --request GET 'https://api.tuptime.ru/v1/incidents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
необязательно string
Поисковый запрос.
search_by
необязательно string
Искать по. Допустимые значения: monitor — Монитор, cause — Причина. По умолчанию: url.
monitor_id
необязательно string
ID монитора.
status
необязательно string
Статус. Допустимые значения: unresolved — Не устранён, acknowledged — Принят в работу, resolved — Устранён.
sort_by
необязательно string
Сортировать по. Допустимые значения: started_at — Дата начала, ended_at — Дата окончания. По умолчанию: ended_at.
sort
необязательно string
Сортировка. Допустимые значения: desc — По убыванию, asc — По возрастанию. По умолчанию: desc.
per_page
необязательно integer
Записей на странице. Допустимые значения: 10, 25, 50, 100. По умолчанию: 10.
Посмотреть

Адрес API:

GET 
https://api.tuptime.ru/v1/incidents/{id}

Пример запроса: 

curl --location --request GET 'https://api.tuptime.ru/v1/incidents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Создать

Адрес API:

POST 
https://api.tuptime.ru/v1/incidents

Пример запроса: 

curl --location --request POST 'https://api.tuptime.ru/v1/incidents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'monitor_id={monitor_id}' \
--data-urlencode 'started_at={started_at}'
Параметр
Тип
Описание
monitor_id
обязательно integer
ID монитора.
started_at
обязательно string
Дата начала в формате Y-m-dTH:i:s.
acknowledged_at
необязательно string
Дата принятия в работу в формате Y-m-dTH:i:s.
ended_at
необязательно string
Дата окончания в формате Y-m-dTH:i:s.
cause
необязательно string
Причина.
comment
необязательно string
Комментарий.
Обновить

Адрес API:

PUT PATCH 
https://api.tuptime.ru/v1/incidents/{id}

Пример запроса: 

curl --location --request PUT 'https://api.tuptime.ru/v1/incidents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
acknowledged_at
необязательно string
Дата принятия в работу в формате Y-m-dTH:i:s.
ended_at
необязательно string
Дата окончания в формате Y-m-dTH:i:s.
cause
необязательно string
Причина.
comment
необязательно string
Комментарий.
Удалить

Адрес API:

DELETE 
https://api.tuptime.ru/v1/incidents/{id}

Пример запроса: 

curl --location --request DELETE 'https://api.tuptime.ru/v1/incidents/{id}' \
--header 'Authorization: Bearer {api_key}'