License Management

Description

defaultDescription

Security

Secured (HTTP Basic Authentication)

DEFAULT

DELETE ``/api/v2/licenses/providers/{provider-name}/entitlementkey/{entitlement-key}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

entitlement-key

path

Yes

string

Generated header parameter. Example value =’A1011335324f’

Request

Headers

provider: Generated header parameter. Example value ='root'

Responses

204

Security

Security Schema

Scopes

Secured

GET ``/api/v2/licenses/providers/{provider-name}}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

Request

Headers

provider: Generated header parameter. Example value ='root'

Responses

200

Type: array of License

Example:

[
    {
        "activation-status": "somestring",
        "active-appliances": 1,
        "alloted-bandwidth": 1,
        "alloted-devices": 1,
        "billing-serials": "somestring",
        "check-in-frequency": 1,
        "created-at": "somestring",
        "current-revision-id": 1,
        "default-allocated-bandwidth": 1,
        "description": "somestring",
        "entitlement-key": "somestring",
        "expires-at": "somestring",
        "last-modified-at": "somestring",
        "license-json": "somestring",
        "license-name": "somestring",
        "license-platform": "somestring",
        "license-product": "somestring",
        "license-type": "somestring",
        "licensed-device-list": [
            {
                "alloted-bandwidth": 1,
                "capacity-unit": "somestring",
                "cluster-name": "somestring",
                "description": "somestring",
                "device-id": "somestring",
                "device-name": "somestring"
            },
            {
                "alloted-bandwidth": 1,
                "capacity-unit": "somestring",
                "cluster-name": "somestring",
                "description": "somestring",
                "device-id": "somestring",
                "device-name": "somestring"
            }
        ],
        "max-allocated-bandwidth": 1,
        "min-allocated-bandwidth": 1,
        "notes": "somestring",
        "provider-id": "somestring",
        "provider-name": "somestring",
        "remaining-bandwidth": 1,
        "remaining-devices": 1,
        "used-activations": 1,
        "used-bandwidth": 1,
        "used-devices": 1
    },
    {
        "activation-status": "somestring",
        "active-appliances": 1,
        "alloted-bandwidth": 1,
        "alloted-devices": 1,
        "billing-serials": "somestring",
        "check-in-frequency": 1,
        "created-at": "somestring",
        "current-revision-id": 1,
        "default-allocated-bandwidth": 1,
        "description": "somestring",
        "entitlement-key": "somestring",
        "expires-at": "somestring",
        "last-modified-at": "somestring",
        "license-json": "somestring",
        "license-name": "somestring",
        "license-platform": "somestring",
        "license-product": "somestring",
        "license-type": "somestring",
        "licensed-device-list": [
            {
                "alloted-bandwidth": 1,
                "capacity-unit": "somestring",
                "cluster-name": "somestring",
                "description": "somestring",
                "device-id": "somestring",
                "device-name": "somestring"
            },
            {
                "alloted-bandwidth": 1,
                "capacity-unit": "somestring",
                "cluster-name": "somestring",
                "description": "somestring",
                "device-id": "somestring",
                "device-name": "somestring"
            }
        ],
        "max-allocated-bandwidth": 1,
        "min-allocated-bandwidth": 1,
        "notes": "somestring",
        "provider-id": "somestring",
        "provider-name": "somestring",
        "remaining-bandwidth": 1,
        "remaining-devices": 1,
        "used-activations": 1,
        "used-bandwidth": 1,
        "used-devices": 1
    }
]

Security

Security Schema

Scopes

Secured

GET ``/api/v2/licenses/providers/{provider-name}/entitlementkey/{entitlement-key}/auditlogs``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

entitlement-key

path

Yes

string

Generated header parameter. Example value =’A1011335324f’

Request

Headers

provider: Generated header parameter. Example value ='root'

Responses

200

Type: array of AuditLogResponse_Array

Example:

