Uxwebhu lwe API

Integrate EstaCaido with your applications

Ukuqalisa

I-EstaCaido API ikuvumela ukuba uphatha iimodyuli zakho, ubone iziganeko, uqwalasele izilumkiso kunye nezinye izinto ezivela kwikhowudi yakho. Zonke iziphelo ze-API zisebenzisa i-JSON yesicelo kunye nobume bophendula.

Isiseko se URL

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

Iindawo ezimfutshane

I-API nganye i-token ingayenza ifike kwi-100 iimfuno ngomzuzu. Iimfuno ezingaphezulu komda zifumana uphendulo lwe-429 Too Many Requests.

Uqinisekiso

Sebenzisa ubungqina obusekelwe kwi-token kuzo zonke izicelo ze-API. Quka i-token yakho kwi-Authorization header.

Fumana Isiqinisekiso

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

Sebenzisa i-token kwi-Authorization header

Authorization: Token your-api-token-here

IiMonitha

Ilawula iinxuwa le web ezijongwa.

Uluhlu lweMonitha

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

Yenza iMoni

POST /api/v1/monitors/
Iiparamitha
name Ifunekayo Igama lemboniselo
domain Ifunekayo Ithambeka elijongwa, umzekelo example.com
check_interval Ekunokukhethwa kuko Khangela ixesha lokuphumla kwimizuzwana, enye ye 30, 60, 300, 600, 900, 1800, 3600. Okwendalo: 300
check_type Ekunokukhethwa kuko Enye yazo zonke ezi zinto: http, https, ping. Okwendalo: https

Fumana iMonitha

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

Hlela iMonitha

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

Cima iMonitha

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

Imboniselo ye Window

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

Qhubekeka

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

Fumana Iinkcukacha-manani Zemboniselo

GET /api/v1/monitors/{id}/statistics/
Iiparamitha
days Ekunokukhethwa kuko Inani leentsuku eziqukayo. Okwendalo: 30

Iingxaki

Bona iziganeko zexesha elikhubazekileyo kunye nembali yazo.

Uluhlu lweeNkqubo

GET /api/v1/incidents/
Iiparamitha
status Ekunokukhethwa kuko Icebo lokucoca ulwelo ngemeko: iqhubeka, ilungisiwe
monitor Ekunokukhethwa kuko Icebo lokucoca ulwelo nge Monitor ID

Fumana Isiganeko

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

Iialarms

Configure alert notifications for your monitors.

Uluhlu lwe Alarm

GET /api/v1/alerts/

Yenza Isilumkiso

POST /api/v1/alerts/
Iiparamitha
monitor Ifunekayo Imboniselo ye ID
alert_type Ifunekayo Enye yazo zonke ixabiso: email, sms, slack, discord, webhook, pagerduty, teams
recipients Ifunekayo Idilesi yomfumani okanye i-webhook URLs
alert_on_down Ekunokukhethwa kuko Isaziso xa inxuwa liwela phantsi (okwendalo: yinyaniso)
alert_on_recovery Ekunokukhethwa kuko Isaziso xa indawo ibuyisela (okungagqibekanga: inyaniso)

Hlela Isilumkiso

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

Cima Isilumkiso@ action

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

Iphepha lendawo yokusebenza

Yenza kwaye uphatha amaphepha okubonakala kobume bukawonkewonke.

Uluhlu lweeNkqubo

GET /api/v1/status-pages/

Yenza Iphepha Lendawo Yokusebenza

POST /api/v1/status-pages/
Iiparamitha
title Ifunekayo Isihloko sephepha lesimo
slug Ifunekayo I-URL slug (umzekelo. my-status-page)
description Ekunokukhethwa kuko Inkcazelo yombhalo
is_public Ekunokukhethwa kuko Yenza ukuba ifikelelwe ngabantu (okungagqibekanga: inyaniso)

Iiqela

Ulawulo lweqela lokufikelela kunye nokusebenza

Uluhlu lwee-Teams

GET /api/v1/teams/

Yenza iqela

POST /api/v1/teams/

Fumana Iqela

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

Iimizekelo zekhowudi

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

Ilungile ukuqalisa?

Sign up for free and get your API token to start integrating.

Bhalisa Mahala Fumana i-API Token