API- dokumentation

Integrer EstaCaido med dine applikationer

Kom i gang

EstaCaido API lader dig administrere dine skærme, se hændelser, konfigurere advarsler og mere fra din egen kode. Alle API endpoints bruger JSON til anmodning og svar organer.

Basis- URL

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

Rategrænser

Hver API token kan gøre op til 100 anmodninger pr. minut. Anmodninger over denne grænse få en 429 Too Many Requests svar.

Godkendelse

Brug token- baseret godkendelse for alle API- forespørgsler. Inkluder din token i Autorisationsoverskriften.

Få godkendelseslogo

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

Brug token i godkendelsesoverskriften

Authorization: Token your-api-token-here

Monitorer

Administrer dine hjemmesideskærme.

Listeovervågning

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

Opret skærm

POST /api/v1/monitors/
Parametre
name Krævet Navn på overvågningsenheden
domain Krævet Domæne til overvågning, for eksempel example.com
check_interval Valgfrit Tjek interval i sekunder, en af 30, 60, 300, 600, 900, 1800, 3600. Standard: 300
check_type Valgfrit En af disse værdier: http, https, ping. Standard: https

Hent skærm

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

Opdatér skærm

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

Slet skærm

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

Pauseskærm

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

Genoptag skærm

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

Hent overvågningsstatistik

GET /api/v1/monitors/{id}/statistics/
Parametre
days Valgfrit Antal dage der skal inkluderes. Standard: 30

Tilfælde

Se downtime hændelser og deres historie.

Listeover hændelser

GET /api/v1/incidents/
Parametre
status Valgfrit Filtrer efter status: igangværende, løst
monitor Valgfrit Filtrer efter skærm- ID

Få hændelse

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

Indberetninger

Indstil advarselsmeddelelser til dine skærme.

Listemeddelelser

GET /api/v1/alerts/

Opret alarm

POST /api/v1/alerts/
Parametre
monitor Krævet Overvågnings- ID
alert_type Krævet En af disse værdier: email, sms, slack, discord, webhook, pagerduty, teams
recipients Krævet Modtageradresser eller webhook-URL'er
alert_on_down Valgfrit Advisér når webstedet går ned (standard: true)
alert_on_recovery Valgfrit Advisér når webstedet genopretter (standard: true)

Opdatér alarm

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

Slet alarm

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

Statussider

Opret og administrere offentlig status sider.

Listestatussider

GET /api/v1/status-pages/

Opret statusside

POST /api/v1/status-pages/
Parametre
title Krævet Titel på statussiden
slug Krævet URL-snegl (f.eks. min statusside)
description Valgfrit Varebeskrivelse
is_public Valgfrit Gøre det offentligt tilgængeligt (standard: sand)

Hold

Administrer teamadgang og samarbejde.

Listehold

GET /api/v1/teams/

Opret team

POST /api/v1/teams/

Få hold

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

Kodeeksempler

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

Er du klar til at komme i gang?

Tilmeld dig gratis og få din API token til at begynde at integrere.

Tilmeld dig gratis Hent API- token