[
    {
        "action": "somestring",
        "action-log": "somestring",
        "activation-status": "somestring",
        "alloted-bandwidth": 1,
        "alloted-devices": 1,
        "entitlement-key": "somestring",
        "expires-at": "somestring",
        "last-modified-at": "somestring",
        "license-type": "somestring",
        "provider-id": "somestring",
        "resource": "somestring",
        "revision-id": 1,
        "used-bandwidth": 1,
        "used-devices": 1
    },
    {
        "action": "somestring",
        "action-log": "somestring",
        "activation-status": "somestring",
        "alloted-bandwidth": 1,
        "alloted-devices": 1,
        "entitlement-key": "somestring",
        "expires-at": "somestring",
        "last-modified-at": "somestring",
        "license-type": "somestring",
        "provider-id": "somestring",
        "resource": "somestring",
        "revision-id": 1,
        "used-bandwidth": 1,
        "used-devices": 1
    }
]

Security

Security Schema

Scopes

Secured

GET ``/api/v2/licenses/providers/{provider-name}}/licenseinfo/{entitlement-key}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

entitlement-key

path

Yes

string

Generated header parameter. Example value =’A1011335324f’

Request

Headers

provider: Generated header parameter. Example value ='root'

Responses

200

Type: LicenseDetailResponse

Example:

{
    "activation-status": "somestring",
    "active-appliances": 1,
    "alloted-bandwidth": 1,
    "alloted-devices": 1,
    "billing-serials": "somestring",
    "check-in-frequency": 1,
    "created-at": "somestring",
    "current-revision-id": 1,
    "default-allocated-bandwidth": 1,
    "description": "somestring",
    "entitlement-key": "somestring",
    "expires-at": "somestring",
    "glm-created-at": "somestring",
    "glm-lic-type": "somestring",
    "glm-updated-at": "somestring",
    "last-modified-at": "somestring",
    "license-id": "somestring",
    "license-json": "somestring",
    "license-name": "somestring",
    "license-platform": "somestring",
    "license-type": "somestring",
    "licensed-device-list": [
        {},
        {}
    ],
    "max-allocated-bandwidth": 1,
    "min-allocated-bandwidth": 1,
    "notes": "somestring",
    "provider-id": "somestring",
    "provider-name": "somestring",
    "remaining-bandwidth": 1,
    "remaining-devices": 1,
    "used-activations": 1,
    "used-bandwidth": 1,
    "used-devices": 1
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/licenses/providers/{provider-name}}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int32

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

glm-created-at

No

string

glm-lic-type

No

string

glm-updated-at

No

string

last-modified-at

No

string

license-id

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-type

No

string

licensed-device-list

No

array of licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Licensed-device-list schema:

{
    "active-appliances": 1,
    "alloted-bandwidth": 1,
    "alloted-devices": 1,
    "billing-serials": "somestring",
    "check-in-frequency": 1,
    "created-at": "somestring",
    "current-revision-id": 1,
    "default-allocated-bandwidth": 1,
    "description": "somestring",
    "entitlement-key": "somestring",
    "expires-at": "somestring",
    "glm-created-at": "somestring",
    "glm-lic-type": "somestring",
    "glm-updated-at": "somestring",
    "last-modified-at": "somestring",
    "license-id": "somestring",
    "license-json": "somestring",
    "license-name": "somestring",
    "license-platform": "somestring",
    "license-type": "somestring",
    "licensed-device-list": [
        {},
        {}
    ],
    "max-allocated-bandwidth": 1,
    "min-allocated-bandwidth": 1,
    "notes": "somestring",
    "remaining-bandwidth": 1,
    "remaining-devices": 1,
    "used-activations": 1,
    "used-bandwidth": 1,
    "used-devices": 1
}

Responses

201

Type: CreateLicenseResponse

Example:

