എപിഐ സഹായക്കുറിപ്പുകള്‍

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 ആവശ്യങ്ങള്‍ക്കും അടയാളം ഉപയോഗിച്ചു് അടയാളപ്പെടുത്തുക. ആധികാരികതയുടെ തലക്കെട്ടില്‍ നിങ്ങളുടെ സൂചകം ഉള്‍പ്പെടുത്തുക.

തിരിച്ചറിയല്‍ ടോക്കനെ ലഭ്യമാക്കുക

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`	ഐച്ഛികം	സെക്കന്‍ഡുകളില്‍ ഇടവേള പരിശോധിക്കുക, 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 ഐച്ഛികം Number of days to include. Default: 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`	ആവശ്യമുണ്ട്	മെയില്‍ വിലാസങ്ങളോ വെബ് ഹൂക്ക് യുആര്‍എല്‍കളോ
`alert_on_down`	ഐച്ഛികം	സൈറ്റ് താഴുമ്പോള്‍ അറിയിക്കുക (സഹജം: ശരി)
`alert_on_recovery`	ഐച്ഛികം	സൈറ്റ് വീണ്ടെടുക്കുമ്പോള്‍ അറിയിക്കുക (സഹജം: ശരി)

ജാഗ്രത പുതുക്കുക

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

ജാഗ്രത വെട്ടി നീക്കുക

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

അവസ്ഥയുടെ താളുകള്‍

Create and manage public status pages.

അവസ്ഥാപകര്‍പ്പുകള്‍ പട്ടികയില്‍ വെക്കുക

GET /api/v1/status-pages/

അവസ്ഥാ പേജ് സൃഷ്ടിക്കുക

POST /api/v1/status-pages/

പരാമീറ്ററുകള്‍

`title`	ആവശ്യമുണ്ട്	അവസ്ഥയുടെ താളിന്റെ തലക്കെട്ടു്
`slug`	ആവശ്യമുണ്ട്	യുആര്‍എല്‍ സ്ക്രിപ്റ്റ് (ഉദാ, എന്‍റെ- സ്റ്റാന്‍ഡേര്‍ഡ്- പേജു്)
`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 ടോക്കനെ എടുക്കുക