Cluster licensing licenses name endpoint overview

08/29/2024 Contributors

PDFs

Overview

Manages a specific instance of a license package.

Examples

Retrieving information for a specific license package

This example shows how to retrieve information about the specific feature package fabricpool.

# API
GET /cluster/licensing/licenses/fabricpool/

# Response
200 OK

# JSON Body
{
"name": "fabricpool",
"scope": "cluster",
"state": "compliant",
"licenses": [
{
  "owner": "testcluster-1",
  "serial_number": "123456789",
  "state": "compliant",
  "capacity": {
  "maximum_size": 109951162777600,
  "used_size": 0
  }
}
],
"_links": {
"self": {
  "href": "/api/cluster/licensing/licenses/fabricpool/"
}
}
}

Deleting a specific license

This example show how to delete a CIFS site license.

# API
DELETE /cluster/licensing/licenses/cifs/?serial_number=1-80-000011"

# JSON Body
{}

# Response
200 OK

Deleting with a query

The following example shows how to delete all NFS licenses specified with the '*' query.

# API
DELETE /cluster/licensing/licenses/nfs/?serial_number=*"

# JSON Body
{}

# Response
200 OK