Перейти до вмісту

API

Pingio REST API

Усе, що робить панель керування, доступне через HTTPS, тож моніторинг може жити в тому ж репозиторії, що й ваша інфраструктура.

Базова адреса та версії

Усі ендпоінти розміщені під префіксом із версією. Несумісні зміни виходять як нова версія; сумісні доповнення додаються на місці.

https://pingio.io/api/v1

Автентифікація

Запити автентифікуються bearer-токеном, виданим вашій команді. Зберігайте токен на боці сервера й змінюйте його, якщо він колись потрапив у чужі руки.

curl https://pingio.io/api/v1/monitors \
  -H "Authorization: Bearer $PINGIO_TOKEN"

Створення монітора

Надішліть JSON з описом цілі та умов перевірки. У відповіді буде створений монітор разом з ідентифікатором, який знадобиться для подальших запитів.

curl -X POST https://pingio.io/api/v1/monitors \
  -H "Authorization: Bearer $PINGIO_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production API",
    "type": "http",
    "target": "https://api.example.com/health",
    "intervalSeconds": 60
  }'

Ліміти запитів і помилки

API дозволяє щедрий ліміт запитів на команду й повертає стандартні HTTP-коди. Помилки містять машинозчитуваний код і зрозумілий людині опис.

Відповідь 429 містить заголовок Retry-After. Сприймайте його як сигнал зменшити навантаження, а не повторити запит негайно.