API References

Accessing the Swagger File

The Orchestrator API Swagger definition can be accessed as follows, depending on your deployment type:

• on-premise - append /swagger/index.html to your on-premises Orchestrator URL. For example, https://myOrchestrator.com/swagger/index.html.

• Automation Cloud - append the organization and tenant name, as well as orchestrator_/swagger/index.html to the cloud base URL. For example, https://cloud.uipath.com/{organization_name}/{tenant_name}/orchestrator_/swagger/index.html.

  Find your {organization_name} and {tenant_name} in the API Access page of your Automation Cloud account.

• Automation Suite - append the organization and tenant name, as well as orchestrator_/swagger/index.html to your Automation Suite base 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 be https://myasuite.westeurope.cloudapp.azure.com/docs/DefaultTenant/orchestrator_/swagger/index.html.

  Note:

  Please note that if you are using Automation Cloud, all requests to Orchestrator endpoints should include /{organization_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.

Orchestrator API - Postman Collection

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.

Note: Starting with 2018.1.3, in Swagger, you can use Windows Authentication to make requests. Previously, you could only make GET requests. POST/PUT/DELETE operations were not supported.