orchestrator
2023.10
false
  • Getting Started
  • Swagger Definition
  • Orchestrator APIs
UiPath logo, featuring letters U and I in white
Orchestrator API Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Jun 22, 2024

Settings Requests

Retrieving Service Settings Used by the Robot

The following request enables you to display all the service settings used by the Robot.

Note: 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": [{
        "Name@odata.type": "#String",
        "Name": "AttendedRobot.RunDisconnectedHours",
        "Value": "24"
    }]
}{
    "settings": [{
        "Name@odata.type": "#String",
        "Name": "AttendedRobot.RunDisconnectedHours",
        "Value": "24"
    }]
}

Response code

200 OK

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.