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.

ಮೂಲ URL

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

ದೃಢೀಕರಣದ (authentication) ಶಿರೋನಾಮದಲ್ಲಿ ಚಿಹ್ನೆಯನ್ನು ಬಳಸಿ

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 ಆಯ್ಕೆ ಪ್ರದರ್ಶಕದ ಗುರುತು

ಅಪಕರ್ಷಿತವಾಗಿರಿ

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 ಆಯ್ಕೆ ತಾಣವು ಕೆಳಕ್ಕೆ ತೆರಳಿದಾಗ ಸಂರಚಿಸಿ (ಪೂರ್ವನಿಯೋಜಿತ: ಸತ್ಯ):
alert_on_recovery ಆಯ್ಕೆ ತಾಣವನ್ನು ಮರಳಿ ಸ್ಥಾಪಿಸಿದಾಗ (ಪೂರ್ವನಿಯೋಜಿತ: ಸತ್ಯ):

ಎಚ್ಚರಿಕೆಯನ್ನು ಅಪ್ಡೇಟ್ ಮಾಡು

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

ಎಚ್ಚರಕವನ್ನು ಅಳಿಸು

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

ಸ್ಥಿತಿ ಪುಟಗಳು

ಸಾರ್ವಜನಿಕ ಸ್ಥಿತಿ ಪುಟಗಳನ್ನು ಸೃಷ್ಟಿಸು ಹಾಗು ನಿರ್ವಹಿಸು.

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

ಆರಂಭಿಸಲು ಸಿದ್ಧನಾ?

Sign up for free and get your API token to start integrating.

ಉಚಿತವಾಗಿ ಸೈನ್ ಅಪ್ ಮಾಡಿ API ಟೋಕನ್‌ ಅನ್ನು ಪಡೆದುಕೊಳ್ಳಿ