UiPath Orchestrator
Subscribe
Product Lifecycle
Submit Product Feedback
{{user.name}}
Log In
The UiPath Orchestrator Guide
UiPath Orchestrator
UiPath Activities
UiPath Studio
UiPath Robot
UiPath Orchestrator
UiPath Cloud Platform
UiPath Release Notes
UiPath Integrations
UiPath StudioX Preview
UiPath Task Capture
UiPath Automation Hub
English
English
French
German
Japanese
Russian
v2019
v2016.2
deprecated
v2017.1
deprecated
v2018.1
deprecated
v2018.2
deprecated
v2018.3
deprecated
v2018.4
v2019-fastTrack
v2019
stable
v2020.4
beta
Home
UiPath Orchestrator Guide
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
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
Getting Started
Introduction
The User Interface
Dashboard
About Backward and Forward Compatibility
About the Activities Feeds
Best Practices
Automation Best Practices
Managing Large Deployments
Attended vs. Unattended Automation
Organization Modeling in Orchestrator
Administration of Modern Folders
Security Best Practices
Deployment and Configuration Considerations
Maintenance Considerations
Encrypting Web.Config Sections
Encrypting the SQL Server
Disabling HTTP Method Override Requests
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
About Authentication
Enabling Windows 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
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
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 Tenants
Configuring Tenant Settings
Field Descriptions for the Tenant Settings Page
Monitoring Menu
About Monitoring
Robots
Fields Descriptions for the Robots Page
Folder Robots Overview
Jobs
Job States
Managing Jobs
Field Descriptions for the Jobs Page
Jobs Overview
Queues
SLA
Logs
Managing Logs in Orchestrator
Field Descriptions
Logging Levels
Orchestrator Logs
Protecting Sensitive Information in Studio
Processes
About Processes
About Recording
Managing Processes
Field Descriptions
Triggers
About Triggers
Managing Triggers
Field Descriptions
Using Cron Expressions
Queues and Transactions
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
Managing 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
Folders
About Folders
Managing Folders
Field Descriptions
Key Features and Behavior
Using Modern Folders
Users
About Users
User Types
Managing Users
Field Descriptions
FAQ
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
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
Environments
About Environments
Managing Environments
Field Descriptions
Machines
About Machines
Managing Machines
Field Descriptions
Packages
About Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions
Profile
About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page
Credential Stores
About Credential Stores
CyberArk® Integration
Azure Key Vault Integration
Managing Credential Stores
Credential Store Plugins
Field Descriptions
Audit
About Audit
Field Descriptions
Alerts
About Alerts
About Email Alerts
Setting Up Email Alerts
Email Alerts Dashboard Description
Alert Severity Levels
Field Descriptions
Integrations
About Input and Output Parameters
Example of Using Input and Output Parameters
About Webhooks
Types of Events
Managing Webhooks
Field Descriptions
Insights
Installation
Hardware and Software Requirements
Enabling Table Grouping
Additional Configurations
About Insights
Insights Data Model
Default Dashboards
Managing Insights in Orchestrator
Field Descriptions
Insights Portal
About the Insights Portal
Field Descriptions for the Insights Portal
Managing Dashboards
Dashboard Ownership and Sharing
About Widgets
The Widget Editor
About Filters
Field Descriptions for the Filters Pane
Managing Alerts
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Insights Troubleshooting
Orchestrator Mobile App
About Push Notifications
About Favorite Processes
About Favorite Jobs
Support
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
Cloud
Consuming Cloud API
Getting Started
Introduction
The User Interface
Dashboard
View All 5
Best Practices
Automation Best Practices
Security Best Practices
Hardware and Software Requirements
Hardware Requirements
Software Requirements
Prerequisites for Installation
View All 4
Installation
About Installation
The Windows Installer
The Azure App Service Installation Script
View All 5
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
View All 5
Authentication
About Authentication
Enabling Windows Authentication
Setting Up Auto Login for Users Under an Active Directory Group
View All 7
Licensing
About Licensing
Activating Your License
Managing Your Licenses
View All 6
Other Configurations
Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
View All 4
System Administrator
About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
View All 7
Tenants
About Tenants
Configuring Tenant Settings
Field Descriptions for the Tenant Settings Page
Monitoring Menu
About Monitoring
Robots
Jobs
View All 5
Processes
About Processes
Managing Processes
Field Descriptions
Triggers
About Triggers
Managing Triggers
Field Descriptions
View All 4
Queues and Transactions
About Queues and Transactions
Managing Queues in Orchestrator
Managing Queues in Studio
View All 8
Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
View All 4
Tasks
About Tasks
Managing Tasks
Field Descriptions for the Tasks Page
View All 6
Folders
About Folders
Managing Folders
Field Descriptions
View All 5
Users
About Users
User Types
Managing Users
View All 5
Roles
About Roles
Default Roles
Managing Roles
View All 4
Robots
About Robots
Robot Statuses
Robots in Classic Folders
View All 4
Environments
About Environments
Managing Environments
Field Descriptions
Machines
About Machines
Managing Machines
Field Descriptions
Packages
About Packages
Managing Packages
Field Descriptions
Libraries
About Libraries
Managing Libraries
Field Descriptions
Profile
About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page
Credential Stores
About Credential Stores
Managing Credential Stores
Credential Store Plugins
View All 4
Audit
About Audit
Field Descriptions
Alerts
About Alerts
About Email Alerts
Alert Severity Levels
View All 4
Integrations
About Input and Output Parameters
About Webhooks
Managing Webhooks
View All 4
Insights
Installation
About Insights
Managing Insights in Orchestrator
View All 4
Insights Portal
About the Insights Portal
Managing Dashboards
Managing Alerts
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
View All 4
Orchestrator Mobile App
About Push Notifications
About Favorite Processes
About Favorite Jobs
Introduction to the Orchestrator API
About OData and References
API References
Logical Resources and Metadata
View All 4
The Swagger Definition
Managing Logical Resources
Building API Requests
Basics
Permissions Per Endpoint
Examples Using the Orchestrator API
Authenticating
Environments Requests
Robots Requests
View All 23
Cloud
Consuming Cloud API