API skjölun

Sameina EstaCaido með forritum þínum

Byrjað

The EstaCaido API leyfir þér að stjórna skjám þínum, skoða atvik, stilla tilkynningar og fleira úr eigin kóða.Allar API endapunktar nota JSON fyrir beiðni og svar líkama.

Grunnslóð

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

Takmörk hraða

Hver API tákn getur gert allt að 100 beiðnir á mínútu. Beiðnir yfir þessum mörkum fá 429 Too Many Requests svar.

Auðkenning

Nota auðkenningu sem byggist á táknmyndum fyrir allar API beiðnir. Notaðu táknið þitt í höfuðsgreininni Authorization.

Sækja auðkennistákn

POST /api/v1/auth/token/
Beiðni
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"
}

Nota táknið í höfuðsgrein heimildar

Authorization: Token your-api-token-here

Skjár

Stjórna vefsíðu skjám þínum.

Listi yfir skjái

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"
  }
]

Búa til eftirlitskerfi

POST /api/v1/monitors/
Breytur
name Nauðsynlegt Nafn skjásins
domain Nauðsynlegt Lén sem á að fylgjast með, t.d. example.com
check_interval Valfrjálst Athuga millibil í sekúndum, eitt af 30, 60, 300, 600, 900, 1800, 3600. Sjálfgefið: 300
check_type Valfrjálst Eitt af þessum gildum: http, https, ping. Sjálfgefið: https

Sækja skjá

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

Uppfæra skjá

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

Eyða skjá

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

Bíða eftir skjá

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

Halda áfram skjá

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

Sækja tölfræði um skjá

GET /api/v1/monitors/{id}/statistics/
Breytur
days Valfrjálst Fjöldi daga sem á að taka með. Sjálfgefið: 30

Atvik

Skoða niðurbrot atvik og sögu þeirra.

Listi yfir atvik

GET /api/v1/incidents/
Breytur
status Valfrjálst Sía eftir stöðu: í vinnslu, leyst
monitor Valfrjálst Sía eftir skjáauðkenni

Sækja atvik

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

Tilkynningar

Stilla viðvörun tilkynningar fyrir skjái þínum.

Listi yfir áminningar

GET /api/v1/alerts/

Búa til viðvörun

POST /api/v1/alerts/
Breytur
monitor Nauðsynlegt Skjáauðkenni
alert_type Nauðsynlegt Eitt af þessum gildum: email, sms, slack, discord, webhook, pagerduty, teams
recipients Nauðsynlegt Netföng viðtakenda eða vefslóðir
alert_on_down Valfrjálst Láta vita þegar vefsvæðið fer niður (sjálfgefið: satt)
alert_on_recovery Valfrjálst Láta vita þegar vefsvæðið endurheimtir (sjálfgefið: satt)

Uppfæra viðvörun

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

Eyða áminningu

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

Staða síður

Búa til og stjórna opinberum stöðu síðum.

Listi yfir stöðusíður

GET /api/v1/status-pages/

Búa til stöðusíðu

POST /api/v1/status-pages/
Breytur
title Nauðsynlegt Titill á stöðusíðu
slug Nauðsynlegt Slóð (t.d. my-status-page)
description Valfrjálst Lýsing
is_public Valfrjálst Gera aðgengilegt almenningi (sjálfgefið: satt)

Lið

Stjórna lið aðgang og samvinnu.

Listi yfir lið

GET /api/v1/teams/

Búa til lið

POST /api/v1/teams/

Sækja lið

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

Dæmi um kóða

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

Tilbúinn til að byrja?

Skráðu þig ókeypis og fáðu API táknið þitt til að byrja að samþætta.

Skráðu þig ókeypis Fá API Token