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-fastTrack
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.4.2
2019.4.6
2019.4.4
Getting Started
Introduction
The User Interface
Dashboard
Automation Best Practices
About Backward and Forward Compatibility
About the Activities Feeds
Installation
About Installation
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
The Windows Installer
Command Line Parameters
Configure-PlatformNode.ps1 Parameters
The Azure App Service Installation Script
Redis Installation
Redis Sentinel Configuration
Physical Deployment Options
About Physical Deployment
Web Server on a Single Machine
High Availability
Deployment in the Cloud
Disaster Recovery - Active/Passive
Disaster Recovery - Two Active Data Centers
Web.Config File
App Settings
Logging Configuration
Updating and Migrating
About Updating and Migrating
Updating Using the Windows Installer
Updating Using the Azure Script
Migrating Elasticsearch Indices
Hardware and Software Requirements
Hardware Requirements
Software Requirements
Security Best Practices
Deployment and Configuration Considerations
Maintenance Considerations
Encrypting Web.config Sections
Encrypting the Connection to an SQL Server
Encrypting the SQL Server
Disabling HTTP Method Override Requests
Other Configurations
Enabling Windows Authentication
Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
Tableau Integration
GZIP Compression
Licensing
About Licensing
Activating and Uploading Your License
Managing Your Licenses
Updating Your License
Field Descriptions for the License Page
Field Descriptions for the Attended and Development Pages
Field Descriptions for the Unattended and NonProduction Pages
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 System Admin Profile
Tenants
About Tenants
About Tenant Settings
Field Descriptions for the Tenant Settings Page
Authentication
About Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Resetting Your Password Through Your Email
Configuring the SMTP server
Changing the Windows Authentication Protocol
SmartCard Authentication
Single Sign-On Authentication Using SAML 2.0
ADFS Authentication
Google Authentication
OKTA Authentication
Custom Mapping
Self-Signed Certificates
Setting Orchestrator to Use a Private Key Certificate
Users
About Users
Managing Users
Importing Users from the Active Directory
Field Descriptions for the Users Page
Field Descriptions for the Profile Page
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
Monitoring
About Monitoring
Monitoring Robots
Monitoring Queues
Monitoring Jobs
Robots
About Robots
Robot Statuses
Connecting Robots to Orchestrator
Managing Robots
How the Connection Between the Robot and Orchestrator Works
Storing Robot Credentials in CyberArk
Field Descriptions
Environments
About Environments
Managing Environments
Field Descriptions
Machines
About Machines
Managing Machines
Field Descriptions for the Machines Page
Packages
About Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Processes
About Processes
About Recording
Managing Processes
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions for the Libraries Page
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Field Descriptions
Queues and Transactions
About Queues and Transactions
Studio Activities Used with Queues
Queue Item Statuses
Business Exception vs Application Exception
Managing Queues in Orchestrator
Managing Transactions
Editing Transactions
Managing Queues in Studio
Field Descriptions for Queues
Field Descriptions for Transactions
Field Descriptions for the Transactions .csv File
Field Descriptions for Review Requests
Managing Review Requests
Jobs
About Jobs
Job States
Managing Jobs
How Starting a Job Works
Field Descriptions
Integrations
About Input and Output Parameters
Example of Using Input and Output Parameters
Schedules
About Schedules
Managing Schedules
Field Descriptions
Using Cron Expressions
Logging
About Logs
Orchestrator Logs
Managing Logs in Orchestrator
Field Descriptions
Logging Levels
Protecting Sensitive Information in Studio
Alerts
About Alerts
About Email Alerts
Setting Up Email Alerts
Email Alerts Dashboard Description
Alert Severity Levels
Field Descriptions
Audit
About Audit
Field Descriptions
Webhooks
About Webhooks
Types of Events
Managing Webhooks
Field Descriptions
Organization Units
About Organization Units
Managing Organization Units
Field Descriptions
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Orchestrator Mobile App
About Push Notifications
About Favorite Processes
Release Notes
2019.4.2
2019.4.6
2019.4.4
Getting Started
Introduction
The User Interface
Dashboard
Automation Best Practices
About Backward and Forward Compatibility
About the Activities Feeds
Installation
About Installation
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
The Windows Installer
Command Line Parameters
Configure-PlatformNode.ps1 Parameters
The Azure App Service Installation Script
Redis Installation
Redis Sentinel Configuration
Physical Deployment Options
About Physical Deployment
Web Server on a Single Machine
High Availability
Deployment in the Cloud
Disaster Recovery - Active/Passive
Disaster Recovery - Two Active Data Centers
Web.Config File
App Settings
Logging Configuration
Updating and Migrating
About Updating and Migrating
Updating Using the Windows Installer
Updating Using the Azure Script
Migrating Elasticsearch Indices
Hardware and Software Requirements
Hardware Requirements
Software Requirements
Security Best Practices
Deployment and Configuration Considerations
Maintenance Considerations
Encrypting Web.config Sections
Encrypting the Connection to an SQL Server
Encrypting the SQL Server
Disabling HTTP Method Override Requests
Other Configurations
Enabling Windows Authentication
Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
Tableau Integration
GZIP Compression
Licensing
About Licensing
Activating and Uploading Your License
Managing Your Licenses
Updating Your License
Field Descriptions for the License Page
Field Descriptions for the Attended and Development Pages
Field Descriptions for the Unattended and NonProduction Pages
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 System Admin Profile
Tenants
About Tenants
About Tenant Settings
Field Descriptions for the Tenant Settings Page
Authentication
About Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Resetting Your Password Through Your Email
Configuring the SMTP server
Changing the Windows Authentication Protocol
SmartCard Authentication
Single Sign-On Authentication Using SAML 2.0
ADFS Authentication
Google Authentication
OKTA Authentication
Custom Mapping
Self-Signed Certificates
Setting Orchestrator to Use a Private Key Certificate
Users
About Users
Managing Users
Importing Users from the Active Directory
Field Descriptions for the Users Page
Field Descriptions for the Profile Page
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
Monitoring
About Monitoring
Monitoring Robots
Monitoring Queues
Monitoring Jobs
Robots
About Robots
Robot Statuses
Connecting Robots to Orchestrator
Managing Robots
How the Connection Between the Robot and Orchestrator Works
Storing Robot Credentials in CyberArk
Field Descriptions
Environments
About Environments
Managing Environments
Field Descriptions
Machines
About Machines
Managing Machines
Field Descriptions for the Machines Page
Packages
About Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Processes
About Processes
About Recording
Managing Processes
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions for the Libraries Page
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Field Descriptions
Queues and Transactions
About Queues and Transactions
Studio Activities Used with Queues
Queue Item Statuses
Business Exception vs Application Exception
Managing Queues in Orchestrator
Managing Transactions
Editing Transactions
Managing Queues in Studio
Field Descriptions for Queues
Field Descriptions for Transactions
Field Descriptions for the Transactions .csv File
Field Descriptions for Review Requests
Managing Review Requests
Jobs
About Jobs
Job States
Managing Jobs
How Starting a Job Works
Field Descriptions
Integrations
About Input and Output Parameters
Example of Using Input and Output Parameters
Schedules
About Schedules
Managing Schedules
Field Descriptions
Using Cron Expressions
Logging
About Logs
Orchestrator Logs
Managing Logs in Orchestrator
Field Descriptions
Logging Levels
Protecting Sensitive Information in Studio
Alerts
About Alerts
About Email Alerts
Setting Up Email Alerts
Email Alerts Dashboard Description
Alert Severity Levels
Field Descriptions
Audit
About Audit
Field Descriptions
Webhooks
About Webhooks
Types of Events
Managing Webhooks
Field Descriptions
Organization Units
About Organization Units
Managing Organization Units
Field Descriptions
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Orchestrator Mobile App
About Push Notifications
About Favorite Processes
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
Authenticating
Permissions Per Endpoint
Response Codes
Examples Using the Orchestrator API
Environments Requests
Robots Requests
Retrieving License Information
Packages Requests
Processes Requests
Libraries Requests
Jobs Requests
Schedules Requests
Transaction Requests
Assets Requests
Settings Requests
Users Requests
Roles Requests
Permissions Requests
License Requests
Tenants Requests
Webhooks Requests
Hey!
These docs are for version 2019-fastTrack, which is no longer officially supported. Click here for the latest version, 2022.10!