Apps API guide
Edits a deployed app's properties, such as title, description, version, and maintenance mode settings.
API endpoint
PATCH <BaseURL>/models/deployed/apps/{deployedAppId}
See Base URL for the root endpoint path.
Request headers
| Header | Value |
|---|---|
| Authorization | Bearer <access_token> |
| Content-Type | application/json |
| X-UiPath-Internal-TenantId | <tenant_id> |
| X-UiPath-FolderKey | <folder_key> |
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.Write scope, and the OR.Folders.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 |
|---|---|---|
| deployedAppId (required) | string | The deployment ID of the app to edit. |
Request body (required)
{
"version": 2,
"title": "My Updated App",
"description": "Updated description for the app.",
"maintenanceModeData": {
"isMaintenanceModeEnabled": false,
"maintenanceModeUrl": "",
"maintenanceExcludedUsers": []
},
"tags": ["tag1", "tag2"]
}
{
"version": 2,
"title": "My Updated App",
"description": "Updated description for the app.",
"maintenanceModeData": {
"isMaintenanceModeEnabled": false,
"maintenanceModeUrl": "",
"maintenanceExcludedUsers": []
},
"tags": ["tag1", "tag2"]
}
| Field | Data type | Description |
|---|---|---|
| version (required) | number | The version to set for the deployed app. |
| title (required) | string | The display title for the deployed app. |
| description (required) | string | The description for the deployed app. |
| maintenanceModeData (optional) | object | Maintenance mode configuration. |
| maintenanceModeData.isMaintenanceModeEnabled | boolean | Whether maintenance mode is enabled. |
| maintenanceModeData.maintenanceModeUrl | string | The URL to redirect users to during maintenance. |
| maintenanceModeData.maintenanceExcludedUsers | array | Users excluded from the maintenance redirect. |
| tags (optional) | string[] | Complete list of system tag values. Replaces all existing tags. |
Responses
200 OK
Returns the ID of the updated deployed app.
{
"id": "string"
}
{
"id": "string"
}
401 Unauthorized
You are not authenticated. Make sure you are using a valid access token with the Apps or Apps.Write scope.
403 Forbidden
You don't have permission to edit deployed apps in the specified folder.