NSX-T Data Center REST API

Deprecated. Assign an Updated Enterprise License Key (Deprecated)

Deprecated. Use the POST /licenses API instead

Request:

Method:

PUT

URI Path(s):

/api/v1/license

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

License+

License (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
capacity_type	license metric License metrics specifying the capacity type of license key. Types are: - VM - CPU - USER(Concurrent User) - CORE - HOST	string	Readonly Enum: VM, CPU, USER, CORE, HOST
description	license edition	string	Readonly
expiry	date that license expires	EpochMsTimestamp	Readonly
features	semicolon delimited feature list	string	Readonly
is_eval	true for evalution license	boolean	Readonly
is_expired	whether the license has expired	boolean	Readonly
is_mh	multi-hypervisor support	boolean	Readonly
license_key	license key	string	Required Pattern: "^[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}$"
product_name	product name	string	Readonly
product_version	product version	string	Readonly
quantity	license capacity; 0 for unlimited	integer	Readonly

Example Request:

PUT https://<nsx-mgr>/api/v1/license { "license_key": "00000-00000-00000-00000-00000" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

License+

License (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
capacity_type	license metric License metrics specifying the capacity type of license key. Types are: - VM - CPU - USER(Concurrent User) - CORE - HOST	string	Readonly Enum: VM, CPU, USER, CORE, HOST
description	license edition	string	Readonly
expiry	date that license expires	EpochMsTimestamp	Readonly
features	semicolon delimited feature list	string	Readonly
is_eval	true for evalution license	boolean	Readonly
is_expired	whether the license has expired	boolean	Readonly
is_mh	multi-hypervisor support	boolean	Readonly
license_key	license key	string	Required Pattern: "^[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}-[A-Z0-9]{5}$"
product_name	product name	string	Readonly
product_version	product version	string	Readonly
quantity	license capacity; 0 for unlimited	integer	Readonly

Example Response:

{ "capacity_type": "CPU", "is_expired": false, "quantity": 4, "is_eval": false, "description": "NSX for vSphere - Standard", "expiry": 0, "license_key": "00000-00000-00000-00000-00000" }

Required Permissions:

crud

Feature:

system_configuration_license

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable