Skip to main content

Retrieve a license by type

Contributors

GET /license/licenses

Retrieves a specified licence by type (LicenseType) and/or resource ID (resourceId).

The license endpoints consult the used or consumed capacity under the includeSummaryInfo parameter
when retrieving licenses with the GET API call.

Note:

  • If you use a BlueXP service token, accountId is not a required field

  • If you use a BlueXP user token, accountId is a required field

  • When you enter a value in serialNumber , all other fields are ignored

  • The boolean parameter includeSummaryInfo (optional) retrieves the totalLicensesCapacity, usedCapacity, reportTime and events such as capacity expired or about to expire for each data service (CLOUD_BACKUP, CLOUD_DATA_SENSE, CLOUD_TIERING).

  • The boolean parameter fetchNlf (optional) retrieves the most updated valid NetApp license file from NetApp systems.

  • If you use the boolean parameter fetchNlf, you must provide accountId, serialNumber, and nssKeyId.

  • fetchNlf and includeSummaryInfo can't be provided in the same request.

Token usage: Either a BlueXP user token or service token.

Parameters

Name Type In Required Description

accountId

string

query

False

serialNumber

["string", "null"]

query

False

resourceId

string

query

False

licenseType

string

query

False

service

string

query

False

group

string

query

False

includeSummaryInfo

boolean

query

False

includeExchangedLicenses

boolean

query

False

fetchNlf

boolean

query

False

nssKeyId

string

query

False

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Default Response

Response

Status: 4xx, Error response
Name Type Required Description

errorCode

string

False

error code

error

string

False

Error code/category

message

string

False

Error description message
Example response 
{
  "errorCode": "string",
  "error": "string",
  "message": "string"
}
Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response