Borrow Floating License

Borrows a floating cloud license.

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.

Endpoint

• Method: POST
• Path: /api/v4/floating/borrow
• Description: Borrows a floating cloud license.

Authentication

See License API Authorization.

Required headers

• Date (string) — RFC7231 GMT date string
• Authorization (string)

Optional headers

• licensespring-tpm-signature (string) — TPM licensing signature and algorithm

  • licensespring-tpm-signature: algorithm="ES256",signature=""

Recommended headers

• Accept: application/json
• Content-Type: application/json

Request

Body parameters

Required:

• hardware_id (string)
• product (string)
• borrowed_until (string | null) — ISO 8601 UTC timestamp. Send null to use max_borrow_time.

One of:

• license_key (string)
• username + password (string)
• id_token (send access_token value) + customer_account_code (string)
• code + customer_account_code (string)

Optional:

• license_id (number)
• bundle_code (string)
• sdk_ver (string)
• redirect_uri (string)

Schema

Request Body (TypeScript)

type BorrowFloatingLicenseRequestBody = {
  // required parameters:
  product: string,
  hardware_id: string,

  /**
   * `borrowed_until` is a string in ISO 8601 format (always in UTC timezone).
   * It contains a date component and optional time component, e.g.:
   * "2024-09-27T23:30:48.016Z"
   * "2024-09-27 23:30:48.016"
   * "2024-09-27 23:30:48"
   * "2024-09-27 23:30"
   * "2024-09-27"
   */
  borrowed_until: string,

  // required for key-based products:
  license_key?: string,

  // required for user-based products:
  username?: string,
  password?: string,

  // required for SSO with Implicit grant authorization:
  id_token?: string,

  // required for SSO with Authorization code grant:
  code?: string,

  // required for SSO with either authorization method:
  customer_acount_id?: string,

  // optional parameters:
  license_id?: number | undefined,
  bundle_code?: string | undefined,
  sdk_ver?: string | undefined,
  redirect_uri?: string | undefined
}

Response Body (TypeScript)

type BorrowFloatingLicenseResponseBody = {
  borrowed_until: string, // date in ISO8061 format
  max_borrow_time: number, // hours
  device_id: number,
  license_id: number,
  floating_in_use_devices: number,
}

Examples

curl

curl --location --request POST '/api/v4/floating/borrow' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{
  "hardware_id": "some-unique-id",
  "product": "XY",
  "license_key": "AAAA-BBBB-CCCC-DDDD",
  "borrowed_until": null
}'

nodejs

var request = require('request');
var options = {
  method: 'POST',
  url: '/api/v4/floating/borrow',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  },
  body: JSON.stringify({
    hardware_id: 'some-unique-id',
    product: 'XY',
    license_key: 'AAAA-BBBB-CCCC-DDDD',
    borrowed_until: null
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

javascript (fetch)

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var raw = JSON.stringify({
  hardware_id: "some-unique-id",
  product: "XY",
  license_key: "AAAA-BBBB-CCCC-DDDD",
  borrowed_until: null
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("/api/v4/floating/borrow", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

python

import requests

url = "/api/v4/floating/borrow"

payload = {
  "hardware_id": "some-unique-id",
  "product": "XY",
  "license_key": "AAAA-BBBB-CCCC-DDDD",
  "borrowed_until": None
}

headers = {
  "Accept": "application/json",
  "Content-Type": "application/json",
  "Date": "string",
  "Authorization": "string"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

ruby

require "uri"
require "net/http"
require "json"

url = URI("/api/v4/floating/borrow")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"
request.body = JSON.dump({
  hardware_id: "some-unique-id",
  product: "XY",
  license_key: "AAAA-BBBB-CCCC-DDDD",
  borrowed_until: nil
})

response = http.request(request)
puts response.read_body

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:

Error schema (TypeScript + JSON Schema)

{
  status: number,
  code: string,
  message: string
}

{
  "$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

tpm_invalid_public_key (400): The TPM public key sent is not valid

tpm_signature_required (400): The TPM signature is missing from the header and TPM usage is enforced

tpm_signature_missmatch (400): The TPM signature/algorithm is not ES256 and the signature can't be verified against the TPM public key