Tusitusiga API

Faʻafesoʻotaʻi EstaCaido ma au talosaga

Faʻavaeina

O le EstaCaido API e mafai ai ona e pulea au moni, vaʻai i faʻalavelave, faʻatonu faʻaletonu ma isi mai lau lava code. O le API uma e faʻaaogaina JSON mo talosaga ma tali tino.

URL Faavae

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

Faʻatapulaʻa o le fua

E mafai e so o se tokeni API ona faia se talosaga 100 i le minute. O talosaga i luga o lea faailoga e maua ai se tali 429 Too Many Requests.

Faʻamaonia

Faʻaaoga le faʻamaonia e faʻavae i luga o le token mo soʻo se talosaga API. Faʻaopopo lau token i le ulutala Faʻamaonia.

Faʻataga le faʻamaonia

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

Faʻaaoga le token i le ulutala o le Faʻamaonia

Authorization: Token your-api-token-here

Faʻaaliga

Fa'atonutonu au mata'ituina o le 'upega tafa'ilagi.

Faʻafanua

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

Fausia Mataitu

POST /api/v1/monitors/
Paramita
name E manaʻomia Le igoa mo le faʻaaliga
domain E manaʻomia Dome e mataituina, mo se faataitaiga example.com
check_interval Faʻatonu Faʻaiuga o le taimi e siaki ai i sekone, tasi o 30, 60, 300, 600, 900, 1800, 3600. Faʻatonu: 300
check_type Faʻatonu O se tasi o nei meatotino: http, https, ping. Faʻatonu: https

Faʻataga le Faʻailo

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

Faafouina le Faamalamalamaga

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

Suʻe

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

Faʻaola le Faʻailo

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

Faʻaauau le Faʻailo

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

Faʻataga le Faʻamatalaga o le Faʻailo

GET /api/v1/monitors/{id}/statistics/
Paramita
days Faʻatonu Numera o aso e aofia ai. Faʻatonu: 30

Faʻalavelave

Vaai i faalavelave faafuasei ma a latou talafaasolopito.

Faʻavasega Faʻalavelave

GET /api/v1/incidents/
Paramita
status Faʻatonu Filtrieren nach Status: in Bearbeitung, gelöst
monitor Faʻatonu Filtrir par moniteur ID

Faʻataga le Faʻalavelave

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

Faʻamalo

Faʻatulagaina o faʻamatalaga o le faʻailo mo au faʻaaliga.

Faʻailo

GET /api/v1/alerts/

Faʻatonu

POST /api/v1/alerts/
Paramita
monitor E manaʻomia Faʻaaliga ID
alert_type E manaʻomia O se tasi o nei meatotino: email, sms, slack, discord, webhook, pagerduty, teams
recipients E manaʻomia Adresses or webhook URLs
alert_on_down Faʻatonu Fa'ailoa pe a le'i fa'atino le 'upega tafa'ilagi (fa'amaumau: moni)
alert_on_recovery Faʻatonu Faʻailoa pe a toe maua le 'upega tafaʻilagi (faʻamaumau: moni)

Faafouina le Faʻamalo

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

Faʻa_upuga

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

Tuʻu i tua

Faʻatu ma faʻatonutonu itulau o le tulaga lautele.

Faʻavasega itulau o le tulaga

GET /api/v1/status-pages/

Faʻatonu le Faʻatonu

POST /api/v1/status-pages/
Paramita
title E manaʻomia Tifaga mo le itulau tulaga
slug E manaʻomia URL slug (e.g., my-status-page)
description Faʻatonu Faʻamatalaga o le tusitusiga
is_public Faʻatonu Faʻatumauina i le lautele (faʻatonu: moni)

Auaunaga

Faʻatonutonu le avanoa ma le galulue faʻatasi o le 'au.

Faʻavasega au taʻaloga

GET /api/v1/teams/

Faʻavae se 'au

POST /api/v1/teams/

Faʻataga le 'au

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

Faʻataʻitaʻiga o le Tulafono

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

E sauni e amata?

Faʻafesoʻotaʻi mo le saoloto ma maua lau API token e amata ai le faʻafetauiina.

Saini Sa'oloto Faʻataga API Token