APIపత్రరచన

Integrate EstaCaido with your applications

ప్రారంభించడం

The EstaCaido API lets you manage your monitors, view incidents, configure alerts and more from your own code. All API endpoints use JSON for request and response bodies.

మూల యూఆర్ఎల్

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

రేటు పరిమితులు

Each API token can make up to 100 requests per minute. Requests over that limit get a 429 Too Many Requests response.

ధృవీకరణ

అన్ని API అభ్యర్ధనలకు సంకేతాన్ని వుపయోగించుము. SSHCE థీమబుల్ శీర్షికలో మీ టిక్క్యాస్‌ను చేర్చండి.

ధృవీకరణ టకెన్ పొందుము

POST /api/v1/auth/token/

మనవి

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

స్పందన

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

ధృవీకరణ హెడర్‌నందు గుర్తును వుపయోగించుము

Authorization: Token your-api-token-here

మానిటర్

మీ వెబ్‌సైట్ మానిటర్లను నిర్వహించండి.

జాబితా మానిటర్

GET /api/v1/monitors/

స్పందన

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

మానిటర్‌ను సృష్టించండి

POST /api/v1/monitors/

పారామితి

`name`	అవసరం	మానిటర్ కొరకు పేరు
`domain`	అవసరం	Domain to monitor, for example example.com
`check_interval`	ఐచ్చికం	Check interval in seconds, one of 30, 60, 300, 600, 900, 1800, 3600. Default: 300
`check_type`	ఐచ్చికం	ఆ విలువలలో ఒక: http, https, ping. అప్రమేయం: https

మానిటర్‌ను స్వీయీకరించు

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

మానిటర్‌ను నవీకరించుము

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

మానిటర్‌ను తొలగించుము

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

మానిటర్‌ను నిలిపివేయి

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

మానిటర్‌ను తిరిగివుంచుము

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

మానిటర్ గణాంకాలను పొందుము

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

పారామితి

days ఐచ్చికం జతచేయబడిన రోజుల సంఖ్య. అప్రమేయ: 30

విభాగాలు

చరిత్రను, వాటి చరిత్రను చూడండి.

ప్రాక్సీల జాబితా

GET /api/v1/incidents/

పారామితి

`status`	ఐచ్చికం	స్థితి ద్వారా ఫిల్టర్:
`monitor`	ఐచ్చికం	మానిటర్ ID ద్వారా ఫిల్టర్

తెలుసుకొనుటకు అనుమతి పొందండి

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

హెచ్చరికలు

Configure alert notifications for your monitors.

హెచ్చరికలను జాబితాగాచూపు

GET /api/v1/alerts/

హెచ్చరికను సృష్టించుము

POST /api/v1/alerts/

పారామితి

`monitor`	అవసరం	మానిటర్ ఐడి
`alert_type`	అవసరం	One of these values: email, sms, slack, discord, webhook, pagerduty, teams
`recipients`	అవసరం	స్వీకరించు చిరునామాలు లేదా వెబ్ టు URLలు
`alert_on_down`	ఐచ్చికం	సైటు డౌన్ అయినప్పుడు గుర్తుపెట్టవద్దు ( అప్రమేయ: rue):
`alert_on_recovery`	ఐచ్చికం	సైటు తిరిగినప్పినపుడు గుర్తుపెట్టవద్దు (అప్రమెయం: వునట్టు)

హెచ్చరికను నవీకరించు

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

విలోమ ను తొలగించుము

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

స్థితి పుటలు

Create and manage public status pages.

List Status Pages

GET /api/v1/status-pages/

స్థితి పేజీను సృష్టించుము

POST /api/v1/status-pages/

పారామితి

`title`	అవసరం	స్థితి పేజీ యొక్క శీర్షిక
`slug`	అవసరం	URL స్క్రాపర్ (ఉ. దా., నా-కలాగ్- పేజీలు)
`description`	ఐచ్చికం	వివరణ వచనము
`is_public`	ఐచ్చికం	బహిరంగంగా చేరువండి (అప్రమేయంగా):

బృందములు

బృందం యాక్సెస్ మరియు సాంస్కృతిక పర్యవేక్షించు

జాబితా జట్టులు

GET /api/v1/teams/

జట్టు సృష్టించు

POST /api/v1/teams/

జట్టు నిరూపణ పొందండి

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

కోడ్ ఉదాహరణలు

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

ప్రారంభించడానికి సిద్ధంగా?

ఉచిత కోసం సైన్ చేయండి మరియు మీ API సంకేతం రీడర్ ప్రారంభించడానికి పొందుటకు.

ఉచితంగా సైన్ అప్ చేయండి API టోకెన్‌ను పొందండి