Check app name uniqueness
API reference for checking if a deployed app routing name is unique within the organization.
Checks whether a given routing name is unique for deployed apps within the organization. If the name is already in use, the response also returns the deployed app that holds it.
API endpoint
GET <BaseURL>/models/deployed/apps/uniquename/check/{routingName}
See Base URL for the root endpoint path.
Request headers
| Header | Value |
|---|---|
| Authorization | Bearer <your-access-token> |
| X-UiPath-Internal-TenantId | <tenant_id> |
Replace all the values between the angle brackets <...> with their corresponding use-case values.
The <access_token> is the one you received when you authorized the external application with the Apps or Apps.Read scope. It is available for 1 hour, then you need to generate a new one, or request a refresh token.
Path variables
| Path variable | Data type | Description |
|---|---|---|
| routingName (required) | string | The routing name to check for uniqueness. |
Responses
200 OK
If the routing name is available, occupiedBy is null:
{
"isUnique": true,
"occupiedBy": null
}
{
"isUnique": true,
"occupiedBy": null
}
If the routing name is already in use, occupiedBy returns the deployed app that holds it:
{
"isUnique": false,
"occupiedBy": {
"id": "string",
"systemName": "string",
"title": "string",
"deploymentTitle": "string",
"deploymentDescription": "string",
"deployVersion": 1,
"semVersion": "string",
"dateDeployed": "string",
"deploymentFolder": {
"key": "string",
"id": 1,
"displayName": "string",
"fullyQualifiedName": "string"
},
"isAppPublic": false,
"isLatestVersion": true,
"isResourceActivated": true,
"routingName": "string"
}
}
{
"isUnique": false,
"occupiedBy": {
"id": "string",
"systemName": "string",
"title": "string",
"deploymentTitle": "string",
"deploymentDescription": "string",
"deployVersion": 1,
"semVersion": "string",
"dateDeployed": "string",
"deploymentFolder": {
"key": "string",
"id": 1,
"displayName": "string",
"fullyQualifiedName": "string"
},
"isAppPublic": false,
"isLatestVersion": true,
"isResourceActivated": true,
"routingName": "string"
}
}
| Field | Data type | Description |
|---|---|---|
| isUnique | boolean | true if the routing name is available, false if it is already in use. |
| occupiedBy | object | The deployed app that holds the routing name. null when isUnique is true. Can also be null when isUnique is false, if the app holding the name could not be loaded. |
| occupiedBy.id | string | The deployment ID of the app. |
| occupiedBy.systemName | string | The system name of the app. |
| occupiedBy.title | string | The title of the published app. |
| occupiedBy.deploymentTitle | string | The name the app was given when it was deployed. |
| occupiedBy.deploymentDescription | string | The description of the deployed app. |
| occupiedBy.deployVersion | number | The deployed version number. |
| occupiedBy.semVersion | string | The semantic version of the deployed app. |
| occupiedBy.dateDeployed | string | The date and time the app was deployed, in ISO 8601 format. |
| occupiedBy.deploymentFolder | object | The folder the app is deployed in. |
| occupiedBy.deploymentFolder.key | string | The folder key. |
| occupiedBy.deploymentFolder.id | number | The folder ID. |
| occupiedBy.deploymentFolder.displayName | string | The display name of the folder. |
| occupiedBy.deploymentFolder.fullyQualifiedName | string | The full path of the folder. |
| occupiedBy.isAppPublic | boolean | true if the app is publicly accessible. |
| occupiedBy.isLatestVersion | boolean | true if the deployed version is the latest published version. |
| occupiedBy.isResourceActivated | boolean | false if the deployed app is deactivated. A deactivated app still holds its routing name. Not present on every app. If the field is absent, the app is active. |
| occupiedBy.routingName | string | The routing name used in the app URL. |
400 Bad Request
The routingName path variable is empty or contains only whitespace.
401 Unauthorized
You are not authenticated. Make sure you are using a valid access token with the Apps or Apps.Read scope.
403 Forbidden
You don't have permission to check app name uniqueness in the specified organization.