Overview
Cirkus is a powerful tool for project management and team collaboration. The REST API allows developers to integrate Cirkus functionalities into their own applications. This guide provides a quickstart for getting up and running with the Cirkus REST API.
Base URL
All API requests for https://cirkus.com are made to the following base URL:
https://cirkus.com/api/v1/
For private clouds please check with our support team.
Authentication
You will need an API Key to use the REST API endpoints.
On https://cirkus.com the API Key must belong to a Cirkus user who is a member of a Cirkus Pro Workspace.
We recommend using a dedicated system account for API integrations, to avoid issues with user lifecycle management.
Getting an API Key
- Log in to the integration users Cirkus account on web or Cirkus mac application.
- Navigate to your User Preferences via the Settings link at the bottom of the left menu
- Click on the API Keys tab.
- Type a name for your API key and click on Add Key
- Now you can copy the key to your Clipboard
Headers
Include the following headers in all your API requests:
Cirkus-API-Key: YOUR_API_KEY
Content-Type: application/json
Example Request
Here’s an example using `curl` to list projects:
curl -X GET https://cirkus.com/api/v1/projects \
-H "Cirkus-API-Key: YOUR_API_KEY" \
-H “Content-Type: application/json”
Error Handling
Cirkus API uses standard HTTP status codes to indicate the success or failure of an API request.
200 OK: The request was successful.
201 Created: A new resource was successfully created.
400 Bad Request: The request was invalid or cannot be served.
401 Unauthorized: Authentication failed or user ( the owner of the API Key) does not have permissions.
403 Forbidden: User ( the owner of the API Key) does not have access to the requested resource
404 Not Found: The requested resource could not be found.
5XX Internal Server Error: An error occurred on the server.
Detailed API documentation
For detailed information on endpoints and functionalities, the latest Cirkus API documentation is published on SwaggerHub at https://app.swaggerhub.com/api/Cirkus/cirkus-server
If you need support with other endpoints or technical assistance please contact [email protected], and our team will be happy to help.