Nhazi

EstaCaido API na-enye gị ohere ịrụzi monitors gị, hụ ihe mere, họrọ n'ime ihe n'ime na ihe ndị ọzọ site na koodu gị. API endpoints niile na-eji JSON maka arịrịọ na arụmọrụ nzaghachi.

URL nke okpuru

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

Òtù

Token API ọbụla nwere ike imepụta ruo 100 n'ime nkeji. Nnweta n'elu nke ahụ ga-enweta nzaghachi 429 Too Many Requests.

Nkwenye

Jiri ikikembanye token-base maka ihenhọrọ API niile. Tinye token gị na n'ihenhọrọ ikikembanye.

Nweta ikikembanye Token

POST /api/v1/auth/token/

Nhazi

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

Ndesịta ozi ahụ

{
  "token": "your-api-token-here"
}

Jiri token na n'ihenlekọta ikikembanye

Authorization: Token your-api-token-here

Monítọ̀

Kọọ ndị nlekọta weebụsaịtị gị.

Ndesịta monītōònụ̀

GET /api/v1/monitors/

Ndesịta ozi ahụ

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

Mepụta Nyochaa

POST /api/v1/monitors/

Paramita

`name`	Ekwesịrị	Aha maka ngosi
`domain`	Ekwesịrị	Domeenụ́ ahụ a ga-enyocha, dịka ọmụmaatụ example.com
`check_interval`	Nhọrọ	Nchedo n'etiti n'ime sekọnd, otu n'ime 30, 60, 300, 600, 900, 1800, 3600. Dìfọ́ọ̀ltụ̀: 300
`check_type`	Nhọrọ	Otu n'ime valiu ndị a: http, https, ping. Dìfọ́ọ̀ltụ̀: https

Nlekọta

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

Nlekọta mmegharị

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

Hichaa ngosi

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

Nlekọta

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

Kpụga n'omume

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

Nweta ozi nkeonwe

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

Paramita

days Nhọrọ Nọmba ụbọchị ka a gbakwunye. Dìfọ́ọ̀ltụ̀: 30

Ihenhọrọ ndị ahụ

Gosi ihenhọrọ ndị ahụ na akụkọ ihe mere eme ha.

Ndesịta ihenhọrọ ndị ahụ

GET /api/v1/incidents/

Paramita

`status`	Nhọrọ	Filtara site na ọnọdụ: na-aga n'ihu, rụzigharịrị
`monitor`	Nhọrọ	Filtara site na ngosi ID

Wepụta ihenhọrọ ndị ahụ

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

Nhazi

Nhazi nkwenye maka monítọ́ọ̀tụ̀ gị.

Ndesịta ozi ndị ahụ

GET /api/v1/alerts/

Kewapụta nlekọta

POST /api/v1/alerts/

Paramita

`monitor`	Ekwesịrị	Ngosi ID
`alert_type`	Ekwesịrị	Otu n'ime valiu ndị a: email, sms, slack, discord, webhook, pagerduty, teams
`recipients`	Ekwesịrị	Ndesịta adreesị ndịna-eziga mọọbụ webụhook URLs
`alert_on_down`	Nhọrọ	Nnyemaka mgbe saịtị ahụ na-akwụsị (dìfọ́ọ̀ltụ̀: eziokwu)
`alert_on_recovery`	Nhọrọ	Nnyemaka mgbe saịtị ahụ na-abanye (dìfọ́ọ̀ltụ̀: eziokwu)

Nhazi

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

Hichaa ozi ahụ

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

Ihu ndị ahụ

Kewapụta na chịkwaa ihuakwụkwọ ọnọdụ ndị mmadụ.

Ndesịta ihu ndị ahụ nke ọnọdụ

GET /api/v1/status-pages/

Kewapụta ihuakwụkwọ

POST /api/v1/status-pages/

Paramita

`title`	Ekwesịrị	Aha maka ihuakwụkwọ ọnọdụ
`slug`	Ekwesịrị	URL slug (eg, my-status-page)
`description`	Nhọrọ	Ndesịta nkọwa
`is_public`	Nhọrọ	Mee ka ọbụla nwee ike ịga (dìfọ́ọ̀ltụ̀: eziokwu)

Ụlọọrụ

Nlekọta nbanye na ọrụ n'ime otu.

Ndesịta ndị ọrụ

GET /api/v1/teams/

Kewapụta otu

POST /api/v1/teams/

Wepụta otu

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

Nhazi kood

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

Dọkumenti

Nhazi

URL nke okpuru

Òtù

Nkwenye

Nweta ikikembanye Token

Jiri token na n'ihenlekọta ikikembanye

Monítọ̀

Ndesịta monītōònụ̀

Mepụta Nyochaa

Paramita

Nlekọta

Nlekọta mmegharị

Hichaa ngosi

Nlekọta

Kpụga n'omume

Nweta ozi nkeonwe

Paramita

Ihenhọrọ ndị ahụ

Ndesịta ihenhọrọ ndị ahụ

Paramita

Wepụta ihenhọrọ ndị ahụ

Nhazi

Ndesịta ozi ndị ahụ

Kewapụta nlekọta

Paramita

Nhazi

Hichaa ozi ahụ

Ihu ndị ahụ

Ndesịta ihu ndị ahụ nke ọnọdụ

Kewapụta ihuakwụkwọ

Paramita

Ụlọọrụ

Ndesịta ndị ọrụ

Kewapụta otu

Wepụta otu

Nhazi kood

Python

JavaScript

cURL

N'ihi na ịchọrọ ịmalite?