Licence

License information and management

get

Returns HQ's licence.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Responses

200

Successfully returns licence response.

application/json

Models a licence.

idstringRequired

Unique identifier for this licence (hex string).

expires_atstring · date-timeOptional

Is set to the moment HQ no longer considers this licence valid. Is omitted for licences that do not expire.

tierstring · enumRequired

Enumerates licence tiers.

Possible values:

default

Error object.

application/json

get/api/v1/licence

GET /api/v1/licence HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "expires_at": "2026-01-01T00:00:00.000Z",
  "tier": "community",
  "features": {
    "kafka_topic_backup_restore": true,
    "single_sign_on": true,
    "k2k": true,
    "k2k_exactly_once": true,
    "k2k_bidirectional": true,
    "k2k_offsets_migration": true,
    "k2k_schema_mapping": true
  },
  "limits": {
    "iam_user": 1,
    "iam_admin": 1,
    "iam_group": 1,
    "iam_role": 1,
    "k2k_apps": 1
  }
}

get

Returns HQ's licence summary.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Responses

200

Successfully returns licence response.

application/json

Models a compact licence.

is_communitybooleanRequired

Is true when the licence is a community one, false otherwise.

default

Error object.

application/json

get/api/v1/licence-summary

GET /api/v1/licence-summary HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "is_community": true
}