Retrieve a license by type
Retrieves a specified license by type, resource ID, or both. Use this endpoint to access license details, including consumed capacity and summary information for data services when applicable.
HTTP method and endpoint
GET /license/licenses
Token usage
Either a NetApp Console user token or service token.
Usage notes
Retrieves a specified license by type (LicenseType), a resource ID (resourceId), or both.
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 NetApp Console service token, accountId is not a required field.
-
If you use a NetApp Console user token,
accountIdis a required field. -
When you enter a value in
serialNumber, all other fields are ignored. -
The boolean parameter
includeSummaryInfo(optional) retrieves thetotalLicensesCapacity,usedCapacity,reportTimeand 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 provideaccountId,serialNumber, andnssKeyId. -
fetchNlfandincludeSummaryInfocan't be provided in the same request.
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 |
|
eventTypes |
string |
query |
False |
|
meteringStatus |
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"
}