Activate Bundle (Online Method)

Endpoint

• Method: POST

• Path: /api/v4/activate_bundle

• Description: Activates all licenses inside a bundle and returns the activated licenses list.

Authentication

See License API Authorization.

Required headers

• Date (string) — RFC7231 GMT date string

• Authorization (string) — signature or bearer token

Recommended headers

• Accept: application/json

• Content-Type: application/json

Request

Body parameters

Required:

• hardware_id (string) — Unique hardware ID generated for the client device

• product (string) — Bundle product short code

One of:

• license_key (string) — For key-based bundles

• username + password (string) — For user-based bundles

• id_token + customer_account_code (string) — SSO Implicit grant

• code + customer_account_code (string) — SSO Authorization Code grant

Optional:

• license_id (number)

• is_vm (boolean)

• vm_info (string)

• os_ver (string)

• hostname (string)

• os_hostname (string)

• ip (string)

• ip_local (string)

• app_ver (string)

• sdk_ver (string)

• mac_address (string)

• variables (object)

Minimal example (JSON)

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

Examples

curl

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

nodejs

javascript (fetch)

python

ruby

Schema

Request Body

Request schema (TypeScript + JSON Schema)

TypeScript

type BundleActivationRequestBody = ({

  // for key-based licenses:
  license_key: string

} | {

  // for user-based licenses:
  username: string
  password: string

} | {

  // for user-based licenses using single sign-on Implicit grant:
  id_token: string
  customer_account_code: string

} | {

  // for user-based licenses using single sign-on Authorization code grant:
  code: string
  customer_account_code: string

}) & {

  // required properties:
  hardware_id: string
  product: string

  // optional properties:
  bundle_code?: string | undefined
  license_id?: number | undefined
  is_vm?: boolean | undefined
  vm_info?: string | undefined
  os_ver?: string | undefined
  hostname?: string | undefined
  os_hostname?: string | undefined
  ip?: string | undefined
  ip_local?: string | undefined
  app_ver?: string | undefined
  sdk_ver?: string | undefined
  mac_address?: string | undefined
  variables?: { [key: string]: string } | undefined
}

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "allOf": [
    {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "license_key": { "type": "string" }
          },
          "required": ["license_key"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "username": { "type": "string" },
            "password": { "type": "string" }
          },
          "required": ["username", "password"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "id_token": { "type": "string" },
            "customer_account_code": { "type": "string" }
          },
          "required": ["id_token", "customer_account_code"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "code": { "type": "string" },
            "customer_account_code": { "type": "string" }
          },
          "required": ["code", "customer_account_code"],
          "additionalProperties": false
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "hardware_id": { "type": "string" },
        "product": { "type": "string" },
        "bundle_code": { "type": "string" },
        "license_id": { "type": "number" },
        "is_vm": { "type": "boolean" },
        "vm_info": { "type": "string" },
        "os_ver": { "type": "string" },
        "hostname": { "type": "string" },
        "os_hostname": { "type": "string" },
        "ip": { "type": "string" },
        "ip_local": { "type": "string" },
        "app_ver": { "type": "string" },
        "sdk_ver": { "type": "string" },
        "mac_address": { "type": "string" },
        "variables": {
          "type": ["object", "null"],
          "additionalProperties": { "type": "string" }
        }
      },
      "required": ["hardware_id", "product"],
      "additionalProperties": false
    }
  ]
}

Response Body

Response schema (TypeScript + JSON Schema)

TypeScript

// Response is a list of activated licenses.
// Each item matches the Activate License (Online) response schema.
type BundleActivationResponseList = LicenseActivationResponseBody[];

JSON Schema

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

See Activate License Online Method for the item schema.

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

Each license assigned to the product requires the client to provide a license key in order to activate, check or deactivate the license (property license_key in the request body).

The license response object will contain the license_key property, and the property product_details.authorization_method will be the string license_key.

User-based product licenses

Each license assigned to the product has a corresponding "license user" instead of a license key. There are multiple ways a user-based product license can be accessed when making a request:

• By providing the values for username and password for the license user

• By providing the values for id_token and customer_account_code if using single sign-on authentication using Implicit grant

• By providing the values for code and customer_account_code if using single sign-on authentication using Authorization code grant

In the license response object, product_details.authorization_method will have the string value user and the response object will contain the user object with information on the license user.

License Types

The license_type property defines one of the 4 types of licenses based on their duration and how the license is used:

• Perpetual: perpetual

• Time-limited: time-limited

• Subscription: subscription

• Consumption: consumption

For more information see: License Types

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:

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

JSON Schema

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

• product_not_bundle (400): Specified product "code" is not a bundle

• license_not_found (400): License with the provided license user not found

• license_not_enabled (400): The license is not enabled

• vm_not_allowed (400): Virtual machine not allowed

• offline_floating_cloud_not_supported (400): Floating cloud licenses cannot be activated offline

• license_start_date_error (400): This license cannot be activated before start date: {date}

• blacklisted (400): This device is blacklisted

• license_activated_max_times (400): This license key has already been activated the maximum number of times

• license_user_activated_max_times (400): License user has activated this license max times

• license_expired (400): License validity period has expired

• license_transferred_max_times (400): This license has already been transferred the maximum number of times

• license_device_exists (409): A device matching this hardware_id is already created on the license.