API- dokumentasjon

Integrer EstaCaido med dine programmer

Kom i gang

Med EstaCaido API kan du styre skjermene dine, se hendelser, sette opp varslinger og mer fra din egen kode. Alle API endepunkter bruker JSON for spørsmål og svar- organer.

Basis- URL

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

Fartsgrenser

Hvert API- symbol kan oppgjøre til 100 forespørsler per minutt. Forespørsler om at grensen overskrides får et svar fra 429 Too Many Requests.

Autentisering

Bruk symbolbasert autentisering for alle API- forespørsler. Ta med symbolet i autorisasjonshodet.

Hent autentiseringstegn

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

Bruk symbolet i autorisasjonshodet

Authorization: Token your-api-token-here

Skjermer

Håndter nettsidene dine.

Listeovervåkere

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

Opprett skjerm

POST /api/v1/monitors/
Parametre
name Kreves Navn på overvåkingsenheten
domain Kreves Domene som skal overvåkes, for eksempel example.com
check_interval Valgfri Sjekk intervall i sekunder, en av 30, 60, 300, 600, 900, 1800, 3600. Standard: 300
check_type Valgfri En av disse verdiene: http, https, ping. Standard: https

Hent skjerm

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

Oppdater overvåking

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

Slett skjerm

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

Pauseovervåker

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

Fortsett overvåking

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

Hent statistikk for skjermen

GET /api/v1/monitors/{id}/statistics/
Parametre
days Valgfri Antall dager som skal tas med. Standard: 30

Hendelser

Se hendelser med driftsstans og deres historie.

Listehendelser

GET /api/v1/incidents/
Parametre
status Valgfri Filtrer etter status: pågår, slået opp
monitor Valgfri Filtrer etter skjerm- ID

Hent hendelse

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

Varsler

Sett opp varslinger for skjermene dine.

Listevarsler

GET /api/v1/alerts/

Opprett varsling

POST /api/v1/alerts/
Parametre
monitor Kreves Skjerm- ID
alert_type Kreves En av disse verdiene: email, sms, slack, discord, webhook, pagerduty, teams
recipients Kreves Mottakeradresser eller webhook- URL- er
alert_on_down Valgfri Varsle når nettstedet går ned (standard: « sann »)
alert_on_recovery Valgfri Gi beskjed når nettstedet gjenoppretter seg (standard: « true »)

Oppdateringsvarsling

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

Slett varsling

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

Statussider

Lag og behandle offentlige statussider.

Liste over statussider

GET /api/v1/status-pages/

Lag statusside

POST /api/v1/status-pages/
Parametre
title Kreves Tittel på statussiden
slug Kreves URL-snegle (f.eks. min statusside)
description Valgfri Beskrivelsestekst
is_public Valgfri Gjør offentlig tilgjengelig (standard: « sann »)

Lag

Håndter gruppetilgang og samarbeid.

Listegrupper

GET /api/v1/teams/

Lag lag

POST /api/v1/teams/

Hent lag

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

Kodeeksempel

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

Klar til å komme i gang?

Bli gratis og hent API- symbolet for å begynne å integrere.

Registrer deg gratis Hent API-tegn