API dokumentacija

Integriraj EstaCaido sa svojim aplikacijama

Početak

EstaCaido API vam omogućava da upravljate svojim monitorima, pregledavate incidente, konfigurirate upozorenja i još mnogo toga iz vašeg vlastitog koda. Sve krajnje tačke API-ja koriste JSON za tijela zahtjeva i odgovora.

Osnovni URL

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

Ograničenje brzine

Svaki API token može izvršiti do 100 zahtjeva u minuti. Zahtjevi iznad tog ograničenja dobivaju 429 Too Many Requests odgovor.

Autorizacija

Koristi autentifikaciju zasnovanu na tokenu za sve API zahtjeve. Uključite svoj token u zaglavlje Autorizacija.

Primi token za provjeru autentičnosti

POST /api/v1/auth/token/
Zahtjev
curl -X POST https://www.estacaido.com/api/v1/auth/token/ \
  -H "Content-Type: application/json" \
  -d '{"username": "your@email.com", "password": "yourpassword"}'
Odgovor
{
  "token": "your-api-token-here"
}

Koristi token u zaglavlju Autorizacija

Authorization: Token your-api-token-here

Monitori

Upravljajte svojim web-monitorima.

Pokaži monitore

GET /api/v1/monitors/
Odgovor
[
  {
    "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"
  }
]

Kreiraj monitor

POST /api/v1/monitors/
Parametri
name Obvezno Ime za monitor
domain Obvezno Domena koju treba pratiti, na primjer example.com
check_interval Neobavezno Interval provjere u sekundama, jedan od 30, 60, 300, 600, 900, 1800, 3600. Uobičajeno: 300
check_type Neobavezno Jedna od ovih vrijednosti: http, https, ping. Uobičajeno: https

Prikaži monitor

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

Ažuriraj monitor

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

Izbriši monitor

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

Monitor

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

Nastavi monitor

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

Dohvati statistiku monitora

GET /api/v1/monitors/{id}/statistics/
Parametri
days Neobavezno Broj dana za uključivanje. Uobičajeno: 30

Incidenti

Pogledajmo slučajeve neispravnosti i njihovu historiju.

Popis incidenata

GET /api/v1/incidents/
Parametri
status Neobavezno Filtriraj po statusu: u toku, riješeno
monitor Neobavezno Filtriraj po ID-u monitora

Dohvati incident

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

Upozorenje

Konfiguriraj obavijesti o upozorenjima za svoje monitore.

Lista upozorenja

GET /api/v1/alerts/

Napravi alarm

POST /api/v1/alerts/
Parametri
monitor Obvezno Monitor ID
alert_type Obvezno Jedna od ovih vrijednosti: email, sms, slack, discord, webhook, pagerduty, teams
recipients Obvezno Adrese primalaca ili webhook URL-ovi
alert_on_down Neobavezno Obavijesti kada stranica ne radi (uobičajeno: true)
alert_on_recovery Neobavezno Obavijesti kada se stranica oporavi (uobičajeno: true)

Ažuriraj upozorenje

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

Delete Alert

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

Statusne stranice

Stvara i upravlja javnim statusnim stranicama.

Status stranice

GET /api/v1/status-pages/

Napravi statusnu stranicu

POST /api/v1/status-pages/
Parametri
title Obvezno Naslov za statusnu stranicu
slug Obvezno URL slug (npr. my-status-page)
description Neobavezno Opis teksta
is_public Neobavezno Učini javno dostupnim (uobičajeno: istina)

Teams

Upravljanje timskim pristupom i saradnjom.

Lista timova

GET /api/v1/teams/

Napravi tim

POST /api/v1/teams/

Get Team

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

Primjeri koda

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}'

Spreman za početak?

Registrirajte se besplatno i dobijte svoj API token da počnete integrirati.

Registrujte se besplatno Primi API token