Страницы статуса

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

Адрес API:

GET 
https://api.tuptime.ru/v1/status-pages

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

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

Адрес API:

GET 
https://api.tuptime.ru/v1/status-pages/{id}

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

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

Адрес API:

POST 
https://api.tuptime.ru/v1/status-pages

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

curl --location --request POST 'https://api.tuptime.ru/v1/status-pages' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'slug={slug}'
Параметр
Тип
Описание
name
обязательно string
Название.
slug
обязательно string
Адрес страницы.
monitor_ids[]
необязательно array
ID мониторов
privacy
необязательно integer
Конфиденциальность. Допустимые значения: 0 — Публичный, 1 — Приватный, 2 — Пароль. По умолчанию: 0.
password
необязательно string
Пароль. Работает, только если в поле privacy указано 2.
domain
необязательно string
Свой домен.
logo
необязательно file
Логотип.
favicon
необязательно file
Иконка сайта.
remove_logo
необязательно boolean
Убрать логотип.
remove_favicon
необязательно boolean
Убрать иконку сайта.
website_url
необязательно string
URL сайта.
contact_url
необязательно string
Ссылка для связи.
custom_css
необязательно string
Свой CSS.
custom_js
необязательно string
Свой JavaScript.
meta_title
необязательно string
Заголовок для поисковых систем.
meta_description
необязательно string
Описание для поисковых систем.
noindex
необязательно boolean
Скрыть страницу статуса от поисковых систем.
Обновить

Адрес API:

POST 
https://api.tuptime.ru/v1/status-pages/{id}

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

curl --location --request POST 'https://api.tuptime.ru/v1/status-pages/{id}' \
--header 'Authorization: Bearer {api_key}' \
--form '_method="PUT"'
Параметр
Тип
Описание
_method
обязательно string
Укажите значение PUT.
name
необязательно string
Название.
slug
необязательно string
Адрес страницы.
monitor_ids[]
необязательно array
ID мониторов
privacy
необязательно integer
Конфиденциальность. Допустимые значения: 0 — Публичный, 1 — Приватный, 2 — Пароль.
password
необязательно string
Пароль. Работает, только если в поле privacy указано 2.
domain
необязательно string
Свой домен.
logo
необязательно file
Логотип.
favicon
необязательно file
Иконка сайта.
remove_logo
необязательно boolean
Убрать логотип.
remove_favicon
необязательно boolean
Убрать иконку сайта.
website_url
необязательно string
URL сайта.
contact_url
необязательно string
Ссылка для связи.
custom_css
необязательно string
Свой CSS.
custom_js
необязательно string
Свой JavaScript.
meta_title
необязательно string
Заголовок для поисковых систем.
meta_description
необязательно string
Описание для поисковых систем.
noindex
необязательно boolean
Скрыть страницу статуса от поисковых систем.
Удалить

Адрес API:

DELETE 
https://api.tuptime.ru/v1/status-pages/{id}

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

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