Release Floating License

9min
Releases a floating cloud license from the current device and removes the device from the floating pool
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
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)
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
require "uri"
require "net/http"

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

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"
request.body = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\"}"

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

require "uri"
require "net/http"

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

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"
request.body = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\"}"

response = http.request(request)
puts response.read_body
Responses
200
400

﻿
Schema
Request Body
TypeScript
JSON
type ReleaseFloatingLicenseRequestBody = {
  
  // required parameters:
  product: string,
  hardware_id: string,
  
  // required for key-based products:
  license_key: string
  
  // required for user-based products:
  username: string
  
  // optional parameters:
  license_id?: string | undefined,
}
type ReleaseFloatingLicenseRequestBody = {
  
  // required parameters:
  product: string,
  hardware_id: string,
  
  // required for key-based products:
  license_key: string
  
  // required for user-based products:
  username: string
  
  // optional parameters:
  license_id?: string | undefined,
}
﻿
Response Body
TypeScript
JSON
type ReleaseFloatingLicenseResponseBody = ''
type ReleaseFloatingLicenseResponseBody = ''
﻿
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 
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
{
  status: number,
  code: string,
  message: string
}
{
  status: number,
  code: string,
  message: string
}
﻿
List of exceptions
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
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 17 Jan 2025
Did this page help you?
Borrow Floating License
List Licenses