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 Integrations
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
v2021.10
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
deprecated
v2020.10
v2021.4
v2021.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
2021.10
Before you begin
Installing standalone Orchestrator
Installing Automation Suite
Compatibility matrix
Deprecation timeline
Orchestrator configuration checklist
Getting Started
Introduction
Logging in to Orchestrator
User options
Resetting your password
My Profile
Activities feeds
Robots
Robot Statuses
Robot Settings
Auto updating client components
Best Practices
Automation Best Practices
Managing Large Deployments
Attended vs. Unattended Automation
Organization Modeling in Orchestrator
Administration of Modern Folders
Optimizing unattended infrastructure using machine templates
Security Best Practices
Performance Best Practices
🌐 Tenant
About the Tenant Context
Robots
Managing Robots
Connecting Robots to Orchestrator
Setting up attended robots
Setting up unattended robots
Setup Samples
Storing Robot Credentials in CyberArk
Folders
Managing Folders
Folders Administration
Personal Workspaces
Managing Personal Workspaces
Key Features and Behavior
Migrating from Classic Folders to Modern Folders
Accounts and roles
Assigning Roles
Managing Roles
Default Roles
User Types
Managing accounts
FAQ
Machines
Managing Machines
Assigning Machine Objects to Folders
Configuring account-machine mappings
Packages
Managing Packages
About Libraries
Managing Libraries
Audit
Credential Stores
Managing Credential Stores
CyberArk® Integration
CyberArk® CCP Integration
Azure Key Vault Integration
Webhooks
Types of Events
Managing Webhooks
Licensing
Managing your licenses
Activating your license
Alerts
Setting Up Email Alerts
Settings
Registering External Applications
Managing External Applications
📁 Folders Context
About the Folders Context
Home
📁 Automations
About Automations
📁 Processes
About Processes
Managing Processes
About Recording
📁 Jobs
About Jobs
Managing Jobs
Working with long-running workflows
Job States
📁 Triggers
About Triggers
Managing Triggers
Using Cron Expressions
📁 Folder Packages
About Packages
Managing Packages
📁 Logs
About Logs
Logging Levels
Managing Logs in Orchestrator
Orchestrator Logs
📁 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
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
📁 Storage Buckets
About Storage Buckets
CORS/CSP Configuration
Managing Storage Buckets
Moving Bucket Data Between Storage Providers
📁 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
🔧 Host Administration
Host administration portals
About the UiPath Identity Server
Managing system administrators
Host management
Configuring host authentication settings
Re-configuring authentication after upgrade
Host audit logs
Configuring system email notifications
Customizing the Login page
Managing tenants
Maintenance mode
Authentication (Host)
Configuring SSO: Active Directory
Configuring SSO: SAML 2.0
ADFS authentication
Google authentication
Okta authentication
PingOne authentication
Custom mapping
Self-signed certificates
Private key certificates
Configuring SSO: Google
Configuring SSO: Azure Active Directory
SmartCard authentication
Other Configurations
Increasing the Size Limit of Package Files
Setting up Encryption Key per Tenant
GZIP Compression
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
Upgrade Issues
Cron Expressions
Orchestrator Mobile Release Notes
2019 Fast Track 1.0
2019 Fast Track 2.0
2019 Fast Track 3.0
3.10.2
Orchestrator Mobile App
Push Notifications
Favorite Processes
Favorite Jobs
Mobile Device Management
iOS - Root Certificate Authority
Release Notes
2021.10
Before you begin
Installing standalone Orchestrator
Installing Automation Suite
Compatibility matrix
Deprecation timeline
Orchestrator configuration checklist
Getting Started
Introduction
Logging in to Orchestrator
User options
Resetting your password
My Profile
Activities feeds
Robots
Robot Statuses
Robot Settings
Auto updating client components
Best Practices
Automation Best Practices
Managing Large Deployments
Attended vs. Unattended Automation
Organization Modeling in Orchestrator
Administration of Modern Folders
Optimizing unattended infrastructure using machine templates
Security Best Practices
Performance Best Practices
🌐 Tenant
About the Tenant Context
Robots
Managing Robots
Connecting Robots to Orchestrator
Setting up attended robots
Setting up unattended robots
Setup Samples
Storing Robot Credentials in CyberArk
Folders
Managing Folders
Folders Administration
Personal Workspaces
Managing Personal Workspaces
Key Features and Behavior
Migrating from Classic Folders to Modern Folders
Accounts and roles
Assigning Roles
Managing Roles
Default Roles
User Types
Managing accounts
FAQ
Machines
Managing Machines
Assigning Machine Objects to Folders
Configuring account-machine mappings
Packages
Managing Packages
About Libraries
Managing Libraries
Audit
Credential Stores
Managing Credential Stores
CyberArk® Integration
CyberArk® CCP Integration
Azure Key Vault Integration
Webhooks
Types of Events
Managing Webhooks
Licensing
Managing your licenses
Activating your license
Alerts
Setting Up Email Alerts
Settings
Registering External Applications
Managing External Applications
📁 Folders Context
About the Folders Context
Home
📁 Automations
About Automations
📁 Processes
About Processes
Managing Processes
About Recording
📁 Jobs
About Jobs
Managing Jobs
Working with long-running workflows
Job States
📁 Triggers
About Triggers
Managing Triggers
Using Cron Expressions
📁 Folder Packages
About Packages
Managing Packages
📁 Logs
About Logs
Logging Levels
Managing Logs in Orchestrator
Orchestrator Logs
📁 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
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
📁 Storage Buckets
About Storage Buckets
CORS/CSP Configuration
Managing Storage Buckets
Moving Bucket Data Between Storage Providers
📁 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
🔧 Host Administration
Host administration portals
About the UiPath Identity Server
Managing system administrators
Host management
Configuring host authentication settings
Re-configuring authentication after upgrade
Host audit logs
Configuring system email notifications
Customizing the Login page
Managing tenants
Maintenance mode
Authentication (Host)
Configuring SSO: Active Directory
Configuring SSO: SAML 2.0
ADFS authentication
Google authentication
Okta authentication
PingOne authentication
Custom mapping
Self-signed certificates
Private key certificates
Configuring SSO: Google
Configuring SSO: Azure Active Directory
SmartCard authentication
Other Configurations
Increasing the Size Limit of Package Files
Setting up Encryption Key per Tenant
GZIP Compression
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
Upgrade Issues
Cron Expressions
Orchestrator Mobile Release Notes
2019 Fast Track 1.0
2019 Fast Track 2.0
2019 Fast Track 3.0
3.10.2
Orchestrator Mobile App
Push Notifications
Favorite Processes
Favorite Jobs
Mobile Device Management
iOS - Root Certificate Authority
Introduction to the Orchestrator API
About OData and References
API References
Logical Resources and Metadata
Available Operations
Enumerated Types
The Swagger Definition
Managing Logical Resources
Building API Requests
Basics
Authenticating
Using OAuth for External Apps
Permissions Per Endpoint
Response Codes
Health Check Endpoints
Examples Using the Orchestrator API
Actions Requests
Action Catalogs Requests
Alerts Requests
Assets Requests
Calendars Requests
Environments Requests
Folders Requests
Form Actions Requests
Generic Actions Requests
Jobs Requests
Libraries Requests
License Requests
Packages Requests
Permissions Requests
Processes Requests
Robots Requests
Roles Requests
Schedules Requests
Settings Requests
Tenants Requests
Transaction Requests
Users Requests
Webhooks Requests
Platform Management APIs
User management
Audit query
Group
Message template
Robot account
Setting
User
Login attempts
License management
License resource management
License accountant
Release Notes
2021.10
Before you begin
Installing standalone Orchestrator
Installing Automation Suite
Compatibility matrix
View All 5
Getting Started
Introduction
Logging in to Orchestrator
User options
View All 6
Best Practices
Automation Best Practices
Security Best Practices
Performance Best Practices
🌐 Tenant
About the Tenant Context
Robots
Folders
View All 13
📁 Folders Context
About the Folders Context
Home
📁 Automations
About Automations
📁 Processes
About Processes
Managing Processes
About Recording
📁 Jobs
About Jobs
Managing Jobs
Working with long-running workflows
View All 4
📁 Triggers
About Triggers
Managing Triggers
Using Cron Expressions
📁 Folder Packages
About Packages
Managing Packages
📁 Logs
About Logs
Logging Levels
Managing Logs in Orchestrator
View All 4
📁 Monitoring
About Monitoring
Machines
Processes
View All 5
📁 Queues
About Queues and Transactions
Bulk uploading queue items using a CSV file
Managing Queues in Orchestrator
View All 6
📁 Assets
About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
📁 Storage Buckets
About Storage Buckets
Managing Storage Buckets
Moving Bucket Data Between Storage Providers
📁 Test Suite
Test Automation
Test Cases
Test Sets
View All 6
🔧 Host Administration
Host administration portals
Managing system administrators
Host management
View All 5
Authentication (Host)
Configuring SSO: Active Directory
Configuring SSO: SAML 2.0
Configuring SSO: Google
View All 5
Other Configurations
Increasing the Size Limit of Package Files
Setting up Encryption Key per Tenant
GZIP Compression
Integrations
About Input and Output Arguments
Example of Using Input and Output Arguments
Classic Robots
Robots
Environments
Machines
View All 11
Troubleshooting
About Troubleshooting
Orchestrator Mobile Release Notes
2019 Fast Track 1.0
2019 Fast Track 2.0
2019 Fast Track 3.0
View All 4
Orchestrator Mobile App
Push Notifications
Favorite Processes
Favorite Jobs
View All 5
Introduction to the Orchestrator API
About OData and References
API References
Logical Resources and Metadata
View All 5
The Swagger Definition
Managing Logical Resources
Building API Requests
Basics
Authenticating
Using OAuth for External Apps
Permissions Per Endpoint
View All 5
Examples Using the Orchestrator API
Actions Requests
Action Catalogs Requests
Alerts Requests
View All 23
Platform Management APIs
User management
License management