Docs Endpoints

Endpoints

Explore the available Cirrus API endpoints.

Analytics

Analytics endpoints.

Method	Path	Description
GET	`/v1/analytics`	Get analytics by scope
GET	`/v1/analytics/publications/{id}`	Get analytics for a publication within the authenticated scope.
GET	`/v1/analytics/publications/{id}/activity`	Get daily analytics for a publication within the authenticated scope.
GET	`/v1/analytics/publications/popular`	Get popular publication analytics.

List, update, and delete API keys.

Method	Path	Description
GET	`/v1/apikeys`	List API keys owned by the current user.
DELETE	`/v1/apikeys/{id}`	Delete an API key by ID.
GET	`/v1/apikeys/{id}`	Retrieve a single API key by ID.
PATCH	`/v1/apikeys/{id}`	Update the name, scopes, revocation state, or status of an API key.

Billing endpoints.

Method	Path	Description
GET	`/v1/billing/usage`	Get current bandwidth usage and projected billing information.
POST	`/v1/billing/webhooks/stripe`	Receive signed Stripe billing webhook events.

Domains endpoints.

Method	Path	Description
GET	`/v1/domains`	List permitted domains for the current scope.
POST	`/v1/domains`	Create a permitted domain.
DELETE	`/v1/domains/{id}`	Delete an unused permitted domain.
GET	`/v1/domains/{id}`	Get a permitted domain by id.
PATCH	`/v1/domains/{id}`	Update a permitted domain.

List, update, and delete Publication Collections.

Method	Path	Description
GET	`/v1/collections`	List all Publication Collections.
POST	`/v1/collections`	Create a new Publication Collection.
DELETE	`/v1/collections/{id}`	Delete a Publication Collection by ID.
GET	`/v1/collections/{id}`	Retrieve a single Publication Collection by ID.
PATCH	`/v1/collections/{id}`	Update the name, or description of an Publication Collection.
POST	`/v1/collections/bulk`	Perform a batch operation for Publication Collections.

List publications and create publication upload sessions.

Method	Path	Description
POST	`/v1/publication-uploads`	Create an upload intent for a publication or publication edition.
GET	`/v1/publications`	Get all publications.
POST	`/v1/publications`	Create a publication and upload session.
DELETE	`/v1/publications/{id}`	Delete publication by id
GET	`/v1/publications/{id}`	Get publication by id
PATCH	`/v1/publications/{id}`	Update a publication.
GET	`/v1/publications/{id}/editions`	Get all editions for a publication.
POST	`/v1/publications/{id}/editions`	Create an edition for a publication and upload session.
GET	`/v1/publications/{id}/editions/{editionid}`	Get edition by ID for a publication.
PATCH	`/v1/publications/{id}/editions/{editionid}`	Update an edition for a publication.
POST	`/v1/publications/bulk`	Perform a batch operation for Publications.

Reader Instances endpoints.

Method	Path	Description
GET	`/v1/reader-instances`	List reader instances.
DELETE	`/v1/reader-instances/{id}`	Delete reader instance by id
GET	`/v1/reader-instances/{id}`	Get reader instance by Id.
POST	`/v1/reader-instances/{id}/copy`	Duplicate a reader instance by id.

Reader Users endpoints.

Method	Path	Description
GET	`/v1/reader-users`	List reader users
GET	`/v1/reader-users/{id}`	Get reader user by id

Resources endpoints.

Method	Path	Description
GET	`/v1/resources/assets`	List assets for the current scope.
POST	`/v1/resources/assets`	Create a new asset.
DELETE	`/v1/resources/assets/{id}`	Delete an asset by id.
PATCH	`/v1/resources/assets/{id}`	Update an asset by id.
GET	`/v1/resources/metadata-keys`	List user-defined metadata keys for the active scope.
POST	`/v1/resources/metadata-keys`	Create a reusable metadata key for the active scope.
DELETE	`/v1/resources/metadata-keys/{id}`	Permanently delete an archived, unused custom metadata key.
PATCH	`/v1/resources/metadata-keys/{id}`	Archive or restore a reusable metadata key.

Manage users available through the Cirrus API.

Method	Path	Description
DELETE	`/v1/users`	Delete current user
GET	`/v1/users`	List all users