• Getting Started
    • About OData and References
    • Orchestrator URL
    • API References
    • Logical Resources and Metadata
    • Available Operations
    • Enumerated Types
    • Authenticating
    • Building API Requests
    • Permissions Per Endpoint
    • Response Codes
    • Health Check Endpoints
  • The Swagger Definition
  • Examples using the Orchestrator API
Banner background image
Orchestrator API Guide
Last updated Dec 12, 2023

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 your Account Logical Name and Tenant 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.

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.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.