- Getting Started
- The Swagger Definition
- Examples using the Orchestrator API
- 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
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
- Platform Management APIs
API References
The Orchestrator API Swagger definition can be accessed as follows, depending on your deployment type:
- on-premise - add the following suffix:
/swagger/index.html
to your Orchestrator URL. For example,https://myOrchestrator.com/swagger/index.html
. -
Automation Cloud - add the account and tenant name, as well as the
orchestrator_/swagger/index.html
suffix to the URL. For example,https://cloud.uipath.com/{account_logical_name}/{tenant_name}/orchestrator_/swagger/index.html
.Find your{account_logical_name}
and{tenant_name}
in the API Access page of your Automation Cloud account. -
Automation Suite - add the organization name, tenant name, and the suffix
orchestrator_/swagger/index.html
to your Automation Suite Orchestrator URL, following the syntax:https://AutomationSuiteURL/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html
. For example, to access the Swagger for an Automation Suite deployment of Orchestrator, a possible link could behttps://myasuite.westeurope.cloudapp.azure.com/docs/DefaultTenant/swagger/index.html
.Note:Please note that if you are using Automation Cloud, all requests to Orchestrator endpoints should include/{account_logical_name}/{tenant_name}/
.If you are using Automation Suite, all requests to Orchestrator endpoints should include/{organization_name}/{tenant_name}/
.
The API you see in Swagger is directly dependant on the Orchestrator instance you use. To easily make requests directly in the Swagger documentation, just log in to Orchestrator in another tab. This feature is available starting with the 2017.1 version.
The guide herein is built to support the Swagger documentation, by providing examples for the more trickier Orchestrator endpoints.
A PowerShell library for interacting with your instance of Orchestrator is available here. If you prefer to work with Postman, a small collection is available at this link, which can be imported by clicking the Run in Postman button.