About this guide

This guide covers the API for Private Test Cloud — the on-premises deployment of Test Cloud running on self-managed infrastructure (Linux, AKS/EKS, and OpenShift). For a full explanation of what Private Test Cloud is and how it relates to Test Cloud and Automation Suite, refer to About Test Cloud.

This guide is designed to help developers and integrators to navigate the UiPath® API, and learn about the available resources, authentication methods, and how to construct API requests. By providing programmatic access to the functionality and data within the UiPath® platform, our API allows you to integrate our services seamlessly into your applications and systems.

Here, you will find an overview of the two core layers of our architecture that drive our APIs: organization-level services and tenant-scoped services. The organization-level services, such as Identity Server and Licensing, handle operations throughout the organization. Conversely, tenant-scoped services, such as Orchestrator or Data Service, cater to the specific requirements of individual tenants.