orchestrator
2022.10
false
- 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
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
License Requests
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
Orchestrator API Guide
Last updated Jun 22, 2024
License Requests
The following call to the
odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType')
endpoint enables you to retrieve all the Attended Robots that are licensed with a named user license.
Note: This request returns a maximum of 1,000 entries.
GET
https://{yourDomain}/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')
{
"@odata.context": "https://{yourDomain}/odata/$metadata#NamedUserLicenses",
"@odata.count": 1,
"value": [
{
"UserName": "uipath\\documentation",
"Key": "uipath\\documentation",
"LastLoginDate": "2018-09-19T10:44:45.757Z",
"MachinesCount": 1,
"IsLicensed": false,
"ActiveRobotId": null,
"MachineNames": [
"MINDAGOMIR"
],
"ActiveMachineNames": []
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#NamedUserLicenses",
"@odata.count": 1,
"value": [
{
"UserName": "uipath\\documentation",
"Key": "uipath\\documentation",
"LastLoginDate": "2018-09-19T10:44:45.757Z",
"MachinesCount": 1,
"IsLicensed": false,
"ActiveRobotId": null,
"MachineNames": [
"MINDAGOMIR"
],
"ActiveMachineNames": []
}
]
}
The following example disables the Documentation machine so that the Robots connected to it do not consume NonProduction/Unattended licenses.
You can also enable a machine with a request to the
/odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled
endpoint, by setting the enabled
parameter to true
.
POST
https://{yourDomain}/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabled
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
{
"key": "Documentation",
"robotType": "Unattended",
"enabled": false
}
The following request can only be performed on one tenant at a time. If you are using Swagger, this query is executed on the tenant you are logged into Orchestrator when making the request. If you are using an API testing tool, then the tenant you make this request for is the one used to generate the bearer token.
GET
https://{yourDomain}/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
"ExpireDate": 1545392350,
"IsRegistered": true,
"Concurrent": false,
"IsExpired": false,
"AllowedRobots": {
"Unattended": 50,
"Attended": 50,
"NonProduction": 50,
"Development": 50
},
"DefinedRobots": {
"Unattended": 1,
"Attended": 0,
"NonProduction": 3,
"Development": 1
},
"ConcurrentRobots": {
"Unattended": 0,
"Attended": 0,
"NonProduction": 0,
"Development": 0
}
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
"ExpireDate": 1545392350,
"IsRegistered": true,
"Concurrent": false,
"IsExpired": false,
"AllowedRobots": {
"Unattended": 50,
"Attended": 50,
"NonProduction": 50,
"Development": 50
},
"DefinedRobots": {
"Unattended": 1,
"Attended": 0,
"NonProduction": 3,
"Development": 1
},
"ConcurrentRobots": {
"Unattended": 0,
"Attended": 0,
"NonProduction": 0,
"Development": 0
}
}