API endpoint URL structure

In this section, you can learn to construct API requests by understanding the URL structure of UiPath® endpoints.

Base URL

The base URL is the starting point for all API requests. It serves as the foundation for constructing the endpoint URL. The base URL is https://govcloud.uipath.us.

Entry point

api - signifies the entry point to the API platform management resources, for example ​/api​/Group​/

Resource path

The resource path specifies the exact resource or operation you wish to perform. It might include keywords like Group, RobotAccount, Setting, depending on the purpose of the request.

Path parameters

Path parameters are used to pass dynamic values to an API endpoint. These values help for identifying specific resources that are relevant to the API request. For example, ​/Group​/{partitionGlobalId}​/{groupId}

partitionGlobalId - the ID of the organization.

groupId - the ID of the group.

Query parameters

Query parameters are additional parameters attached to the URL to provide more context or filters for the requested data. These are often preceded by a ? symbol and separated by & symbols. For instance, you might use query parameters to specify filtering criteria or pagination instructions

Example

Putting all components together, a URL for a organization-specific resource might look like this, https://govcloud.uipath.us/{organizationName}/{tenantName}/identity_/api/group/{partitionGlobalId}​/{groupId}.

A URL for tenant-specific resource can look like this: https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Assets.