RegKey Pool¶

Overview¶

You can use this API to create a RegKey pool. You can activate the registration keys of a RegKey pool using the RegKey Pool Offerings API. You can assign registration keys from the RegKey pool and revoke keys from a BIG-IP using the RegKey Pool Members API or the License Assign/Revoke API. An administrator, device manager, or license manager role is required to use this API.

REST Endpoint: /mgmt/cm/device/licensing/pool/regkey/licenses¶

Requests¶

GET /mgmt/cm/device/licensing/pool/regkey/licenses¶

Request Parameters¶

None

Query Parameters¶

None

Response¶

The JSON in the body of a GET response can contain the following parameters.

HTTP/1.1 200 OK

Name	Type	Description
items	array	A list of existing RegKey pools.
id	string	Identifier for the RegKey pool.
name	string	Name of the RegKey pool.
selfLink	string	An url for the specific RegKey pool.
sortName	string	This value is used by the UI.
selfLink	string	An url for the RegKey pool collection.

Permissions¶

Role	Allow
device_manager	Yes
License_Manager	Yes

POST /mgmt/cm/device/licensing/pool/regkey/licenses¶

To create a RegKey pool, you can send a POST request to the collection.

Request Parameters¶

The JSON in the body of a POST request can contain the following parameters.

Name	Type	Required	Description
description	string	Yes	Description of the RegKey pool.
name	string	Yes	Name of the RegKey pool.

Query Parameters¶

None

Response¶

The JSON in the body of the response can contain the following parameters.

HTTP/1.1 200 OK

Name	Type	Description
description	string	Description of the RegKey pool.
id	string	Identifier of the RegKey pool.
name	string	Name of the RegKey pool.
selfLink	string	An url for the specific RegKey pool.
sortName	string	This value is used by the UI.

Permissions¶

Role	Allow
device_manager	Yes
License_Manager	Yes

PATCH /mgmt/cm/device/licensing/pool/regkey/licenses/{id}¶

To update the name or description of a RegKey pool you can send a PATCH request to the specific license endpoint.

Request Parameters¶

The JSON in the body of a PATCH request can contain the following parameters.

Name	Type	Required	Description
description	string	Yes to update the description.	Updated description of the RegKey pool.
name	string	Yes to update the name.	Updated name of the RegKey pool.

Query Parameters¶

None

Response¶

The JSON in the body of response can contain the following parameters.

HTTP/1.1 200 OK

Name	Type	Description
description	string	Updated description of the RegKey pool.
id	string	Identifier of the RegKey pool.
name	string	Updated name of the RegKey pool.
selfLink	string	An url for the specific RegKey pool.
sortName	string	This value is used by the UI.

Permissions¶

Role	Allow
device_manager	Yes
License_Manager	Yes

DELETE /mgmt/cm/device/licensing/pool/regkey/licenses/{id}¶

To remove a RegKey pool you can send a DELETE request to the specific license endpoint.

Note: You cannot delete a RegKey pool if it includes one or more registration keys assigned to a BIG-IP.

Request Parameters¶

None

Query Parameters¶

None

Response¶

The JSON in the body of the response is for the deleted RegKey pool.

HTTP/1.1 200 OK

Name	Type	Description
description	string	Description of the RegKey pool.
id	string	Identifier of the RegKey pool.
name	string	Name of the RegKey pool.
selfLink	string	An url for the specific RegKey pool.
sortName	string	This value is used by the UI.

Permissions¶

Role	Allow
device_manager	Yes
License_Manager	Yes

Examples¶

GET to query existing RegKey pools¶

You can send a GET request to the collection to list all the existing RegKey pools.

GET https://<BIG-IQ>/mgmt/cm/device/licensing/pool/regkey/licenses

Response¶

The JSON in the GET’s response can look similar to the following example.

{
    "items": [
      {
        "id": "cc010b7d-9c9e-40a9-9668-321f4ebc26f6",
        "name": "RegKey Pool #1",
        "sortName": "Registration Key Pool",
        "generation": 1,
        "lastUpdateMicros": 1488535202069037,
        "kind": "cm:device:licensing:pool:regkey:licenses:regkeypoollicensestate",
        "selfLink": "https://localhost/mgmt/cm/device/licensing/pool/regkey/licenses/cc010b7d-9c9e-40a9-9668-321f4ebc26f6"
      }
    ],
    "generation": 6,
    "kind": "cm:device:licensing:pool:regkey:licenses:regkeypoollicensecollectionstate",
    "lastUpdateMicros": 1488535202076692,
    "selfLink": "https://localhost/mgmt/cm/device/licensing/pool/regkey/licenses"
}

POST to create a new RegKey pool¶

To create a new RegKey pool, send a POST to the collection endpoint.

POST https://<BIG-IQ>/mgmt/cm/device/licensing/pool/regkey/licenses

The JSON in the body can contain the following parameters.

{
    "name": "RegKey Pool #2",
    "description": "Custom description"
}

Response¶

The JSON in the response can look similar to the following example. Note that the body include an id and selfLink for the new RegKey pool.

HTTP/1.1 200 OK

{
    "id": "150102a0-66ec-411f-8776-221019f430f3",
    "name": "RegKey Pool #2",
    "description": "Custom description",
    "sortName": "Registration Key Pool",
    "generation": 1,
    "lastUpdateMicros": 1488535345324793,
    "kind": "cm:device:licensing:pool:regkey:licenses:regkeypoollicensestate",
    "selfLink": "https://localhost/mgmt/cm/device/licensing/pool/regkey/licenses/150102a0-66ec-411f-8776-221019f430f3"
}

PATCH to change the name or description of a RegKey pool¶

You can change the name or description of a RegKey pool by sending a PATCH request to the specific license endpoint.

PATCH https://<BIG-IQ>/mgmt/cm/device/licensing/pool/regkey/licenses/{id}

The JSON in the body of the PATCH request can look similar to the following example.

{
    "name": "RegKey pool #2 - updated",
    "description": "Updated description"
}

Response¶

The JSON in the body of the response can look similar to the following example.

HTTP/1.1 200 OK

{
    "id": "150102a0-66ec-411f-8776-221019f430f3",
    "name": "RegKey Pool #2 - updated",
    "description": "Updated description",
    "sortName": "Registration Key Pool",
    "generation": 2,
    "lastUpdateMicros": 1488535758312642,
    "kind": "cm:device:licensing:pool:regkey:licenses:regkeypoollicensestate",
    "selfLink": "https://localhost/mgmt/cm/device/licensing/pool/regkey/licenses/150102a0-66ec-411f-8776-221019f430f3"
}

DELETE to remove a RegKey pool¶

You can remove a RegKey pool by sending a DELETE request to the specific license endpoint.

Note: You cannot delete a RegKey pool if it includes one or more registration keys that have been assigned to a BIG-IP.

DELETE https://<BIG-IQ>/mgmt/cm/device/licensing/pool/regkey/licenses/{id}

Response¶

HTTP/1.1 200 OK

Previous Next