API-dokumentaatio

Integroi EstaCaido sovelluksiisi

Aloittaminen

EstaCaido API:n avulla voit hallita monitoria, tarkastella tapahtumia, määrittää hälytyksiä ja muuta omasta koodistasi. Kaikki API:n päätetapahtumat käyttävät JSON-järjestelmää pyyntö- ja vastauselimiin.

Perusverkko- osoite

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

Ratarajat

Jokainen API-topoke voi korvata 100-pyynnöt minuutissa. Tämän rajan ylittävä pyyntö saa 429 Too Many Requests-vastauksen.

Todentaminen

Käytä tunnuspohjaista tunnistautumista kaikkiin API-pyyntöihin. Sisällytä merkkisi valtuutusotsikkoon.

Hanki varmennus

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

Käytä nimimerkkiä valtuusotsikossa

Authorization: Token your-api-token-here

Seurantoja

Hallitse verkkosivujen monitoreja.

Luettelon valvojat

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

Luo näyttö

POST /api/v1/monitors/
Parametrit
name Vaadittu Monitorin nimi
domain Vaadittu Valvottava verkkoalue, esimerkiksi example.com
check_interval Valinnainen Tarkista väli sekunneissa, yksi 30, 60, 300, 600, 900, 1800, 3600. Oletus: 300
check_type Valinnainen Yksi näistä arvoista: http, https, ping. Oletus: https

Hae Monitor

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

Päivitä monitori

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

Poista monitori

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

Pysäytä monitori

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

Jatka monitorin käyttöä

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

Hanki seurantatilastoja

GET /api/v1/monitors/{id}/statistics/
Parametrit
days Valinnainen Päivämäärä mukaan lukien. Oletus: 30

Tapahtumia

Katso selinajot ja niiden historia.

Luettele tapahtumat

GET /api/v1/incidents/
Parametrit
status Valinnainen Suodata tilan mukaan: käynnissä, ratkaistu
monitor Valinnainen Suodata monitorin tunnisteella

Hanki välikohtaus

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

Hälytykset

Määritä hälytysilmoitukset monitorille.

Luetteloilmoitukset

GET /api/v1/alerts/

Luo hälytys

POST /api/v1/alerts/
Parametrit
monitor Vaadittu Seuraa tunnistetta
alert_type Vaadittu Yksi näistä arvoista: email, sms, slack, discord, webhook, pagerduty, teams
recipients Vaadittu Vastaanottajaosoitteet tai verkkokoukkujen URL-osoitteet
alert_on_down Valinnainen Ilmoita, kun paikka menee nurin (oletus: totta)
alert_on_recovery Valinnainen Ilmoita, kun paikka palautuu (oletus: totta)

Päivitä hälytys

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

Poista hälytys

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

Tilasivut

Luo ja hallitse julkisen tilan sivuja.

Listan tilasivut

GET /api/v1/status-pages/

Luo tilasivu

POST /api/v1/status-pages/
Parametrit
title Vaadittu Tilasivun nimi
slug Vaadittu URL-etäisyys (esim. oma-asentosivu)
description Valinnainen Kuvausteksti
is_public Valinnainen Julkisuus (oletus: totta)

Ryhmät

Hallitse tiimien pääsyä ja yhteistyötä.

Luetteloryhmät

GET /api/v1/teams/

Luo tiimi

POST /api/v1/teams/

Hae tiimi

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

Koodiesimerkit

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

Oletko valmis aloittamaan?

Rekisteröidy ilmaiseksi ja pyydä API-tunnustasi aloittamaan integrointi.

Rekisteröidy ilmaiseksi Hae API Token