orchestrator
2023.4
false
- Getting started
- Authentication
- Swagger definition
- 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
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
- Platform Management APIs
- About this guide
- Available resources
- API endpoint URL structure
- Enumeration List
Orchestrator API guide
Last updated Feb 13, 2025
UiPath® exposes the following APIs:
-
Orchestrator API
-
Test Manager API
-
Data Service API
-
Platform Management API
-
Audit - retrieving and downloading audit logs in the organization.
-
Licensing - retrieving and allocating licenses.
-
Identity - creating, updating, or deleting accounts, and managing organization settings.
-
-
Marketplace API
-
AI Center API
-
Document Understanding API
-
Academy API
Note: The Platform Management APIs are undergoing a process of functional enhancement which may cause breaking changes to the endpoints.
That is why the current APIs are marked as Preview in our reference documentation.
-
GET /audit_/api/auditlogs—Retrieves the audit logs of your organization. -
GET /audit_/api/auditlogs/download—Downloads the audit logs of your organization.
-
GET identity_/api/Group/{partitionGlobalId}—Retrieves all local and built-in groups from the specified partition ID (either organization or tenant). -
GET /identity_/api/Group/{partitionGlobalId}/{groupId}—Retrieves the specified local or built-in group in the specified partition ID. -
POST /identity_/api/Group—Creates a new local group. -
PUT /identity_/api/Group/{groupId}—Updates a local group information. -
DELETE /identity_/api/Group/{partitionGlobalId}—Deletes all local groups from the specified partition ID (either organization or tenant). -
DELETE /identity_/api/Group/{partitionGlobalId}/{groupId}—Deletes the specified local group.
-
GET /identity_/api/RobotAccount/{partitionGlobalId}—Retrieves all robot accounts in the specified partition ID (either organization or tenant). -
GET /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}—Retrieves the specified robot account in the specified partition ID. -
POST /identity_/api/RobotAccount—Creates a new robot account. -
PUT /identity_/api/RobotAccount/{robotAccountId}—Updates the specified robot account information. -
DELETE /identity_/api/RobotAccount/{partitionGlobalId}/{robotAccountId}—Deletes the specified robot account. -
DELETE /identity_/api/RobotAccount/{partitionGlobalId}—Deletes all robot accounts in the specified partition ID.
-
GET /identity_/api/MessageTemplate—Retrieves a message template using the provided filter. -
GET /identity_/api/MessageTemplate/{templateId}—Retrieves the specified message template. -
PUT /identity_/api/MessageTemplate/{templateId}—Updates the specified message template.
-
GET /identity_/api/Setting—Retrieves an application settings based on a list of keys for a specific tenant. -
PUT /identity_/api/Setting—Updates or creates new settings in a specific tenant.
-
GET /identity_/api/User/{userId}—Retrieves information about the specified user. -
POST /identity_/api/User/{userId}/changepassword—Updates the password for the specified user. -
PUT /identity_/api/User/{userId}—Updates the specifid user information. -
DELETE /identity_/api/User—Deletes all users. -
DELETE /identity_/api/User/{userId}—Deletes the specified user.
GET /lease_/api/account/{accountId}/user-license/group/{groupId}—Retrieves a list of all available user licenses for creating or editing a group.PUT /—Allocates or updates a group rule.lease_/api/account/{accountId}/user-license/group/{groupId}
