Website logo
⌘K
Getting Started
Introduction
Basic Concepts
Opening an Account
Creating & Configuring Products
Integrating SDK and Configuring License Fulfillment
Activate a Key-Based License
Vendor Platform
Issuing New Licenses
License Detail View
Order Detail View
Customer Detail View
Metadata
Analytics
Settings
Product Configuration
Product Features
Product Custom Fields
Product Versioning
License Policies
Product Bundles
License Entitlements
Consumption Period in License/Features
License Types
Activations & Device Transfers
Features
Floating Features
Custom Fields
License Start Date
License Note
Maintenance Period
Trial Licenses
Floating Licenses
License Activation Types
Portals
End-User Portal
Offline Portal
Air-Gapped Portal
License API
License API Authorization
License Activation/Deactivation
License Check
License Feature Check
Consumption
Floating
Trial Key
Product Details
Device Variables
Changing Password
Versions
Installation File
Customer License Users
SSO URL
Management API
Making API Requests
Management API Authorization
Customer
Product
Order
License
Device
Analytics
SDKs
Tutorials
.NET/C# SDK
.NET/C# Management SDK
C++ SDK
Java SDK
Python SDK
Go SDK
Delphi SDK
Swift/Objective-C SDK
Android SDK
Unity SDK
Errors and Response Codes
Floating Server
API Reference
Deployment
Configuration
Floating Server UI
Securing the Server
Whitelabeling
FAQ
Floating Server Changelog
Integrations
Subscription Integration
Salesforce
FastSpring
Stripe
Shopify
Common Scenarios
Single Sign On (SSO)
Glossary
General
SDK Glossary
Vendor Platform
Product Configuration Glossary
License Configuration
Postman Collections
Frequently Asked Questions
Integrations
SDK
Changelog
License API changelog
Platform changelog
Docs powered by Archbee
License API
...
Floating
License

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"}'
Responses
200
400
{
    "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?
PREVIOUS
License
NEXT
Release
Docs powered by Archbee
TABLE OF CONTENTS
POST
/api/v4/floating/borrow
List of exceptions
Docs powered by Archbee