Skip to content

API reference

The full API reference is generated from the FastAPI OpenAPI schema.

Live schema

On every Vesana instance:

https://your-domain.tld/openapi.json    — Schema (JSON)
https://your-domain.tld/docs            — Swagger UI
https://your-domain.tld/redoc           — Redoc

Swagger UI is interactive: open endpoints, try requests directly with the logged-in token.

Categorized endpoints

Auth

  • POST /api/v1/auth/login
  • POST /api/v1/auth/2fa/verify
  • POST /api/v1/auth/refresh
  • POST /api/v1/auth/logout
  • GET /api/v1/auth/me
  • PUT /api/v1/auth/preferences
  • POST /api/v1/auth/api-keys
  • GET /api/v1/auth/api-keys
  • DELETE /api/v1/auth/api-keys/{id}

Hosts and services

  • GET /api/v1/hosts/
  • POST /api/v1/hosts/
  • GET /api/v1/hosts/{id}
  • PATCH /api/v1/hosts/{id}
  • DELETE /api/v1/hosts/{id}
  • POST /api/v1/host-services/
  • PATCH /api/v1/host-services/{id}
  • DELETE /api/v1/host-services/{id}
  • POST /api/v1/host-services/{id}/ack
  • DELETE /api/v1/host-services/{id}/ack

Profiles

  • GET /api/v1/profiles/
  • POST /api/v1/profiles/
  • GET /api/v1/profiles/{id}
  • PATCH /api/v1/profiles/{id}
  • DELETE /api/v1/profiles/{id}
  • GET /api/v1/profiles/{id}/usage
  • POST /api/v1/profiles/{id}/clone
  • GET /api/v1/profiles/{id}/export
  • POST /api/v1/profiles/import
  • POST /api/v1/profiles/{id}/apply
  • GET /api/v1/profiles/{id}/checks
  • POST /api/v1/profiles/{id}/checks/{check_id}/reset

Discovery + SNMP

  • POST /api/v1/discovery/network-scan
  • GET /api/v1/discovery/scans/{id}
  • GET /api/v1/discovery/results
  • POST /api/v1/discovery/results/{id}/add
  • POST /api/v1/discovery/results/bulk-add
  • POST /api/v1/snmp-discovery/walks
  • GET /api/v1/snmp-discovery/walks/{id}
  • POST /api/v1/snmp-discovery/walks/{id}/apply

Alert rules + channels

  • GET /api/v1/alert-rules/
  • POST /api/v1/alert-rules/
  • POST /api/v1/alert-rules/{id}/test
  • GET /api/v1/notification-channels/
  • POST /api/v1/notification-channels/
  • POST /api/v1/notification-channels/{id}/test

Downtimes + ACK

  • GET /api/v1/downtimes/
  • POST /api/v1/downtimes/

Logs

  • POST /api/v1/logs/ingest
  • GET /api/v1/logs/search
  • GET /api/v1/logs/stream — SSE
  • GET /api/v1/logs/sources
  • GET /api/v1/logs/alert-rules

Dashboards + reports

  • GET /api/v1/dashboards/
  • POST /api/v1/dashboards/
  • GET /api/v1/reports/sla
  • POST /api/v1/reports/generate

Wiki + AI

  • GET /api/v1/wiki/articles
  • POST /api/v1/wiki/articles
  • GET /api/v1/wiki/search?q=...
  • POST /api/v1/ai/chat
  • POST /api/v1/ai/chat/stream — SSE
  • POST /api/v1/ai/analyze/{service_id}
  • GET /api/v1/ai/status
  • PUT /api/v1/ai/config
  • GET /api/v1/ai/models
  • POST /api/v1/ai/models/pull
  • POST /api/v1/ai/models/delete
  • POST /api/v1/ai/test-connection

Admin

  • POST /api/v1/admin/export
  • POST /api/v1/admin/import
  • GET /api/v1/admin/health/snapshot
  • GET /api/v1/admin/license/status

Audit + trash

  • GET /api/v1/audit-log/
  • GET /api/v1/audit-log/export
  • GET /api/v1/trash/summary
  • POST /api/v1/trash/{kind}/{id}/restore
  • DELETE /api/v1/trash/{kind}/{id}/purge

Push + mobile

  • POST /api/v1/push-tokens/register
  • POST /api/v1/push-tokens/test
  • GET /api/v1/push-tokens/devices

Receiver (agent / collector)

  • POST /api/v1/receiver/check-result
  • POST /api/v1/agent/heartbeat
  • GET /api/v1/agent/config
  • GET /api/v1/config/collector/{collector_id}

Response codes

Code Meaning
200 / 201 / 204 success
400 request body validation error
401 not authenticated or token expired
403 authenticated but no permission
404 resource not found / not in your tenant scope
409 conflict (e.g. duplicate hostname)
422 validation failed (Pydantic detail in body)
429 rate limit
500 server error (shouldn't happen — open issue)
503 Service Unavailable (e.g. license missing for endpoint)

Next