Developers

API Documentation Overview

Authentication

Most API endpoints require authentication using a Bearer token. Generate your API token from your account settings.

Monitoring API

Manage monitors and checks via the API:

• GET /api/v1/monitors — List monitors
• POST /api/v1/monitors — Create monitor
• GET /api/v1/monitors/{id} — Get monitor
• PUT /api/v1/monitors/{id} — Update monitor
• DELETE /api/v1/monitors/{id} — Delete monitor

Status API

Public status endpoints for status pages:

• GET /api/status/{slug}/services — List services for a status page
• GET /api/status/{slug}/incidents — List incidents for a status page

Log Ingestion API

Ingest application logs via API:

• POST /api/logs/ingest — Agent log ingestion. Auth: Bearer server api_token. Rate: 60/min.
• POST /api/logs/push — HTTP push. Auth: Bearer user API token. Rate: 120/min. Include server_id in body.
• Payload: source, level, message, timestamp, context, stack_trace, file, line

Webhook API

Webhooks send HTTP POST requests to your URL when events occur. Payload includes event type, monitor data, and incident details. Supported events: monitor.down, monitor.up, incident.created, incident.updated, incident.resolved.

Example API Request

GET https://monitor.srvdesk.com/api/v1/status

{
  "message": "Online.",
  "status": 200
}