Skip to main content
A newer release of this product is available.

Retrieve license manager information

Contributors
PDFs

GET /cluster/licensing/license-managers/{uuid}

Introduced In: 9.8

Retrieves information about the license manager.

Learn more

  • system license license-manager show

Parameters

Name Type In Required Description

uuid

string

path

True

default

boolean

query

False

Filter by default

uri.host

string

query

False

Filter by uri.host

uuid

string

query

False

Filter by uuid

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

default

boolean

Flag that indicates whether it's the default license manager instance used by the cluster.' When a capacity pool is created and if the license manager field is omitted, it is assumed that the license of the capacity pool is installed on the default license manager instance.

uri

uri

License manager URI.

uuid

string
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "uri": {
    "host": "10.1.1.1"
  },
  "uuid": "4ea7a442-86d1-11e0-ae1c-112233445566"
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string
Name Type Description

self

href

uri

License manager URI.

Name Type Description

host

string

License manager host name, IPv4 or IPv6 address.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.