Borrow

7min
Borrow a floating cloud license from current device
POST
Params
Header Parameters
Date
required
String
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls article.
Body Parameters
hardware_id
required
String
Unique hardware ID generated for some device
product
required
String
Product short code
borrowed_until
required
String
Datetime until license is borrowed ( eq. 2022-05-06T00:00:00Z ). 
license_key
optional
String
Required if product is key_based. Attach the license key (eq. 1111-2222-3333-4444)
username
optional
String
Required if product is user based. Attach the assigned license user email (eq. user@example.com)
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.
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 14 Nov 2023
Did this page help you?
License
Release
Docs powered by Archbee
TABLE OF CONTENTS
POST
/api/v4/floating/borrow
List of exceptions