АПИ документација

Интегриши зEstaCaido са вашим програмима

Почињем

ЗEstaCaido API омогућава вам да управљате мониторима, приказујете инциденте, подесите упозорења и више из вашег кода. Сви АПИ исходни крајеви користе ЈСОН за захтев и одговор на тела.

Основни УРЛ

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

Ограничења променљиве

Each API token can make up to 100 requests per minute. Requests over that limit get a 429 Too Many Requests response.

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

Користите аутентификацију засновану на жетону за све АПИ захт› јеве. Укључите свој жетон у заглавље аутентификације.

Добављање аутентификације

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: 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`	Опционо	Филтрирај по стању: у току, решено
`monitor`	Опционо	Филтрирај по ИД‐ у монитора

Добијање случаја

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

Упозорења

Подесите обавештења о упозорењу за мониторе.

Упозоре на списак

GET /api/v1/alerts/

Упозорење о стварању

POST /api/v1/alerts/

Параметри

`monitor`	неопходно	ИД монитора
`alert_type`	неопходно	Једна од ових вр› иједности: email, sms, slack, discord, webhook, pagerduty, teams
`recipients`	неопходно	адресе примаоца или веб- коцкарски УРЛ‐ ови
`alert_on_down`	Опционо	Обавести када се сајт спусти (подразум› ијевано: тачно)
`alert_on_recovery`	Опционо	Обавести када се сајт опорави (подразум› ијевано: тачно)

Упозорење о ажурирању

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

Упозорење о обрисању

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

Странице стања

Стварање и управљање јавним стањем.

Странице стања списка

GET /api/v1/status-pages/

Направи страницу стања

POST /api/v1/status-pages/

Параметри

`title`	неопходно	Наслов странице стања
`slug`	неопходно	УРЛ пужење (нпр., моја-стање-страница)
`description`	Опционо	текст описа
`is_public`	Опционо	Направи јавно приступачно (подразум› ијевано: тачно)

Тимови

Управљајте приступом тиму и сарадњом.

Списак тимова

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 токена