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

Включите EstaCaido в приложения

Начало работы

API EstaCaido позволяет управлять мониторами, просматривать инциденты, настраивать оповещения и многое другое из вашего кода. Все конечные точки API используют JSON в запросах и ответах.

Базовый URL

https://www.estacaido.com/api/v1/

Лимиты запросов

Каждый токен API может отправлять не более 100 запросов в минуту. На запросы сверх лимита приходит ответ 429 Too Many Requests.

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

Используйте токен для аутентификации всех запросов к API. Передавайте токен в заголовке Authorization.

Получить токен аутентификации

POST /api/v1/auth/token/
Запрос
curl -X POST https://www.estacaido.com/api/v1/auth/token/ \
  -H "Content-Type: application/json" \
  -d '{"username": "your@email.com", "password": "yourpassword"}'
Ответ
{
  "token": "your-api-token-here"
}

Передайте токен в заголовке Authorization

Authorization: Token your-api-token-here

Мониторы

Управляйте мониторами своих сайтов.

Список мониторов

GET /api/v1/monitors/
Ответ
[
  {
    "id": 1,
    "name": "Production API",
    "company": {
      "id": 1,
      "website": "api.example.com"
    },
    "check_type": "http",
    "check_interval": 300,
    "is_active": true,
    "is_paused": false,
    "last_check_at": "2024-01-15T10:30:00Z",
    "created_at": "2024-01-01T00:00:00Z"
  }
]

Создать монитор

POST /api/v1/monitors/
Параметры
name Обязательно Название монитора
domain Обязательно Домен для мониторинга, например example.com
check_interval Необязательно Интервал проверки в секундах, одно из значений 30, 60, 300, 600, 900, 1800, 3600. По умолчанию: 300
check_type Необязательно Одно из значений: http, https, ping. По умолчанию: https

Получить монитор

GET /api/v1/monitors/{id}/

Обновить монитор

PUT /api/v1/monitors/{id}/

Удалить монитор

DELETE /api/v1/monitors/{id}/

Приостановить монитор

POST /api/v1/monitors/{id}/pause/

Возобновить монитор

POST /api/v1/monitors/{id}/resume/

Получить статистику монитора

GET /api/v1/monitors/{id}/statistics/
Параметры
days Необязательно Число дней в выборке. По умолчанию: 30

Инциденты

Просматривайте инциденты простоя и их историю.

Список инцидентов

GET /api/v1/incidents/
Параметры
status Необязательно Фильтр по статусу: ongoing, resolved
monitor Необязательно Фильтр по ID монитора

Получить инцидент

GET /api/v1/incidents/{id}/

Оповещения

Настройте уведомления оповещений для своих мониторов.

Список оповещений

GET /api/v1/alerts/

Создать оповещение

POST /api/v1/alerts/
Параметры
monitor Обязательно ID монитора
alert_type Обязательно Одно из значений: email, sms, slack, discord, webhook, pagerduty, teams
recipients Обязательно Адреса получателей или URL вебхуков
alert_on_down Необязательно Уведомлять, когда сайт недоступен (по умолчанию: true)
alert_on_recovery Необязательно Уведомлять, когда сайт восстановлен (по умолчанию: true)

Обновить оповещение

PUT /api/v1/alerts/{id}/

Удалить оповещение

DELETE /api/v1/alerts/{id}/

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

Создавайте публичные страницы статуса и управляйте ими.

Список страниц статуса

GET /api/v1/status-pages/

Создать страницу статуса

POST /api/v1/status-pages/
Параметры
title Обязательно Заголовок страницы статуса
slug Обязательно Слаг URL (например, my-status-page)
description Необязательно Текст описания
is_public Необязательно Сделать общедоступным (по умолчанию: true)

Команды

Управляйте доступом команды и совместной работой.

Список команд

GET /api/v1/teams/

Создать команду

POST /api/v1/teams/

Получить команду

GET /api/v1/teams/{id}/

Примеры кода

Python

import requests

API_TOKEN = 'your-api-token'
BASE_URL = 'https://www.estacaido.com/api/v1'

headers = {
    'Authorization': f'Token {API_TOKEN}',
    'Content-Type': 'application/json'
}

# List all monitors
response = requests.get(f'{BASE_URL}/monitors/', headers=headers)
monitors = response.json()
print(monitors)

# Create a new monitor
new_monitor = {
    'name': 'My Website',
    'domain': 'example.com',
    'check_interval': 300
}
response = requests.post(f'{BASE_URL}/monitors/', json=new_monitor, headers=headers)
print(response.json())

JavaScript

const API_TOKEN = 'your-api-token';
const BASE_URL = 'https://www.estacaido.com/api/v1';

const headers = {
    'Authorization': `Token ${API_TOKEN}`,
    'Content-Type': 'application/json'
};

// List all monitors
fetch(`${BASE_URL}/monitors/`, { headers })
    .then(res => res.json())
    .then(monitors => console.log(monitors));

// Create a new monitor
fetch(`${BASE_URL}/monitors/`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
        name: 'My Website',
        domain: 'example.com',
        check_interval: 300
    })
})
.then(res => res.json())
.then(data => console.log(data));

cURL

# List all monitors
curl -X GET https://www.estacaido.com/api/v1/monitors/ \
  -H "Authorization: Token your-api-token"

# Create a new monitor
curl -X POST https://www.estacaido.com/api/v1/monitors/ \
  -H "Authorization: Token your-api-token" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Website", "domain": "example.com", "check_interval": 300}'

Готовы начать?

Зарегистрируйтесь бесплатно и получите токен API, чтобы начать интеграцию.

Зарегистрируйтесь бесплатно Получить токен API