Skip to the content

Documentation

Connect OpsCommand to everything you run.

Guides and references for the people who connect OpsCommand to their systems and run it.

The API
GET /v1/openapi.json
GET /v1/organisations/{org}/…
Authorization: Bearer …
Idempotency-Key: …

200 application/json
4xx application/problem+json
X-Request-Id: …

Reference

The API

Everything the web app does, it does through the API: OpenAPI 3.1, JSON, versioned in its path.

  • OpenAPI 3.1/v1/openapi.json
  • RFC 9457application/problem+json
  • Idempotency-KeyPOST, safe to retry
  • X-Request-IdOn every answer