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
v2019
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
2019.10.23
2019.10.22
2019.10.21
2019.10.20
2019.10.19
2019.10.18
2019.10.17
2019.10.16
2019.10.15
2019.10.14
Getting Started
Introduction
The User Interface
Logging in to Orchestrator
Resetting your password
Dashboard
About Backward and Forward Compatibility
Activities Feeds
Best practices
Organization Modeling in Orchestrator
Managing Large Deployments
Automation Best Practices
Attended vs. Unattended Automation
Security Best Practices
Deployment and Configuration Considerations
Encrypting Web.Config Sections
Encrypting the SQL Server
Disabling HTTP Method Override Requests
Performance Best Practices
Maintenance Considerations
Hardware and Software Requirements
Hardware Requirements
Software Requirements
Prerequisites for Installation
Configuring the Firewall
Finding the .NET Framework Version
Creating an Index Pattern to Connect to Elasticsearch
Server Roles and Features
Using a Certificate for the HTTPS Protocol
About Deployment
Web Server on a Single Machine
Multi-Node Deployment
High Availability
Disaster Recovery - Active/Passive
Disaster Recovery - Two Active Data Centers
Deployment in the Cloud
Installation
About Installation
The Windows Installer
Command Line Parameters
The Azure App Service Installation Script
Publish-Orchestrator.ps1 Parameters
AWS Deployment
Creating AWS Access Keys
Installing Terraform
Web.Config
High Availability Add-On
Hardware and Software Requirements
Installation
Updating and Migrating
About Updating and Migrating
Updating Using the Windows Installer
Updating Using the Azure Script
Migrating Elasticsearch Indices
Backup and Restore
Orchestrator Backup and Restore
Backup Web.config and NuGet Packages
Insights Backup and Restore
Authentication
Configuring the Active Directory integration
Configuring SSO: SAML 2.0
ADFS Authentication
Google Authentication
OKTA Authentication
PingOne Authentication
Custom Mapping
Self-Signed Certificates
Private key certificates
Configuring SSO: Azure Active Directory
SmartCard Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Configuring the SMTP server
Changing the Windows Authentication Protocol
Other Configurations
Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
GZIP Compression
System Administrator
About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
Field Descriptions for the Host Audit Page
Field Descriptions for the Host Settings Page
Field Descriptions for the Admin Profile Page
Maintenance Mode
Tenants
About the Tenant Context
Settings
Field Descriptions for the Tenant Settings Page
Folders
About Folders
Managing Folders
Field Descriptions
Classic folders vs modern folders
Migrating from Classic Folders to Modern Folders
Administration of Modern Folders
Environments
About Environments
Managing Environments
Field Descriptions
Users
About Users
User Types
Managing Users
Field Descriptions
FAQ
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
Machines
Machines
Managing Machines
Field Descriptions
Packages
Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions
Audit
Audit
Field Descriptions
Credential Stores
Credential Stores
Managing Credential Stores
CyberArk® Integration
Azure Key Vault Integration
Credential Store Plugins
Field Descriptions
Licensing
About Licensing
Activating Your License
Managing Your Licenses
Field Descriptions for the License Page
Field Descriptions for the Attended and Studio Pages
Field Descriptions for the Unattended and NonProduction Pages
Alerts
Alerts
Alert Emails
Setting Up Alert Emails
Alert Emails Dashboard Description
Alert Severity Levels
Field Descriptions
Monitoring Menu
About Monitoring
Robots
Fields Descriptions for the Robots Page
Folder Robots Overview
Jobs
Jobs Overview
Managing Jobs
Field Descriptions for the Jobs Page
Job States
Queues
SLA
Logs
Managing Logs in Orchestrator
Logging Levels
Field Descriptions
Orchestrator Logs
Protecting Sensitive Information in Studio
Robots
About Robots
Robot Statuses
Robots in Classic Folders
Managing Robots
Connecting Robots to Orchestrator
How the Connection Between the Robot and Orchestrator Works
Storing Robot Credentials in CyberArk
Field Descriptions
Robots in Modern Folders
Processes
About Processes
Managing Processes
Field Descriptions
About Recording
Triggers
About Triggers
Managing Triggers
Field Descriptions
Using Cron Expressions
Queues
About Queues and Transactions
Queue Item Statuses
Business Exception vs Application Exception
Studio Activities Used with Queues
Managing Queues in Orchestrator
Managing Queues in Studio
Managing Transactions
Editing Transactions
Review Requests
Field Descriptions for Queues
Field Descriptions for Transactions
Field Descriptions for the Transactions .csv File
Field Descriptions for Review Requests
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Field Descriptions
Tasks
About Tasks
Managing Tasks
Field Descriptions for the Tasks Page
About Task Catalogs
Managing Task Catalogs
Field Descriptions for the Task Catalogs Page
Profile
About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page
Integrations
About Input and Output Arguments
Example of Using Input and Output Arguments
Webhooks
Types of Events
Managing Webhooks
Field Descriptions
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues
Release notes
2019.10.23
2019.10.22
2019.10.21
2019.10.20
2019.10.19
2019.10.18
2019.10.17
2019.10.16
2019.10.15
2019.10.14
Getting Started
Introduction
The User Interface
Logging in to Orchestrator
Resetting your password
Dashboard
About Backward and Forward Compatibility
Activities Feeds
Best practices
Organization Modeling in Orchestrator
Managing Large Deployments
Automation Best Practices
Attended vs. Unattended Automation
Security Best Practices
Deployment and Configuration Considerations
Encrypting Web.Config Sections
Encrypting the SQL Server
Disabling HTTP Method Override Requests
Performance Best Practices
Maintenance Considerations
Hardware and Software Requirements
Hardware Requirements
Software Requirements
Prerequisites for Installation
Configuring the Firewall
Finding the .NET Framework Version
Creating an Index Pattern to Connect to Elasticsearch
Server Roles and Features
Using a Certificate for the HTTPS Protocol
About Deployment
Web Server on a Single Machine
Multi-Node Deployment
High Availability
Disaster Recovery - Active/Passive
Disaster Recovery - Two Active Data Centers
Deployment in the Cloud
Installation
About Installation
The Windows Installer
Command Line Parameters
The Azure App Service Installation Script
Publish-Orchestrator.ps1 Parameters
AWS Deployment
Creating AWS Access Keys
Installing Terraform
Web.Config
High Availability Add-On
Hardware and Software Requirements
Installation
Updating and Migrating
About Updating and Migrating
Updating Using the Windows Installer
Updating Using the Azure Script
Migrating Elasticsearch Indices
Backup and Restore
Orchestrator Backup and Restore
Backup Web.config and NuGet Packages
Insights Backup and Restore
Authentication
Configuring the Active Directory integration
Configuring SSO: SAML 2.0
ADFS Authentication
Google Authentication
OKTA Authentication
PingOne Authentication
Custom Mapping
Self-Signed Certificates
Private key certificates
Configuring SSO: Azure Active Directory
SmartCard Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Configuring the SMTP server
Changing the Windows Authentication Protocol
Other Configurations
Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
GZIP Compression
System Administrator
About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
Field Descriptions for the Host Audit Page
Field Descriptions for the Host Settings Page
Field Descriptions for the Admin Profile Page
Maintenance Mode
Tenants
About the Tenant Context
Settings
Field Descriptions for the Tenant Settings Page
Folders
About Folders
Managing Folders
Field Descriptions
Classic folders vs modern folders
Migrating from Classic Folders to Modern Folders
Administration of Modern Folders
Environments
About Environments
Managing Environments
Field Descriptions
Users
About Users
User Types
Managing Users
Field Descriptions
FAQ
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
Machines
Machines
Managing Machines
Field Descriptions
Packages
Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions
Audit
Audit
Field Descriptions
Credential Stores
Credential Stores
Managing Credential Stores
CyberArk® Integration
Azure Key Vault Integration
Credential Store Plugins
Field Descriptions
Licensing
About Licensing
Activating Your License
Managing Your Licenses
Field Descriptions for the License Page
Field Descriptions for the Attended and Studio Pages
Field Descriptions for the Unattended and NonProduction Pages
Alerts
Alerts
Alert Emails
Setting Up Alert Emails
Alert Emails Dashboard Description
Alert Severity Levels
Field Descriptions
Monitoring Menu
About Monitoring
Robots
Fields Descriptions for the Robots Page
Folder Robots Overview
Jobs
Jobs Overview
Managing Jobs
Field Descriptions for the Jobs Page
Job States
Queues
SLA
Logs
Managing Logs in Orchestrator
Logging Levels
Field Descriptions
Orchestrator Logs
Protecting Sensitive Information in Studio
Robots
About Robots
Robot Statuses
Robots in Classic Folders
Managing Robots
Connecting Robots to Orchestrator
How the Connection Between the Robot and Orchestrator Works
Storing Robot Credentials in CyberArk
Field Descriptions
Robots in Modern Folders
Processes
About Processes
Managing Processes
Field Descriptions
About Recording
Triggers
About Triggers
Managing Triggers
Field Descriptions
Using Cron Expressions
Queues
About Queues and Transactions
Queue Item Statuses
Business Exception vs Application Exception
Studio Activities Used with Queues
Managing Queues in Orchestrator
Managing Queues in Studio
Managing Transactions
Editing Transactions
Review Requests
Field Descriptions for Queues
Field Descriptions for Transactions
Field Descriptions for the Transactions .csv File
Field Descriptions for Review Requests
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Field Descriptions
Tasks
About Tasks
Managing Tasks
Field Descriptions for the Tasks Page
About Task Catalogs
Managing Task Catalogs
Field Descriptions for the Task Catalogs Page
Profile
About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page
Integrations
About Input and Output Arguments
Example of Using Input and Output Arguments
Webhooks
Types of Events
Managing Webhooks
Field Descriptions
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues
Introduction to the Orchestrator API
About OData and References
API References
Logical Resources and Metadata
Available Operations
The Swagger Definition
Managing Logical Resources
Building API Requests
Basics
Permissions Per Endpoint
Examples Using the Orchestrator API
Authenticating
Environments Requests
Robots Requests
Retrieving License Information
Packages Requests
Processes Requests
Libraries Requests
Jobs Requests
Triggers Requests
Transaction Requests
Assets Requests
Settings Requests
Users Requests
Roles Requests
Permissions Requests
License Requests
Tenants Requests
Webhooks Requests
Folders Requests
Calendars Requests
Tasks Requests
Task Catalogs Requests
Task Forms Requests
Hey!
These docs are for version 2019, which is no longer officially supported. Click here for the latest version, 2022.10!