IT OPERATIONSIncident management
PostgreSQLNot signed inSign in

INTEGRATION / REST API

OpsDesk API

The REST API uses the same incident services and database rules as the web UI.

Open schema

API lifecycle

Client request
  ↓
Django REST Framework
  ↓
Serializer validation
  ↓
Business service layer
  ↓
PostgreSQL
  ↓
JSON response
EndpointPurposeOpen
/api/v1/API rootOpen
/api/v1/incidents/List, filter, search, create incidentsOpen
/api/v1/incidents/<id>/Retrieve or patch an incident
/api/v1/incidents/<id>/comments/Add comment
/api/v1/incidents/<id>/assign/Assign incident
/api/v1/incidents/<id>/status/Change status
/api/v1/incidents/<id>/audit/Read audit events
/api/v1/applications/Read applicationsOpen
/api/v1/statistics/Read operational metricsOpen
⌘ What is happening?Request lifecycle
  1. Browser requested API documentation
  2. Django rendered the REST API explanation page
  3. Generated schema is available at /api/schema/
Database writesNone