- Getting started
- About OData and references
- Enumerated types
- Authenticating
- Building API Requests
- Permissions per endpoint
- Response codes
- Health Check Endpoints
- Authentication
- Authentication methods
- External Applications (OAuth)
- ROPC (not recommended)
- Swagger definition
- Read me
- Authorizing API calls in Swagger
- Managing logical resources
- 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
- Platform Management APIs
- Getting started
- About this guide
- Available resources
- API endpoint URL structure
- Enumeration List
- Scopes and permissions
- About scopes and permissions
- Platform Management scopes and permissions
- Platform Management APIs
- Audit Logs
- Get Audit Logs
- Download Audit Logs
- Groups
- Get All Groups
- Get Specific Group
- Delete Specific Group
- Create a New Local Group
- Update Group
- Robot Account
- Get All Robot Accounts
- Delete Robot Accounts
- Get Specific Robot Account
- Delete Specific Robot Account
- Create a New Robot Account
- Update Robot Account
- User
- Update User
- Delete Specific User
- Delete Users
- Settings
- Get Settings
- Update Settings
- Message Template
- Get Message Template
- Update a Message Template
- Get Message Template by Name
Orchestrator API guide
This guide is designed to help developers and integrators to navigate the UiPath® API, and learn about the available resources, authentication methods, and how to construct API requests.. By providing programmatic access to the functionality and data within the UiPath® platform, our API allows you to integrate our services seamlessly into your applications and systems.
Here, you will find an overview of the two core layers of our architecture that drive our APIs: organization-level services and tenant-scoped services. The organization-level services, such as Identity Server and Licensing, handle operations throughout the organization. Conversely, tenant-scoped services, such as Orchestrator or Data Service, cater to the specific requirements of individual tenants.