- Getting started
- Swagger definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Permissions requests
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
Orchestrator API guide
Settings requests
Retrieving service settings used by the robot
The following request enables you to display all the service settings used by the Robot.
Please note that you need to include the Robot license key when making this request, as a header. The header's name must be X-ROBOT-LICENSE, as you can see in the example below.
GET
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
"Keys": [
"ConfigurationUrl",
"DeploymentUrl",
"MonitoringUrl",
"NotificationHubUrl",
"LoggingUrl",
"QueuesSvcUrl",
"NuGet.Packages.ApiKey",
"NuGetServiceApiKey",
"ActivitiesFeed"
],
"Values": [
"https://your-domain-server.com",
"https://your-domain-server.com/nuget/feed/documentation",
"https://your-domain-server.com",
"https://your-domain-server.com/signalr/hubs",
"https://your-domain-server.com",
"https://your-domain-server.com",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"https://your-domain-server.com/nuget/activities"
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
"Keys": [
"ConfigurationUrl",
"DeploymentUrl",
"MonitoringUrl",
"NotificationHubUrl",
"LoggingUrl",
"QueuesSvcUrl",
"NuGet.Packages.ApiKey",
"NuGetServiceApiKey",
"ActivitiesFeed"
],
"Values": [
"https://your-domain-server.com",
"https://your-domain-server.com/nuget/feed/documentation",
"https://your-domain-server.com",
"https://your-domain-server.com/signalr/hubs",
"https://your-domain-server.com",
"https://your-domain-server.com",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"https://your-domain-server.com/nuget/activities"
]
}
Retrieving the robot execution settings
The example below enables you to retrieve the Robot runtime settings.
GET
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=1)
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
"Scope": "Global",
"Configuration": [
{
"Key": "TracingLevel",
"DisplayName": "Logging Level",
"ValueType": "MultipleChoice",
"DefaultValue": "Information",
"PossibleValues": [
"Verbose",
"Trace",
"Information",
"Warning",
"Error",
"Critical",
"Off"
]
},
{
"Key": "LoginToConsole",
"DisplayName": "Login To Console",
"ValueType": "Boolean",
"DefaultValue": "false",
"PossibleValues": []
},
{
"Key": "ResolutionWidth",
"DisplayName": "Resolution Width",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionHeight",
"DisplayName": "Resolution Height",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionDepth",
"DisplayName": "Resolution Depth",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
"Scope": "Global",
"Configuration": [
{
"Key": "TracingLevel",
"DisplayName": "Logging Level",
"ValueType": "MultipleChoice",
"DefaultValue": "Information",
"PossibleValues": [
"Verbose",
"Trace",
"Information",
"Warning",
"Error",
"Critical",
"Off"
]
},
{
"Key": "LoginToConsole",
"DisplayName": "Login To Console",
"ValueType": "Boolean",
"DefaultValue": "false",
"PossibleValues": []
},
{
"Key": "ResolutionWidth",
"DisplayName": "Resolution Width",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionHeight",
"DisplayName": "Resolution Height",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionDepth",
"DisplayName": "Resolution Depth",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
}
]
}
Setting the number of hours an attended robot can run offline
The request below enables you to change the number of hours for which an Attended Robot retains its licenses in an offline environment to 24 hours.
Please note that this setting is applied when you first connect the Robot to Orchestrator, or after the UiPath Robot service is restarted. If you are running the Community version, you need to restart the tray for the change to take effect.
POST
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
Request body
{
"settings": [{
"[email protected]": "#String",
"Name": "AttendedRobot.RunDisconnectedHours",
"Value": "24"
}]
}
{
"settings": [{
"[email protected]": "#String",
"Name": "AttendedRobot.RunDisconnectedHours",
"Value": "24"
}]
}
Response code
200 OK