Subscribe
UiPath Orchestrator
Product Lifecycle
Submit Product Feedback
{{user.name}}
Log In
The UiPath Orchestrator Guide
UiPath Orchestrator
UiPath Activities
UiPath Studio
UiPath Robot
UiPath Orchestrator
UiPath Automation Cloud
UiPath Release Notes
UiPath Marketplace
UiPath StudioX
UiPath Task Capture
UiPath Automation Hub
UiPath Task Mining - Preview
UiPath Installation and Upgrade
UiPath AI Fabric / AI Center
UiPath Test Suite
UiPath Insights
UiPath Chatbot Connector - Preview
UiPath Process Mining
UiPath Developer
UiPath Data Service
UiPath Action Center
UiPath Apps
UiPath Automation Ops - Preview
v2018.1
v0
(Automation Cloud Orchestrator)
v2016.2
deprecated
v2017.1
deprecated
v2018.1
deprecated
v2018.2
deprecated
v2018.3
deprecated
v2018.4
v2019-fastTrack
deprecated
v2019
v2020.4
v2020.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
Getting Started
Introduction
The User Interface
Dashboard
Installation
About Installation
Prerequisites for Installation
The Windows Installer
Installation Using Scripts
Cluster Installation
The Azure App Service Installation Script
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
Command Line Parameters
Web.Config File
App Settings
Logging Configuration
Updating and Migrating
About Updating and Migrating to v2018
Updating Using the Scripts
Updating Using the Windows Installer
Updating Using the Azure Script
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
Other Configurations
Enabling Windows Authentication
Increasing The Size Limit of Package Files
Licensing
About Licensing
Activating and Uploading Your License
System Administrator
About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
Field Descriptions for the Settings Page
Field Descriptions System Admin Profile
Field Descriptions for the Audit Page
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
Users
About Users
Managing Users
Importing Users from the Active Directory
Field Descriptions
Profile Page
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
Robots
About Robots
Robot Statuses
Connecting Robots to Orchestrator
Managing Robots
Field Descriptions
How the Connection Between the Robot and Orchestrator Works
Storing Robot Credentials in CyberArk
Environments
About Environments
Managing Environments
Field Descriptions
Packages
About Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Processes
About Processes
About the Activities Feed
Managing Processes
Field Descriptions
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
Managing Queues in Studio
Field Descriptions for Queues
Field Descriptions for Transactions
Field Descriptions for the Transactions .csv File
Jobs
About Jobs
Job States
Managing Jobs
How Starting a Job Works
Field Descriptions
Schedules
About Schedules
Managing Schedules
Field Descriptions
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
Organization Units
About Organization Units
Managing Organization Units
Field Descriptions
Physical Deployment Options
About Physical Deployment
Web Server on a Single Machine
High Availability
Deployment in the Cloud
Disaster Recovery - Active/Passive
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Getting Started
Introduction
The User Interface
Dashboard
Installation
About Installation
Prerequisites for Installation
The Windows Installer
Installation Using Scripts
Cluster Installation
The Azure App Service Installation Script
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
Command Line Parameters
Web.Config File
App Settings
Logging Configuration
Updating and Migrating
About Updating and Migrating to v2018
Updating Using the Scripts
Updating Using the Windows Installer
Updating Using the Azure Script
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
Other Configurations
Enabling Windows Authentication
Increasing The Size Limit of Package Files
Licensing
About Licensing
Activating and Uploading Your License
System Administrator
About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
Field Descriptions for the Settings Page
Field Descriptions System Admin Profile
Field Descriptions for the Audit Page
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
Users
About Users
Managing Users
Importing Users from the Active Directory
Field Descriptions
Profile Page
Roles
About Roles
Default Roles
Managing Roles
Field Descriptions
Robots
About Robots
Robot Statuses
Connecting Robots to Orchestrator
Managing Robots
Field Descriptions
How the Connection Between the Robot and Orchestrator Works
Storing Robot Credentials in CyberArk
Environments
About Environments
Managing Environments
Field Descriptions
Packages
About Packages
Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions
Processes
About Processes
About the Activities Feed
Managing Processes
Field Descriptions
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
Managing Queues in Studio
Field Descriptions for Queues
Field Descriptions for Transactions
Field Descriptions for the Transactions .csv File
Jobs
About Jobs
Job States
Managing Jobs
How Starting a Job Works
Field Descriptions
Schedules
About Schedules
Managing Schedules
Field Descriptions
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
Organization Units
About Organization Units
Managing Organization Units
Field Descriptions
Physical Deployment Options
About Physical Deployment
Web Server on a Single Machine
High Availability
Deployment in the Cloud
Disaster Recovery - Active/Passive
Troubleshooting
IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
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
Examples Using the Orchestrator API
Authenticating
Permissions Per Endpoint
Jobs Requests
Environments Requests
Robots Requests
Retrieving License Information
Transaction Requests
Assets Requests
Settings Requests
Hey!
These docs are for version 2018.1, which is no longer officially supported. Click here for the latest version, 2020.10!