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

ચેતવણીઓ

તમારા મોનિટર માટે ચેતવણી નોંધણીઓ રૂપરેખાંકિત કરો.

ચેતવણીઓની યાદી

GET /api/v1/alerts/

ચેતવણી બનાવો

POST /api/v1/alerts/

પરિમાણો

`monitor`	જરૂરી	મોનિટર ID
`alert_type`	જરૂરી	આ કિંમતોમાંની એક: email, sms, slack, discord, webhook, pagerduty, teams
`recipients`	જરૂરી	મેળવનાર સરનામાં અથવા વેબહોક URLs
`alert_on_down`	વૈકલ્પિક	જ્યારે સાઇટ નીચે જાય ત્યારે સૂચિત કરો (મૂળભૂત: સાચું)
`alert_on_recovery`	વૈકલ્પિક	સાઇટ પુનઃપ્રાપ્ત થાય ત્યારે સૂચિત કરો (મૂળભૂત: સાચું)

ચેતવણી સુધારો

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

ચેતવણી કાઢી નાંખો

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

સ્થિતિ પાનાંઓ

જાહેર સ્થિતિ પાનાંઓ બનાવો અને સંચાલિત કરો.

સ્થિતિ પાનાંઓની યાદી

GET /api/v1/status-pages/

સ્થિતિ પાનું બનાવો

POST /api/v1/status-pages/

પરિમાણો

`title`	જરૂરી	સ્થિતિ પાનાં માટે શીર્ષક
`slug`	જરૂરી	URL 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 ટોકન મેળવો