openapi: 3.1.0
info:
title: UiPath Orchestrator API
description: >-
The UiPath Orchestrator API provides programmatic access to the core
automation management platform, enabling developers to manage robots, jobs,
processes, queues, assets, schedules, and more. Built on the OData protocol,
the API supports RESTful operations with filtering, sorting, and pagination
across all resources. It covers a broad set of resource categories including
folders, machines, users, roles, alerts, webhooks, and libraries, making it
suitable for enterprise automation governance and integration scenarios.
Authentication uses OAuth 2.0 tokens from the UiPath Identity Server, and
all endpoints are accessible under the tenant-scoped URL
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_.
version: '2024.10'
contact:
name: UiPath Support
url: https://support.uipath.com
termsOfService: https://www.uipath.com/legal/terms-of-use
externalDocs:
description: UiPath Orchestrator API Documentation
url: https://docs.uipath.com/orchestrator/automation-cloud/latest/api-guide/read-me
servers:
- url: https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_
description: UiPath Automation Cloud Orchestrator
variables:
organizationName:
default: your-org
description: The name of your UiPath organization
tenantName:
default: your-tenant
description: The name of your UiPath tenant
tags:
- name: Alerts
description: Retrieve and manage system and automation alerts
- name: Assets
description: Manage shared assets such as credentials, text values, integers, and boolean values
- name: Folders
description: Manage organizational folders for grouping automation resources
- name: Jobs
description: Manage automation job execution, including starting, stopping, and querying job state
- name: Machines
description: Manage machine templates and registered physical or virtual machines
- name: Packages
description: Manage automation package uploads and versions
- name: Processes
description: Manage automation processes (published packages deployed to folders)
- name: QueueItems
description: Manage individual queue transaction items and their processing state
- name: Queues
description: Manage transaction queues for distributing work items to robots
- name: Robots
description: Manage software robots registered with Orchestrator
- name: Roles
description: Manage roles and their associated permissions
- name: Schedules
description: Manage time-based and recurring triggers for automation processes
- name: StorageBuckets
description: Manage cloud storage buckets for storing automation artifacts
- name: Users
description: Manage users and their assignments within Orchestrator
- name: Webhooks
description: Manage webhook subscriptions for Orchestrator event notifications
security:
- bearerAuth: []
paths:
/odata/Jobs:
get:
operationId: listJobs
summary: UiPath List Jobs
description: >-
Retrieves a list of jobs in the current folder. Supports OData query
options including $filter, $orderby, $top, $skip, and $select to
control the result set. Jobs represent individual executions of
automation processes by robots.
tags:
- Jobs
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataOrderby'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
- $ref: '#/components/parameters/odataSelect'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: A list of jobs matching the query criteria
content:
application/json:
schema:
$ref: '#/components/schemas/ODataJobCollection'
examples:
listJobs200Example:
summary: Default listJobs 200 response
x-microcks-default: true
value:
'@odata.context': example-value
'@odata.count': 1
value:
- {}
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Jobs({key}):
get:
operationId: getJob
summary: UiPath Get a Job by ID
description: >-
Retrieves a single job by its unique integer identifier. Returns full
job details including state, start and end times, robot information,
and associated process.
tags:
- Jobs
parameters:
- $ref: '#/components/parameters/entityKey'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: The requested job
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
examples:
getJob200Example:
summary: Default getJob 200 response
x-microcks-default: true
value:
Id: 1
Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890
ReleaseName: example-value
ProcessVersion: example-value
State: Pending
Source: Manual
StartTime: '2026-01-15T10:30:00Z'
EndTime: '2026-01-15T10:30:00Z'
CreationTime: '2026-01-15T10:30:00Z'
Info: example-value
HostMachineName: example-value
Robot:
Id: {}
Name: {}
MachineName: {}
MachineId: {}
Version: {}
Type: {}
OrganizationUnitId: 1
InputArguments: example-value
OutputArguments: example-value
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs:
post:
operationId: startJobs
summary: UiPath Start Jobs
description: >-
Starts one or more automation jobs for a specified process. Allows
specifying the strategy for robot allocation (e.g., ModernJobsCount,
All, RobotIds), input arguments for the process, job priority, and
the target folder. Returns details of the created jobs.
tags:
- Jobs
parameters:
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartJobsRequest'
examples:
startJobsRequestExample:
summary: Default startJobs request
x-microcks-default: true
value:
startInfo:
ReleaseKey: {}
Strategy: {}
RobotIds: {}
NoOfRobots: {}
Source: {}
InputArguments: {}
JobPriority: {}
responses:
'201':
description: Jobs were successfully created and started
content:
application/json:
schema:
$ref: '#/components/schemas/ODataJobCollection'
examples:
startJobs201Example:
summary: Default startJobs 201 response
x-microcks-default: true
value:
'@odata.context': example-value
'@odata.count': 1
value:
- {}
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Jobs/UiPath.Server.Configuration.OData.StopJob:
post:
operationId: stopJob
summary: UiPath Stop a Job
description: >-
Sends a stop signal to a running job. The strategy can be SoftStop
(waits for the current activity to finish) or Kill (forcefully
terminates the job immediately). Requires the job ID.
tags:
- Jobs
parameters:
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopJobRequest'
examples:
stopJobRequestExample:
summary: Default stopJob request
x-microcks-default: true
value:
jobId: 1
strategy: SoftStop
responses:
'200':
description: Stop signal sent successfully
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Processes:
get:
operationId: listProcesses
summary: UiPath List Processes
description: >-
Retrieves a list of automation processes deployed in the current folder.
Each process represents a specific version of a published package
configured for execution. Supports OData filtering and pagination.
tags:
- Processes
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataOrderby'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: A list of processes
content:
application/json:
schema:
$ref: '#/components/schemas/ODataProcessCollection'
examples:
listProcesses200Example:
summary: Default listProcesses 200 response
x-microcks-default: true
value:
value:
- Id: {}
Name: {}
Key: {}
Description: {}
ProcessVersion: {}
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Robots:
get:
operationId: listRobots
summary: UiPath List Robots
description: >-
Retrieves a list of software robots registered with Orchestrator.
Each robot entry includes connection state, machine assignment, user
assignment, robot type, and licensing information. Supports OData
filtering and pagination.
tags:
- Robots
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataOrderby'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: A list of robots
content:
application/json:
schema:
$ref: '#/components/schemas/ODataRobotCollection'
examples:
listRobots200Example:
summary: Default listRobots 200 response
x-microcks-default: true
value:
value:
- Id: {}
Name: {}
MachineName: {}
Type: {}
IsConnected: {}
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/QueueDefinitions:
get:
operationId: listQueues
summary: UiPath List Queue Definitions
description: >-
Retrieves all queue definitions in the current folder. Queue definitions
describe named queues used for distributing transaction items to robots,
including retry settings, unique reference enforcement, and SLA
configurations.
tags:
- Queues
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: A list of queue definitions
content:
application/json:
schema:
$ref: '#/components/schemas/ODataQueueDefinitionCollection'
examples:
listQueues200Example:
summary: Default listQueues 200 response
x-microcks-default: true
value:
value:
- {}
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createQueue
summary: UiPath Create a Queue Definition
description: >-
Creates a new queue definition in the current folder. The queue
definition specifies the queue name, maximum retry count, whether
to accept only unique references, and enforcement settings.
tags:
- Queues
parameters:
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueueDefinition'
examples:
createQueueRequestExample:
summary: Default createQueue request
x-microcks-default: true
value:
Id: 1
Name: example-value
Description: example-value
MaxNumberOfRetries: 1
AcceptAutomaticallyRetry: true
EnforceUniqueReference: true
OrganizationUnitId: 1
responses:
'201':
description: Queue definition created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/QueueDefinition'
examples:
createQueue201Example:
summary: Default createQueue 201 response
x-microcks-default: true
value:
Id: 1
Name: example-value
Description: example-value
MaxNumberOfRetries: 1
AcceptAutomaticallyRetry: true
EnforceUniqueReference: true
OrganizationUnitId: 1
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/QueueItems:
get:
operationId: listQueueItems
summary: UiPath List Queue Items
description: >-
Retrieves a list of queue transaction items. Items can be filtered by
queue name, status, review status, and priority. Supports OData
filtering, ordering, and pagination.
tags:
- QueueItems
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataOrderby'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: A list of queue items
content:
application/json:
schema:
$ref: '#/components/schemas/ODataQueueItemCollection'
examples:
listQueueItems200Example:
summary: Default listQueueItems 200 response
x-microcks-default: true
value:
value:
- {}
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: addQueueItem
summary: UiPath Add a Queue Item
description: >-
Adds a new transaction item to a specified queue. The item can include
specific content (custom key-value data), priority level, deadline,
postpone time, and a unique reference string. Returns the created
queue item with its assigned ID and key.
tags:
- QueueItems
parameters:
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddQueueItemRequest'
examples:
addQueueItemRequestExample:
summary: Default addQueueItem request
x-microcks-default: true
value:
itemData:
Name: {}
Priority: {}
SpecificContent: {}
Reference: {}
DueDate: {}
PostponeDate: {}
responses:
'201':
description: Queue item added successfully
content:
application/json:
schema:
$ref: '#/components/schemas/QueueItem'
examples:
addQueueItem201Example:
summary: Default addQueueItem 201 response
x-microcks-default: true
value:
Id: 1
Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890
QueueDefinitionId: 1
Status: New
ReviewStatus: None
Priority: Low
Reference: example-value
SpecificContent: {}
Output: {}
CreationTime: '2026-01-15T10:30:00Z'
StartProcessing: '2026-01-15T10:30:00Z'
EndProcessing: '2026-01-15T10:30:00Z'
RetryNumber: 1
DueDate: '2026-01-15T10:30:00Z'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Assets:
get:
operationId: listAssets
summary: UiPath List Assets
description: >-
Retrieves a list of assets defined in the current folder. Assets store
shared values such as credentials, text, integers, and booleans that
can be consumed by automation processes. Supports OData filtering and
pagination.
tags:
- Assets
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: A list of assets
content:
application/json:
schema:
$ref: '#/components/schemas/ODataAssetCollection'
examples:
listAssets200Example:
summary: Default listAssets 200 response
x-microcks-default: true
value:
value:
- {}
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createAsset
summary: UiPath Create an Asset
description: >-
Creates a new asset in the current folder. The asset type determines
the kind of value stored: Text, Integer, Bool, or Credential. Credential
assets store username and password pairs securely.
tags:
- Assets
parameters:
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
examples:
createAssetRequestExample:
summary: Default createAsset request
x-microcks-default: true
value:
Id: 1
Name: example-value
ValueType: Text
StringValue: example-value
IntValue: 1
BoolValue: true
CredentialUsername: example-value
CredentialPassword: example-value
Description: example-value
OrganizationUnitId: 1
responses:
'201':
description: Asset created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
examples:
createAsset201Example:
summary: Default createAsset 201 response
x-microcks-default: true
value:
Id: 1
Name: example-value
ValueType: Text
StringValue: example-value
IntValue: 1
BoolValue: true
CredentialUsername: example-value
CredentialPassword: example-value
Description: example-value
OrganizationUnitId: 1
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Assets({key}):
get:
operationId: getAsset
summary: UiPath Get an Asset by ID
description: >-
Retrieves a single asset by its unique integer identifier. Returns
the full asset definition including type, value, and folder scope.
tags:
- Assets
parameters:
- $ref: '#/components/parameters/entityKey'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: The requested asset
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
examples:
getAsset200Example:
summary: Default getAsset 200 response
x-microcks-default: true
value:
Id: 1
Name: example-value
ValueType: Text
StringValue: example-value
IntValue: 1
BoolValue: true
CredentialUsername: example-value
CredentialPassword: example-value
Description: example-value
OrganizationUnitId: 1
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: updateAsset
summary: UiPath Update an Asset
description: >-
Updates an existing asset by its unique integer identifier. The
full asset object must be provided in the request body with the
updated values.
tags:
- Assets
parameters:
- $ref: '#/components/parameters/entityKey'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
examples:
updateAssetRequestExample:
summary: Default updateAsset request
x-microcks-default: true
value:
Id: 1
Name: example-value
ValueType: Text
StringValue: example-value
IntValue: 1
BoolValue: true
CredentialUsername: example-value
CredentialPassword: example-value
Description: example-value
OrganizationUnitId: 1
responses:
'200':
description: Asset updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
examples:
updateAsset200Example:
summary: Default updateAsset 200 response
x-microcks-default: true
value:
Id: 1
Name: example-value
ValueType: Text
StringValue: example-value
IntValue: 1
BoolValue: true
CredentialUsername: example-value
CredentialPassword: example-value
Description: example-value
OrganizationUnitId: 1
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteAsset
summary: UiPath Delete an Asset
description: >-
Permanently deletes an asset from the current folder by its unique
integer identifier. This action cannot be undone. Processes that
reference this asset will fail until the asset is recreated.
tags:
- Assets
parameters:
- $ref: '#/components/parameters/entityKey'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'204':
description: Asset deleted successfully
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/ProcessSchedules:
get:
operationId: listSchedules
summary: UiPath List Process Schedules
description: >-
Retrieves a list of time-based triggers configured for automation
processes. Each schedule defines when and how often a process should
run, along with the target robots and input arguments.
tags:
- Schedules
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: A list of process schedules
content:
application/json:
schema:
$ref: '#/components/schemas/ODataScheduleCollection'
examples:
listSchedules200Example:
summary: Default listSchedules 200 response
x-microcks-default: true
value:
value:
- Id: {}
Name: {}
ReleaseId: {}
Enabled: {}
StartProcessCron: {}
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Folders:
get:
operationId: listFolders
summary: UiPath List Folders
description: >-
Retrieves a list of organizational folders accessible to the
authenticated user. Folders group automation resources such as
processes, robots, assets, and queues. Each folder has a unique
ID used in the X-UIPATH-OrganizationUnitId request header.
tags:
- Folders
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
responses:
'200':
description: A list of folders
content:
application/json:
schema:
$ref: '#/components/schemas/ODataFolderCollection'
examples:
listFolders200Example:
summary: Default listFolders 200 response
x-microcks-default: true
value:
value:
- Id: {}
Key: {}
DisplayName: {}
FullyQualifiedName: {}
FolderType: {}
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/odata/Machines:
get:
operationId: listMachines
summary: UiPath List Machines
description: >-
Retrieves a list of machine templates and registered machines.
Machine templates define the number of runtimes available for
cloud robots, while standard machines represent physical or
virtual machines where Unattended Robot is installed.
tags:
- Machines
parameters:
- $ref: '#/components/parameters/odataFilter'
example: example-value
- $ref: '#/components/parameters/odataTop'
example: example-value
- $ref: '#/components/parameters/odataSkip'
example: example-value
- $ref: '#/components/parameters/xUiPathOrganizationUnitId'
example: example-value
responses:
'200':
description: A list of machines
content:
application/json:
schema:
$ref: '#/components/schemas/ODataMachineCollection'
examples:
listMachines200Example:
summary: Default listMachines 200 response
x-microcks-default: true
value:
value:
- Id: {}
Name: {}
Type: {}
LicenseKey: {}
'401':
$ref: '#/components/responses/Unauthorized'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/od
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/openapi/uipath-orchestrator-openapi.yml