Documenti

EstaCaido kwa matumizi yako

Kuanza

Ndege aina ya EstaCaido API inakuruhusu uangalie vifaa vyako vya kuchunguza, uone matukio, kuweka alama za uso na zaidi kutoka kwenye mfumo wako wa sheria.

Base URUL

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

Mipaka ya Viwango

Kila saa ya asubuhi inaweza kufikia 100 kwa dakika moja. maombi ya kuomba kwa kiasi hicho yanaweza kuwa jibu la 429 Too Many Requests.

Kupatana

Tumia mapendekezo ya hali ya juu kwa ajili ya matumizi yote ya API.

Aelewa Mambo kwa Makini

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

Tumia ishara katika kitabu Kutengeneza Habari

Authorization: Token your-api-token-here

Wachunguzi

Chunguza tovuti yako.

Waoni Wahusika

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

Unda Monitor

POST /api/v1/monitors/
Juzi
name Zahitajiwa Jina la kifaa hicho
domain Zahitajiwa Kwa mfano, example.com
check_interval Njia za kuchagua Chunguza kwa sekunde chache, moja ya 30, 60, 300, 600, 900, 1800, 3600. Default: 300
check_type Njia za kuchagua Mojawapo ya kanuni hizi: http, https, ping. Default: https

Uwe Mtahini

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

Monifu

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

Monito Wenye Kuzorota

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

Monifu

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

Monifu wa Resume

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

Pata Takwimu za Kuchanganua

GET /api/v1/monitors/{id}/statistics/
Juzi
days Njia za kuchagua Idadi ya siku za kujumuisha. Defrault: 30

Matukio

Ona matukio ya wakati uliopita na historia yayo.

Orodha ya Matukio

GET /api/v1/incidents/
Juzi
status Njia za kuchagua Kujiingiza kwa hadhi: kuendelea, kuazimia
monitor Njia za kuchagua Filter by slict ID

Pata Kutambuliwa

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

Tahadhari

Chunguza habari zako kwa uangalifu.

Tahadhari Zilizoorodheshwa

GET /api/v1/alerts/

Uwe Macho

POST /api/v1/alerts/
Juzi
monitor Zahitajiwa Moni MUZIKI
alert_type Zahitajiwa Mojawapo ya kanuni hizi: email, sms, slack, discord, webhook, pagerduty, teams
recipients Zahitajiwa Anwani za hapa na pale au anwani za ndoana za mtandao wa intaneti
alert_on_down Njia za kuchagua Hakikisha ni wakati gani tovuti inapoanguka (madhara: kweli)
alert_on_recovery Njia za kuchagua Hakikisha kwamba tovuti itarudia hali yake (ajali: kweli)

Tahadhari ya Kipya

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

Tahadhari ya Dechate

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

Kurasa za Hali ya Juu

Create and which pages of fecture.

Kurasa za Kuwekewa Orodha

GET /api/v1/status-pages/

Tafuta Habari Bora

POST /api/v1/status-pages/
Juzi
title Zahitajiwa Jina la ukurasa wa kwanza
slug Zahitajiwa URL LOLS (e.g., page)
description Njia za kuchagua Maandishi ya picha
is_public Njia za kuchagua Tumikieni hadharani (kwa bahati: ukweli)

Vikundi

Tunza upatikanaji wa timu na ushirikiano.

Orodha za Orodha

GET /api/v1/teams/

Kuanzisha Timu

POST /api/v1/teams/

Pata Ushirikiano

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

Vielelezo vya Sheria

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

Je, uko tayari kuanza?

Jisajili fomu yako ya malipo ya bure na uibebe.

Jisajili Bure Pata Kuamka