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
v2022.10
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
2022.10
Before you begin
Installing standalone Orchestrator
Installing Automation Suite
Compatibility matrix
Orchestrator configuration checklist
Deprecation timeline
Getting started
Introduction
Differences between cloud and on-premises
Logging in to Orchestrator
User options
My profile
Activities feeds
Robots
Robot statuses
Robot settings
Auto updating client components
Best practices
Organization modeling in Orchestrator
Deployment and configuration considerations
Attended vs. unattended automation
Automation best practices
Optimizing unattended infrastructure using machine templates
Managing large deployments
Security best practices
Performance best practices
Organizing resources with tags
Orchestrator read-only replica
Tenant
About the Tenant Context
Searching for resources in a tenant
Robots
Managing Robots
Connecting Robots to Orchestrator
Storing Robot credentials in CyberArk
Storing unattended robot credentials in HashiCorp Vault (read-only)
Deleting disconnected and unresponsive unattended sessions
Robot authentication
Robot authentication with client credentials
Folders
Managing Folders
Administration of modern folders
Personal Workspaces
Managing Personal Workspaces
Migrating from classic to modern folders
Classic folders vs modern folders
Monitoring
Unattended sessions
User sessions
License
Managing access and automation capabilities
Assigning roles
Managing roles
Default roles
Enabling users to run personal automations
Enabling users to run automations on unattended infrastructure via unattended robots
Configuring robot accounts to run unattended automations
Machines
Managing Machines
Assigning machine objects to folders
Configuring account-machine mappings
EDR protection status
Packages
Managing Packages
About Libraries
Managing Libraries
Audit
Credential Stores
Managing Credential Stores
CyberArk® Integration
CyberArk® CCP integration
Azure Key Vault integration
HashiCorp Vault integration
BeyondTrust integration
Thycotic Secret Server integration
Webhooks
Types of Events
Managing Webhooks
Licensing
Managing your licenses
Alerts
Configuring user alerts
Alert emails
Setting up alert emails
Settings
Resource Catalog Service
About Resource Catalog Service
Automation Suite robots
Automation Suite robots
Folders context
About the Folders Context
Home
Automations
About Automations
Processes
About Processes
Managing processes
Managing package requirements
About Recording
Jobs
About Jobs
Managing Jobs
Running personal remote automations
Working with long-running workflows
Job States
Troubleshooting jobs
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
Storing assets in HashiCorp Vault (read-only)
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
Configuring system email notifications
Managing system administrators
Managing your host license
Allocating host licenses to tenants
Orchestrator host settings
Tenant settings - host level
Managing tenants
Host authentication settings
Re-configuring authentication after upgrade
Configuring host security
Host audit logs
Customizing the Login page
Maintenance mode
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: Google
Configuring SSO: Azure Active Directory
SmartCard authentication
Organization administration
Licensing
Activating your license
Accounts and groups
Managing accounts and groups
Account types
FAQ
Registering External Applications
Managing External Applications
Audit logs
Overriding authentication and security
Setting up the Azure AD integration
Configuring the SAML integration
Overriding system email settings
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
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues
Orchestrator Mobile App
Release notes
2019 Fast Track 1.0
2019 Fast Track 2.0
2019 Fast Track 3.0
3.10.2
Push notifications
Favorite processes
Favorite jobs
Mobile device management
iOS - Root Certificate Authority
Release notes
2022.10
Before you begin
Installing standalone Orchestrator
Installing Automation Suite
Compatibility matrix
Orchestrator configuration checklist
Deprecation timeline
Getting started
Introduction
Differences between cloud and on-premises
Logging in to Orchestrator
User options
My profile
Activities feeds
Robots
Robot statuses
Robot settings
Auto updating client components
Best practices
Organization modeling in Orchestrator
Deployment and configuration considerations
Attended vs. unattended automation
Automation best practices
Optimizing unattended infrastructure using machine templates
Managing large deployments
Security best practices
Performance best practices
Organizing resources with tags
Orchestrator read-only replica
Tenant
About the Tenant Context
Searching for resources in a tenant
Robots
Managing Robots
Connecting Robots to Orchestrator
Storing Robot credentials in CyberArk
Storing unattended robot credentials in HashiCorp Vault (read-only)
Deleting disconnected and unresponsive unattended sessions
Robot authentication
Robot authentication with client credentials
Folders
Managing Folders
Administration of modern folders
Personal Workspaces
Managing Personal Workspaces
Migrating from classic to modern folders
Classic folders vs modern folders
Monitoring
Unattended sessions
User sessions
License
Managing access and automation capabilities
Assigning roles
Managing roles
Default roles
Enabling users to run personal automations
Enabling users to run automations on unattended infrastructure via unattended robots
Configuring robot accounts to run unattended automations
Machines
Managing Machines
Assigning machine objects to folders
Configuring account-machine mappings
EDR protection status
Packages
Managing Packages
About Libraries
Managing Libraries
Audit
Credential Stores
Managing Credential Stores
CyberArk® Integration
CyberArk® CCP integration
Azure Key Vault integration
HashiCorp Vault integration
BeyondTrust integration
Thycotic Secret Server integration
Webhooks
Types of Events
Managing Webhooks
Licensing
Managing your licenses
Alerts
Configuring user alerts
Alert emails
Setting up alert emails
Settings
Resource Catalog Service
About Resource Catalog Service
Automation Suite robots
Automation Suite robots
Folders context
About the Folders Context
Home
Automations
About Automations
Processes
About Processes
Managing processes
Managing package requirements
About Recording
Jobs
About Jobs
Managing Jobs
Running personal remote automations
Working with long-running workflows
Job States
Troubleshooting jobs
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
Storing assets in HashiCorp Vault (read-only)
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
Configuring system email notifications
Managing system administrators
Managing your host license
Allocating host licenses to tenants
Orchestrator host settings
Tenant settings - host level
Managing tenants
Host authentication settings
Re-configuring authentication after upgrade
Configuring host security
Host audit logs
Customizing the Login page
Maintenance mode
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: Google
Configuring SSO: Azure Active Directory
SmartCard authentication
Organization administration
Licensing
Activating your license
Accounts and groups
Managing accounts and groups
Account types
FAQ
Registering External Applications
Managing External Applications
Audit logs
Overriding authentication and security
Setting up the Azure AD integration
Configuring the SAML integration
Overriding system email settings
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
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues
Orchestrator Mobile App
Release notes
2019 Fast Track 1.0
2019 Fast Track 2.0
2019 Fast Track 3.0
3.10.2
Push notifications
Favorite processes
Favorite jobs
Mobile device management
iOS - Root Certificate Authority
Introduction to the Orchestrator API
Read me
About OData and References
Orchestrator URL
API References
Logical Resources and Metadata
Available Operations
Enumerated Types
The Swagger definition
Authorizing API calls in Swagger
Managing Logical Resources
Basics
Authenticating
Using OAuth for External Apps
Response Codes
Building API Requests
Permissions Per Endpoint
Health Check Endpoints
Examples using the Orchestrator API
UiPath Connector Guide - a Postman API collection
Actions Requests
Action Catalogs 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
Personal Workspaces Requests
Processes Requests
Queue items requests
Robots Requests
Roles Requests
Schedules Requests
Settings Requests
Tenants Requests
Transaction Requests
Users Requests
Webhooks Requests
Queue retention policy requests
Platform Management APIs
User management
Audit query
Group
Message Template
Robot account
Settings
User
Login attempts
License management
License resource management
License accountant
Release notes
2022.10
Before you begin
Installing standalone Orchestrator
Installing Automation Suite
Compatibility matrix
View All 5
Getting started
Introduction
Differences between cloud and on-premises
Logging in to Orchestrator
View All 8
Best practices
Organization modeling in Orchestrator
Deployment and configuration considerations
Attended vs. unattended automation
View All 10
Tenant
About the Tenant Context
Searching for resources in a tenant
Robots
View All 14
Resource Catalog Service
About Resource Catalog Service
Automation Suite robots
Automation Suite robots
Folders context
About the Folders Context
Home
Automations
About Automations
Processes
About Processes
Managing processes
Managing package requirements
View All 4
Jobs
About Jobs
Managing Jobs
Running personal remote automations
View All 6
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
View All 4
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
Configuring system email notifications
Managing system administrators
View All 10
Authentication
Configuring the Active Directory integration
Configuring SSO: SAML 2.0
Configuring SSO: Google
View All 5
Organization administration
Licensing
Accounts and groups
Registering External Applications
View All 6
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
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues
Orchestrator Mobile App
Release notes
Push notifications
Favorite processes
View All 6
Introduction to the Orchestrator API
Read me
About OData and References
Orchestrator URL
View All 7
The Swagger definition
Authorizing API calls in Swagger
Managing Logical Resources
Basics
Authenticating
Using OAuth for External Apps
Response Codes
View All 6
Examples using the Orchestrator API
UiPath Connector Guide - a Postman API collection
Actions Requests
Action Catalogs Requests
View All 26
Platform Management APIs
User management
License management