Optimize API
Use the Optimize API to manage and analyze reports and dashboards in Camunda Optimize.
About
You can use the Optimize API to:
- Retrieve, create, update, and delete reports and dashboards
- Export dashboards and reports for sharing or backup
- Enable or disable sharing links
Authentication
All Optimize API requests, except the health readiness endpoint, require authentication. To authenticate, generate a JSON Web Token (JWT) and include it in each request.
For more details, see the Authentication section.
API Postman collection
To get started quickly, consider using the Postman collection.
Usage notes
Deleting a file, folder, or project via the API is immediate and cannot be undone. Use caution.