Subscribe
UiPath Orchestrator
Product Lifecycle
Submit Product Feedback
{{user.name}}
Log In
The UiPath Orchestrator Guide
UiPath Orchestrator
Overview
UiPath Action Center
UiPath Activities
UiPath AI Center™
UiPath Apps
UiPath Automation Cloud™
UiPath Automation Hub
UiPath Automation Ops
UiPath Automation Suite
UiPath Chatbot Connector - Preview
UiPath Connectors
UiPath Customer Portal
UiPath Data Service
UiPath Developer
UiPath Document Understanding
UiPath Insights
UiPath Installation and Upgrade
UiPath Integration Service
UiPath Marketplace
UiPath Orchestrator
UiPath Process Mining
UiPath Release Notes
UiPath Robot
UiPath Studio
UiPath StudioX
UiPath Task Capture
UiPath Task Mining
UiPath Test Suite
v0
v0
(Automation Cloud Orchestrator)
v2016.2
deprecated
v2017.1
deprecated
v2018.1
deprecated
v2018.2
deprecated
v2018.3
deprecated
v2018.4
deprecated
v2019-fastTrack
deprecated
v2019
deprecated
v2020.4
deprecated
v2020.10
v2021.4
deprecated
v2021.10
v2022.4
v2022.10
stable
Home
UiPath Orchestrator Guide
Recipes
UiPath Orchestrator API Guide
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
UiPath Orchestrator Guide
UiPath Orchestrator API Guide
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Release notes
2023
March 2023
February 2023
January 2023
2022
December 2022
November 2022
October 2022
September 2022
August 2022
July 2022
June 2022
May 2022
April 2022
March 2022
February 2022
January 2022
2021
December 2021
November 2021
October 2021
September 2021
August 2021
July 2021
June 2021
May 2021
April 2021
March 2021
February 2021
January 2021
2020
December 2020
November 2020
October 2020
September 2020
August 2020
July 2020
June 2020
May 2020
April 2020
March 2020
February 2020
January 2020
Before you begin
Compatibility matrix
Deprecation timeline
Regions & Instances
Getting started
Introduction
My profile
Robots
Robot statuses
Robot settings
Auto updating client components
Activities feeds
Time-to-live periods
Orchestrator outbound IP addresses
Best practices
Organization modeling in Orchestrator
Automation best practices
Optimizing unattended infrastructure using machine templates
Organizing resources with tags
Orchestrator read-only replica
Attended vs. unattended automation
Exporting grids in the background
Tenant
About the Tenant Context
Searching for resources in a tenant
Robots
Managing Robots
Connecting Robots to Orchestrator
Storing Robot Credentials in CyberArk
Storing unattended robot passwords in Azure Key Vault (read-only)
Storing unattended robot credentials in HashiCorp Vault (read-only)
Storing unattended robot credentials in AWS Secrets Manager (read only)
Deleting disconnected and unresponsive unattended sessions
Robot authentication
Robot authentication with client credentials
Folders
Managing Folders
Classic folders vs modern folders
Migrating from classic to modern folders
Administration of modern folders
Personal Workspaces
Managing Personal Workspaces
Classic folders removal
Monitoring
Unattended sessions
User sessions
License
Managing access and automation capabilities
Assigning roles
Managing roles
Default roles
Configuring access for accounts
Enabling users to run personal automations
Enabling users to run automations on unattended infrastructure via unattended robots
Configuring robot accounts to run unattended automations
Machines
Managing Machines
Assigning machine objects to folders
Configuring account-machine mappings
EDR protection status
Packages
Managing Packages
About Libraries
Managing Libraries
Audit
Credential Stores
Managing Credential Stores
CyberArk® CCP integration
Azure Key Vault integration
HashiCorp Vault integration
BeyondTrust integration
Thycotic Secret Server integration
AWS Secrets Manager integration
The Orchestrator Credentials Proxy
Managing credential proxies
Webhooks
Types of Events
Managing Webhooks
Licensing
Managing Your Licenses
Alerts
Configuring user alerts
Alert emails
Setting up alert emails
Settings
External applications
About authorizing external applications
Managing external applications
Configuring fine-grained access for external apps
Accessing UiPath resources using external applications
Cloud robots
Elastic robot orchestration
Automation Cloud™ robots - VM
Automation Cloud™ robots - Serverless
Configuring VPN for cloud robots
Folders context
About the Folders Context
Home
Automations
About Automations
Processes
About Processes
Managing processes
Managing package requirements
About Recording
[Preview] Live streaming and remote control
[Preview] Troubleshooting live streaming and remote control
Jobs
About Jobs
Managing Jobs
Job States
Working with long-running workflows
Running personal remote automations
Process data retention policy
Triggers
About Triggers
Time Triggers
Queue triggers
Event triggers
Managing triggers
Creating time triggers
Creating queue triggers
Creating event triggers
Managing calendars for non-working days
Using Cron Expressions
Folder packages
About Packages
Managing Packages
Logs
About Logs
Managing Logs in Orchestrator
Logging Levels
Monitoring
About Monitoring
Machines
Processes
Queues
Queues SLA
Queues
About Queues and Transactions
Queue Item Statuses
Business Exception vs Application Exception
Studio Activities Used with Queues
Queue item retention policy
Bulk uploading queue items using a CSV file
Managing Queues in Orchestrator
Managing Queues in Studio
Managing Transactions
Editing Transactions
Field Descriptions for the Transactions .csv File
Review Requests
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Storing assets in Azure Key Vault (read-only)
Storing assets in HashiCorp Vault (read-only)
Storing assets in AWS Secrets Manager (read only)
Storage buckets
About Storage Buckets
CORS/CSP Configuration
Managing Storage Buckets
Test Suite
Test Automation
Test Cases
Field Descriptions for the Test Cases Page
Test Sets
Field Descriptions for the Test Sets Page
Test Executions
Field Descriptions for the Test Executions Page
Test Schedules
Field Descriptions for the Test Schedules Page
Test Data Queues
Managing Test Data Queues in Orchestrator
Managing Test Data Queues in Studio
Field Descriptions for the Test Data Queues Page
Test Data Queue Activities
Identity Server
About Identity Server
Resource Catalog Service
About Resource Catalog Service
Authentication
About Authentication
SmartCard Authentication
Configuring the SMTP server
Integrations
About Input and Output Arguments
Example of Using Input and Output Arguments
Classic robots
Robots
Managing Robots
Robot Statuses
Setup Samples
Robot Settings
Environments
Managing Environments
Machines
Packages
Processes
Jobs
Triggers
Assets
Queues
Logs
Monitoring
Robots
Processes
Queues
Queues SLA
Troubleshooting
About Troubleshooting
Frequently Encountered Orchestrator Errors
Release notes
2023
March 2023
February 2023
January 2023
2022
December 2022
November 2022
October 2022
September 2022
August 2022
July 2022
June 2022
May 2022
April 2022
March 2022
February 2022
January 2022
2021
December 2021
November 2021
October 2021
September 2021
August 2021
July 2021
June 2021
May 2021
April 2021
March 2021
February 2021
January 2021
2020
December 2020
November 2020
October 2020
September 2020
August 2020
July 2020
June 2020
May 2020
April 2020
March 2020
February 2020
January 2020
Before you begin
Compatibility matrix
Deprecation timeline
Regions & Instances
Getting started
Introduction
My profile
Robots
Robot statuses
Robot settings
Auto updating client components
Activities feeds
Time-to-live periods
Orchestrator outbound IP addresses
Best practices
Organization modeling in Orchestrator
Automation best practices
Optimizing unattended infrastructure using machine templates
Organizing resources with tags
Orchestrator read-only replica
Attended vs. unattended automation
Exporting grids in the background
Tenant
About the Tenant Context
Searching for resources in a tenant
Robots
Managing Robots
Connecting Robots to Orchestrator
Storing Robot Credentials in CyberArk
Storing unattended robot passwords in Azure Key Vault (read-only)
Storing unattended robot credentials in HashiCorp Vault (read-only)
Storing unattended robot credentials in AWS Secrets Manager (read only)
Deleting disconnected and unresponsive unattended sessions
Robot authentication
Robot authentication with client credentials
Folders
Managing Folders
Classic folders vs modern folders
Migrating from classic to modern folders
Administration of modern folders
Personal Workspaces
Managing Personal Workspaces
Classic folders removal
Monitoring
Unattended sessions
User sessions
License
Managing access and automation capabilities
Assigning roles
Managing roles
Default roles
Configuring access for accounts
Enabling users to run personal automations
Enabling users to run automations on unattended infrastructure via unattended robots
Configuring robot accounts to run unattended automations
Machines
Managing Machines
Assigning machine objects to folders
Configuring account-machine mappings
EDR protection status
Packages
Managing Packages
About Libraries
Managing Libraries
Audit
Credential Stores
Managing Credential Stores
CyberArk® CCP integration
Azure Key Vault integration
HashiCorp Vault integration
BeyondTrust integration
Thycotic Secret Server integration
AWS Secrets Manager integration
The Orchestrator Credentials Proxy
Managing credential proxies
Webhooks
Types of Events
Managing Webhooks
Licensing
Managing Your Licenses
Alerts
Configuring user alerts
Alert emails
Setting up alert emails
Settings
External applications
About authorizing external applications
Managing external applications
Configuring fine-grained access for external apps
Accessing UiPath resources using external applications
Cloud robots
Elastic robot orchestration
Automation Cloud™ robots - VM
Automation Cloud™ robots - Serverless
Configuring VPN for cloud robots
Folders context
About the Folders Context
Home
Automations
About Automations
Processes
About Processes
Managing processes
Managing package requirements
About Recording
[Preview] Live streaming and remote control
[Preview] Troubleshooting live streaming and remote control
Jobs
About Jobs
Managing Jobs
Job States
Working with long-running workflows
Running personal remote automations
Process data retention policy
Triggers
About Triggers
Time Triggers
Queue triggers
Event triggers
Managing triggers
Creating time triggers
Creating queue triggers
Creating event triggers
Managing calendars for non-working days
Using Cron Expressions
Folder packages
About Packages
Managing Packages
Logs
About Logs
Managing Logs in Orchestrator
Logging Levels
Monitoring
About Monitoring
Machines
Processes
Queues
Queues SLA
Queues
About Queues and Transactions
Queue Item Statuses
Business Exception vs Application Exception
Studio Activities Used with Queues
Queue item retention policy
Bulk uploading queue items using a CSV file
Managing Queues in Orchestrator
Managing Queues in Studio
Managing Transactions
Editing Transactions
Field Descriptions for the Transactions .csv File
Review Requests
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Storing assets in Azure Key Vault (read-only)
Storing assets in HashiCorp Vault (read-only)
Storing assets in AWS Secrets Manager (read only)
Storage buckets
About Storage Buckets
CORS/CSP Configuration
Managing Storage Buckets
Test Suite
Test Automation
Test Cases
Field Descriptions for the Test Cases Page
Test Sets
Field Descriptions for the Test Sets Page
Test Executions
Field Descriptions for the Test Executions Page
Test Schedules
Field Descriptions for the Test Schedules Page
Test Data Queues
Managing Test Data Queues in Orchestrator
Managing Test Data Queues in Studio
Field Descriptions for the Test Data Queues Page
Test Data Queue Activities
Identity Server
About Identity Server
Resource Catalog Service
About Resource Catalog Service
Authentication
About Authentication
SmartCard Authentication
Configuring the SMTP server
Integrations
About Input and Output Arguments
Example of Using Input and Output Arguments
Classic robots
Robots
Managing Robots
Robot Statuses
Setup Samples
Robot Settings
Environments
Managing Environments
Machines
Packages
Processes
Jobs
Triggers
Assets
Queues
Logs
Monitoring
Robots
Processes
Queues
Queues SLA
Troubleshooting
About Troubleshooting
Frequently Encountered Orchestrator Errors
Getting Started
Read me
About OData and References
Orchestrator URL
API References
Logical Resources and Metadata
Available Operations
Enumerated Types
Consuming Cloud API
Building API Requests
Permissions Per Endpoint
Response Codes
The Swagger definition
Authorizing API calls in Swagger
Managing Logical Resources
Examples using the Orchestrator API
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
Process Data Retention Policy Requests
Queue items requests
Queue Retention Policy Requests
Robots Requests
Roles Requests
Schedules Requests
Settings Requests
Storage Buckets Requests
Tasks Requests
Task Catalogs Requests
Task Forms Requests
Tenants Requests
Transactions Requests
Users Requests
Webhooks Requests