Документация API

Это документация для доступных конечных точек API, которые построены на основе архитектуры REST. Все конечные точки API будут возвращать JSON-ответ с стандартными кодами ответа HTTP и требуют аутентификации Bearer с помощью API-ключа.

Получите собственный API-ключ

Базовый URL

Аутентификация

Все конечные точки API требуют API-ключ, отправленный с помощью метода аутентификации Bearer.

Authorization: Bearer {api_key}

Пример

curl --request GET \
--url 'https://uptimeset.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Ошибки

Наш API использует стандартные коды состояния HTTP для обозначения успеха или неудачи запроса.

Пример

{
    "errors": [
        {
            "title": "\u0423 \u0432\u0430\u0441 \u043d\u0435\u0442 \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a API.",
            "status": 401
        }
    ]
}

Коды состояния

200 Запрос успешно выполнен

400 Неверный запрос - Необходимые параметры отсутствуют или недействительны

401 Неавторизован - API-ключ отсутствует или недействителен

404 Запрошенный ресурс не найден

429 Слишком много запросов - превышен лимит запросов

500 Внутренняя ошибка сервера - это означает, что проблема на нашей стороне

Все результаты API-эндпоинтов работают с UTC временной зоной, если не указано иное.

Пользователь

Мониторы доступности

DNS мониторы

Серверные мониторы

Сердцебиения

Доменные имена

Обработчики уведомлений

Инциденты

Платежи по счету

Журналы аккаунта