Documentation / API Reference

API Reference

Programmatic access to your cost data, resources, and anomalies. The Cirrova API is a REST API conforming to OpenAPI Specification 3.1.

On this page

Interactive docs

The full endpoint reference is available as an interactive Scalar explorer. You can browse every endpoint, inspect request and response schemas, and send live requests directly from the browser.

Open API explorer
You'll need an API key to send requests. See Authentication below for how to create one.

Authentication

All API requests must be authenticated using an API key. Include your key in the X-API-Key header of every request:

X-API-Key: <your-api-key>

Creating an API key

API keys are managed per organisation and can only be created by org owners.

  1. In Cirrova, open Organisation settings from the user menu.
  2. Go to the API keys tab.
  3. Click Create API key, give it a name, and optionally set an expiry date.
  4. Copy the key immediately — it is only shown once.
Treat API keys like passwords. Store them in a secrets manager or environment variable — never commit them to source control. If a key is compromised, delete it from the API keys tab and create a new one.

Revoking an API key

To revoke a key, go to Organisation settings → API keys, find the key in the list, and delete it. Revocation takes effect immediately — any requests using that key will return 401 Unauthorized.

Base URL

All API endpoints are relative to the following base URL:

https://cirrova-dev.azurewebsites.net/api/public/v1

For example, to list resources you would call:

GET https://cirrova-dev.azurewebsites.net/api/public/v1/resources

OpenAPI spec

The raw OpenAPI 3.1 specification is available as a JSON document. You can use it to generate client SDKs, import the collection into tools like Postman or Insomnia, or validate requests and responses in your own tooling.

Download openapi.json
Back to Documentation