- Getting Started
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Processes Requests
- Queue Items Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
Orchestrator API Guide
Read Me
We plan to upgrade the Orchestrator Swagger version to Swagger 3.0. Currently, Orchestrator APIs are defined using Swagger 2.0.
Do not worry about backwards compatibility with your existing API clients: we will ensure the API remains compatible.
We recommend using your previous clients, as JSON changes do not alter them, thanks to our request structure backwards compatibility.
After the Swagger 3.0 update, all regenerated API clients based on the new JSON definition will have to be readjusted.
If you plan on integrating our APIs with your client, you need to be aware of the possible updates and changes that may happen to the Swagger definition, JSON schemas, or API endpoints.
The below list provides information and recommendations regarding Swagger changes. If you have further questions, contact our support team.
- The JSON API description represented in the Swagger JSON document can change at any time. However, it will describe the same underlying API, to ensure backwards compatibility.
- The Swagger interface and the corresponding JSON are generated based on the current endpoints, and we always publish the latest version. To ensure backwards compatibility, we support the same request structure.
- As an alternative to runtime generated API clients, use fixed or compile time API clients. Doing so reduces dependency and prevents major automation updates in case the API or Swagger definition changes.
- Items marked as deprecated are available for a limited time, after which the items are removed from the Swagger definition and JSON API.
- Whenever certain APIs changes internally, a new Swagger API version is published. The API version number does not influence the usage of the client API. We do not recommend relying on API versioning.
