- Getting Started
- The Swagger Definition
- Examples using the Orchestrator API
- 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
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
/swagger/index.html
suffix to the URL. For example,https://cloud.uipath.com/[AccountLogicalName]/[TenantName]/swagger/index.html
.Find yourAccount Logical Name
andTenant Name
in the API Access page of your Automation Cloud account.Note: Please note that if you are using Automation Cloud, all requests to Orchestrator endpoints should include/[AccountLogicalName]/[TenantName]/
.
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.