API-ключи и публичный REST API

API-ключи позволяют автоматизировать управление мониторами, проектами и инцидентами через REST API: создавать мониторы из CI/CD-пайплайнов, получать данные об аптайме или интегрировать статусы с внутренними системами.

Создание API-ключа

В нижней части бокового меню нажмите «Ещё», затем «API-ключи».
Нажмите кнопку «Создать ключ».
Введите описательное название (например, «CI/CD Pipeline» или «Monitoring Dashboard»).
Нажмите «Создать». Ключ будет показан один раз — скопируйте его немедленно.

Ключ отображается только при создании. После закрытия диалога посмотреть его значение повторно невозможно. Если ключ утерян — удалите его и создайте новый.

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

Все запросы к API должны содержать заголовок Authorization с вашим ключом:

Authorization: Bearer <ваш-api-ключ>

Пример запроса — получение списка мониторов:

curl -H 'Authorization: Bearer API_KEY' \
     https://upradar.pro/api/v1/monitors

API возвращает ответы в JSON. При ошибке аутентификации возвращается 401 Unauthorized.

Безопасность

Чтобы отозвать скомпрометированный ключ:

Откройте Ещё → API-ключи в боковом меню.
Найдите нужный ключ в списке и нажмите «Удалить».
Подтвердите удаление. Ключ перестаёт работать мгновенно.

Никогда не фиксируйте API-ключи в системах контроля версий. Используйте переменные окружения (например, UPRADAR_API_KEY) или менеджеры секретов.

Доступные эндпоинты

API v1 ориентирован на управление мониторами. На данный момент доступны следующие эндпоинты:

Метод	Эндпоинт	Описание
`GET`	`/api/v1/monitors`	Список всех мониторов аккаунта
`POST`	`/api/v1/monitors`	Создание HTTP-монитора (только тип `http`)

Создание мониторов через API v1 поддерживается только для типа http. Публичный REST API находится в разработке — новые эндпоинты будут добавлены в следующих обновлениях.