Skip to main content

Associate a license

Contributors

POST /license/serial-number/{serialNumber}

Associates a license with BlueXP either by providing a NetApp License File (NLF) in the license body field
or a value for both the serialNumber query parameter and nssKeyId body field.

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

  • serialNumber is a required field when using this site. In general, you can specify its value as null.

  • If the value of licenseType is EXTRA_CAPACITY, you must provide the associated resource ID (resourceId)

  • licenseType is not a required field for data services and capacity based license types

  • expirationDate is a required field unless you are registered with the NetApp Support Site

  • license is not a required field if values for serialnumber and nssKeyId are provided

  • capacity is a required field unless you are registered with the NetApp Support Site

  • packageValue is a required field (used only for internal purposes) unless you are registered with the NetApp Support Site

  • metadata is not a required field and is used to add additional data to a license that is not included in other request body fields

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

Parameters

Name Type In Required Description

serialNumber

["string", "null"]

path

True

X-Service-Request-Id

string

header

False

Request identifier

Request Body

Name Type Required Description

accountId

string

False

resourceId

["string", "null"]

False

licenseType

string

False

expirationDate

["integer", "null"]

False

license

string

False

capacity

["integer", "null"]

False

metadata

["array", "null"]

False

nssKeyId

string

False
Example request 
{
  "accountId": "string",
  "licenseType": "string",
  "license": "string",
  "nssKeyId": "string"
}

Response

Status: 200, Success 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