Release Floating License

Releases a floating cloud license from the current device and removes the device from the floating pool.

Endpoint

Method: POST
Path: /api/v4/floating/release
Description: Releases a floating cloud license from the current device and removes the device from the floating pool.

Authentication

See License API Authorization.

Required headers

Date (string)
Authorization (string)

Recommended headers

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

Request

Body parameters

Required:

hardware_id (string)
product (string)

One of:

license_key (string)
username (string)

Optional:

license_id (number)

Examples

curl --location --request POST '/api/v4/floating/release' \
--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"
}'

var request = require('request');
var options = {
  method: 'POST',
  url: '/api/v4/floating/release',
  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'
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

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"
});

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

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

import requests

url = "/api/v4/floating/release"

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

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

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

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

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["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"
})

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

Schema

Request Body

Request schema (TypeScript + JSON Schema)

TypeScript

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,
}

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "product": { "type": "string" },
    "hardware_id": { "type": "string" },
    "license_key": { "type": "string" },
    "username": { "type": "string" },
    "license_id": { "type": "number" }
  },
  "required": ["product", "hardware_id"],
  "additionalProperties": false
}

Response Body

Response schema

This endpoint returns an empty string on success.

type ReleaseFloatingLicenseResponseBody = ''

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}

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:

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

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

PreviousBorrow Floating License NextList Licenses

Last updated 5 months ago

Was this helpful?