Api Title

Api Subtitle

Api Getting Started

Api Intro

Api Base Url

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

Api Rate Limits

Api Rate Limits Desc

Api Authentication

Api Auth Desc

Api Get Token

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

Api Use Token

Authorization: Token your-api-token-here

Api Monitors Section

Api Monitors Desc

List Monitors

GET /api/v1/monitors/
Api Response
[
  {
    "id": 1,
    "name": "Production API",
    "company": {
      "id": 1,
      "website": "api.example.com"
    },
    "check_type": "http",
    "check_interval": 5,
    "is_active": true,
    "is_paused": false,
    "last_check_at": "2024-01-15T10:30:00Z",
    "created_at": "2024-01-01T00:00:00Z"
  }
]

Monitor oanmeitsje

POST /api/v1/monitors/
Api Parameters
name Required Api Param Name
domain Required Api Param Domain
check_interval Optional Api Param Interval
check_type Optional Api Param Check Type

Get Monitor

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

Update Monitor

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

Delete Monitor

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

Pause Monitor

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

Resume Monitor

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

Get Statistics

GET /api/v1/monitors/{id}/statistics/
Api Parameters
days Optional Api Param Days

Api Incidents Section

Api Incidents Desc

List Incidents

GET /api/v1/incidents/
Api Parameters
status Optional Api Param Status
monitor Optional Api Param Monitor Id

Get Incident

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

Api Alerts Section

Api Alerts Desc

List Alerts

GET /api/v1/alerts/

Create Alert

POST /api/v1/alerts/
Api Parameters
monitor Required Api Param Monitor Id
alert_type Required Api Param Alert Type
recipients Required Api Param Recipients
alert_on_down Optional Api Param Alert Down
alert_on_recovery Optional Api Param Alert Recovery

Update Alert

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

Delete Alert

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

Api Status Pages Section

Api Status Pages Desc

List Status Pages

GET /api/v1/status-pages/

Create Status Page

POST /api/v1/status-pages/
Api Parameters
title Required Api Param Title
slug Required Api Param Slug
description Optional Api Param Description
is_public Optional Api Param Public

Api Teams Section

Api Teams Desc

List Teams

GET /api/v1/teams/

Create Team

POST /api/v1/teams/

Get Team

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

Api Examples

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': 5
}
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: 5
    })
})
.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": 5}'

Api Ready Start

Api Cta Desc

Registrearje fergees Get Api Token