Borrow Floating License

12min
Borrows a floating cloud license
POST
Request
Header Parameters
Date
required
String
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See "License API Authorization" article
Body Parameters
hardware_id
required
String
Unique hardware ID generated for the client device
product
required
String
Product short code
borrowed_until
required
String
Timestamp until license is borrowed. ISO 8601 format (always in UTC timezone)
license_key
optional
String
Required if product is key-based (see section below)
username
optional
String
Required if product is user based (see section below)
password
optional
String
Required if product is user based (see section below)
license_id
optional
Number
Ensures that the action affects only the license with the specified ID. This is useful if e.g. you have multiple licenses for the same product assigned to the same user. For obtaining a list of licenses assigned to a user, see "User Licenses"
Curl
Node.js
JS
Python
Ruby
curl --location --request POST '/api/v4/floating/borrow' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{"hardware_id":"String","product":"string","license_key":"string","username":"string"}'
curl --location --request POST '/api/v4/floating/borrow' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{"hardware_id":"String","product":"string","license_key":"string","username":"string"}'
Responses
200
400
{
    "borrowed_until": "2022-05-06T00:00:00Z",
    "max_borrow_time": 48,
    "device_id": 1648212707135009,
    "license_id": 1622536481402629
}
{
    "borrowed_until": "2022-05-06T00:00:00Z",
    "max_borrow_time": 48,
    "device_id": 1648212707135009,
    "license_id": 1622536481402629
}
﻿
Send null as a value for borrowed_until if you wan't to set borrowed_until to max_borrow_time from now + max_borrow_time value defined on a license.
Schema
Request Body
TypeScript
JSON Schema

﻿
Response Body
TypeScript
JSON Schema

﻿
License Authorization Method
There are two types of product licenses based on how the client application authorizes itself to interact with a license:
Key-based product licenses: client interactions with the license have to be authorized using a license_key
User-based product licenses: the license has a corresponding "license user" instead of a license key. Client interactions with the license have to be authorized using a username and password
Errors
If an error occurs, the response will have an HTTP status code of 400 or higher, and the response body will contain an error description in the following format:
TypeScript
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}
﻿
List of exceptions
missing_headers (400): Some headers are missing
missing_parameters (400): Some parameters are missing in the request: { params }.
unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_active (400): The license is not active
license_not_enabled (400): The license is not enabled
license_borrow_not_allowed (400): License does not allow borrowing
borrow_until_not_valid (400): Borrow until field is not valid
device_not_found (400): An active device matching the hardware_id not found
blacklisted (400): This device is blacklisted
floating_not_available (400): No available slots for floating license
﻿
Updated 24 Jan 2025
Did this page help you?
License
Release Floating License