API दस्तऐवजीकरण

EstaCaido ला तुमच्या अनुप्रयोगांशी एकत्र करा

प्रारंभ करीत आहे

EstaCaido API तुम्हाला तुमच्या मॉनिटरचे व्यवस्थापन, घटना पहा, अलर्टची रचना आणि तुमच्या स्वतःच्या कोडपासून अधिक देते. सर्व API अंतबिंदू विनंती आणि प्रतिसाद शरीरासाठी JSON वापरतात.

आधार URL

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

दर मर्यादा

प्रत्येक API टोकन 100 प्रति मिनिट विनंती करीता तयार करू शकते. त्या मर्यादेच्या वरील विनंती 429 Too Many Requests प्रतिसाद मिळवितात.

अधिप्रमाणन

सर्व 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 आवश्यक नियंत्रीत करण्याकरीताचे क्षेत्र, उदाहरणार्थ example.com
check_interval वैकल्पिक सेकंद अंतर्गत तपासणी अंतराल, 30, 60, 300, 600, 900, 1800, 3600 मधील एक. मुलभूत: 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/

अलार्म बनवा@ action

POST /api/v1/alerts/
पैरामीटर
monitor आवश्यक मॉनीटर ID
alert_type आवश्यक यापैकी एक मूल्य: email, sms, slack, discord, webhook, pagerduty, teams
recipients आवश्यक प्राप्तकर्ता पत्ता किंवा वेबहॉक URLs
alert_on_down वैकल्पिक स्थळ बंद झाल्यास सूचना द्या (मासिक: true)
alert_on_recovery वैकल्पिक स्थळ पुन्हप्राप्ती करीता सूचना (मासिक: true)

अद्ययावत अलार्म

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

अलार्म नष्ट करा@ action

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

स्थिती पान

सार्वजनिक स्थिती पान तयार करा व व्यवस्थापन करा.

स्थिती पानांची यादी

GET /api/v1/status-pages/

स्थिती पान बनवा

POST /api/v1/status-pages/
पैरामीटर
title आवश्यक स्थिती पान करीता शिर्षक
slug आवश्यक URL slagg (उदा. माझे-स्थिती-पान)
description वैकल्पिक वर्णन पाठ्य
is_public वैकल्पिक सार्वजनिकरित्या उपलब्ध करा (मासिक: true)

संघ

या संस्थेचे कार्य व कार्यपद्धती खालीलप्रमाणे आहे.

संघांची यादी

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 टोकन प्राप्त करा