{
    "activation-status": "somestring",
    "active-appliances": 1,
    "alloted-bandwidth": 1,
    "alloted-devices": 1,
    "billing-serials": "somestring",
    "check-in-frequency": 1,
    "created-at": "somestring",
    "current-revision-id": 1,
    "default-allocated-bandwidth": 1,
    "description": "somestring",
    "entitlement-key": "somestring",
    "expires-at": "somestring",
    "glm-created-at": "somestring",
    "glm-lic-type": "somestring",
    "glm-updated-at": "somestring",
    "last-modified-at": "somestring",
    "license-id": "somestring",
    "license-json": "somestring",
    "license-name": "somestring",
    "license-platform": "somestring",
    "license-type": "somestring",
    "licensed-device-list": [
        {},
        {}
    ],
    "max-allocated-bandwidth": 1,
    "min-allocated-bandwidth": 1,
    "notes": "somestring",
    "provider-id": "somestring",
    "provider-name": "somestring",
    "remaining-bandwidth": 1,
    "remaining-devices": 1,
    "used-activations": 1,
    "used-bandwidth": 1,
    "used-devices": 1
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/licenses/providers/{provider-name}/change/device/{device-uuid}/HC_LICENSE/newkey/{entitlement-key}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

device-uuid

path

Yes

string

Generated header parameter. Example value =’3790CAF73D24CF63E183901ACD9DFC90B01EFE6A’

entitlement-key

path

Yes

string

Generated header parameter. Example value =’A1011335324f’

Request

Headers

provider: Generated header parameter. Example value ='root'
[
    "somestring",
    "somestring"
]

Responses

200

Type: UpdateDeviceLicenseKeyResponse

Example:

{
    "activation-status": "somestring",
    "active-appliances": 1,
    "alloted-bandwidth": 1,
    "alloted-devices": 1,
    "billing-serials": "somestring",
    "check-in-frequency": 1,
    "created-at": "somestring",
    "current-revision-id": 1,
    "default-allocated-bandwidth": 1,
    "description": "somestring",
    "entitlement-key": "somestring",
    "expires-at": "somestring",
    "last-modified-at": "somestring",
    "license-json": "somestring",
    "license-name": "somestring",
    "license-platform": "somestring",
    "license-product": "somestring",
    "license-type": "somestring",
    "licensed-device-list": [
        {
            "alloted-bandwidth": 1,
            "capacity-unit": "somestring",
            "cluster-name": "somestring",
            "description": "somestring",
            "device-id": "somestring",
            "device-name": "somestring"
        },
        {
            "alloted-bandwidth": 1,
            "capacity-unit": "somestring",
            "cluster-name": "somestring",
            "description": "somestring",
            "device-id": "somestring",
            "device-name": "somestring"
        }
    ],
    "max-allocated-bandwidth": 1,
    "min-allocated-bandwidth": 1,
    "notes": "somestring",
    "provider-id": "somestring",
    "provider-name": "somestring",
    "remaining-bandwidth": 1,
    "remaining-devices": 1,
    "used-activations": 1,
    "used-bandwidth": 1,
    "used-devices": 1
}

Security

Security Schema

Scopes

Secured

PUT ``/api/v2/licenses/providers/{provider-name}/entitlementkey/{entitlement-key}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

entitlement-key

path

Yes

string

Generated header parameter. Example value =’A1011335324f’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int64

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

glm-created-at

No

string

glm-lic-type

No

string

glm-updated-at

No

string

last-modified-at

No

string

license-id

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-type

No

string

licensed-device-list

No

array of licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Licensed-device-list schema:

{
    "active-appliances": 1,
    "alloted-bandwidth": 1,
    "alloted-devices": 1,
    "billing-serials": "somestring",
    "check-in-frequency": 1,
    "created-at": "somestring",
    "current-revision-id": 1,
    "default-allocated-bandwidth": 1,
    "description": "somestring",
    "entitlement-key": "somestring",
    "expires-at": "somestring",
    "glm-created-at": "somestring",
    "glm-lic-type": "somestring",
    "glm-updated-at": "somestring",
    "last-modified-at": "somestring",
    "license-id": "somestring",
    "license-json": "somestring",
    "license-name": "somestring",
    "license-platform": "somestring",
    "license-type": "somestring",
    "licensed-device-list": [
        {},
        {}
    ],
    "max-allocated-bandwidth": 1,
    "min-allocated-bandwidth": 1,
    "notes": "somestring",
    "remaining-bandwidth": 1,
    "remaining-devices": 1,
    "used-activations": 1,
    "used-bandwidth": 1,
    "used-devices": 1
}

Responses

200

Type: UpdateLicenseResponse

Example:

{
    "activation-status": "somestring",
    "active-appliances": 1,
    "alloted-bandwidth": 1,
    "alloted-devices": 1,
    "billing-serials": "somestring",
    "check-in-frequency": 1,
    "created-at": "somestring",
    "current-revision-id": 1,
    "default-allocated-bandwidth": 1,
    "description": "somestring",
    "entitlement-key": "somestring",
    "expires-at": "somestring",
    "glm-created-at": "somestring",
    "glm-lic-type": "somestring",
    "glm-updated-at": "somestring",
    "last-modified-at": "somestring",
    "license-id": "somestring",
    "license-json": "somestring",
    "license-name": "somestring",
    "license-platform": "somestring",
    "license-type": "somestring",
    "licensed-device-list": [
        {},
        {}
    ],
    "max-allocated-bandwidth": 1,
    "min-allocated-bandwidth": 1,
    "notes": "somestring",
    "provider-id": "somestring",
    "provider-name": "somestring",
    "remaining-bandwidth": 1,
    "remaining-devices": 1,
    "used-activations": 1,
    "used-bandwidth": 1,
    "used-devices": 1
}

Security

Security Schema

Scopes

Secured

Data Structures

Audit Log Response Array Model Structure

Name

Required

Type

Format

Properties

Description

action

No

string

action-log

No

string

activation-status

No

string

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

entitlement-key

No

string

expires-at

No

string

last-modified-at

No

string

license-type

No

string

provider-id

No

string

resource

No

string

revision-id

No

integer

int64

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Create License Request Model Structure

Name

Required

Type

Format

Properties

Description

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int32

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

glm-created-at

No

string

glm-lic-type

No

string

glm-updated-at

No

string

last-modified-at

No

string

license-id

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-type

No

string

licensed-device-list

No

array of licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Licensed-device-list schema:

Create License Response Model Structure

Name

Required

Type

Format

Properties

Description

activation-status

No

string

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int64

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

glm-created-at

No

string

glm-lic-type

No

string

glm-updated-at

No

string

last-modified-at

No

string

license-id

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-type

No

string

licensed-device-list

No

array of licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

provider-id

No

string

provider-name

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Licensed-device-list schema:

License Model Structure

Name

Required

Type

Format

Properties

Description

activation-status

No

string

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int64

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

last-modified-at

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-product

No

string

license-type

No

string

licensed-device-list

No

array of Licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

provider-id

No

string

provider-name

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

License Detail Response Model Structure

Name

Required

Type

Format

Properties

Description

activation-status

No

string

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int32

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

glm-created-at

No

string

glm-lic-type

No

string

glm-updated-at

No

string

last-modified-at

No

string

license-id

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-type

No

string

licensed-device-list

No

array of licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

provider-id

No

string

provider-name

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Licensed-device-list schema:

Licensed Device List Model Structure

Name

Required

Type

Format

Properties

Description

alloted-bandwidth

No

integer

int32

capacity-unit

No

string

cluster-name

No

string

description

No

string

device-id

No

string

device-name

No

string

Update Device License Key Response Model Structure

Name

Required

Type

Format

Properties

Description

activation-status

No

string

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int64

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

last-modified-at

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-product

No

string

license-type

No

string

licensed-device-list

No

array of Licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

provider-id

No

string

provider-name

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Update License Request Model Structure

Name

Required

Type

Format

Properties

Description

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int64

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

glm-created-at

No

string

glm-lic-type

No

string

glm-updated-at

No

string

last-modified-at

No

string

license-id

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-type

No

string

licensed-device-list

No

array of licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Licensed-device-list schema:

Update License Response Model Structure

Name

Required

Type

Format

Properties

Description

activation-status

No

string

active-appliances

No

integer

int32

alloted-bandwidth

No

integer

int32

alloted-devices

No

integer

int32

billing-serials

No

string

check-in-frequency

No

integer

int32

created-at

No

string

current-revision-id

No

integer

int32

default-allocated-bandwidth

No

integer

int32

description

No

string

entitlement-key

No

string

expires-at

No

string

glm-created-at

No

string

glm-lic-type

No

string

glm-updated-at

No

string

last-modified-at

No

string

license-id

No

string

license-json

No

string

license-name

No

string

license-platform

No

string

license-type

No

string

licensed-device-list

No

array of licensed-device-list

max-allocated-bandwidth

No

integer

int32

min-allocated-bandwidth

No

integer

int32

notes

No

string

provider-id

No

string

provider-name

No

string

remaining-bandwidth

No

integer

int32

remaining-devices

No

integer

int32

used-activations

No

integer

int32

used-bandwidth

No

integer

int32

used-devices

No

integer

int32

Licensed-device-list schema: