Add License Key

Add License Key

Add a a new license key

Request
URI
POST
https://{api_host}/v1/license-keys
COPY
Request Body
LicenseKey of type(s) application/json
Required

Show optional properties

{
    "key": "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
    "productType": "One among: VCENTER, VSAN, ESXI, NSXT, WCP",
    "description": "string"
}
{
    "id": "string",
    "key": "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX ",
    "productType": "One among: VCENTER, VSAN, ESXI, NSXT, WCP",
    "description": "string",
    "productVersion": "string",
    "isUnlimited": false,
    "licenseKeyUsage": {
        "total": 0,
        "remaining": 0,
        "used": 0,
        "licenseUnit": "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER, CPUCORE, TIB"
    },
    "licenseKeyValidity": {
        "licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
        "expiryDate": "string"
    },
    "features": [
        "string"
    ],
    "licenseEdition": "string",
    "licenseUnit": "string",
    "minimumCore": 0
}
string
id
Optional

The ID of the license key

string As (((?![BIOS_])\w){5}-){4}?((?![BIOS_])\w){5}?
key
Required
Constraints: minLength: 29 maxLength: 29

The 29 alpha numeric character license key with hyphens

string
productType
Required

The type of the product to which the license key is applicable

string
description
Required

Description of the license key given by user

string
productVersion
Optional

Product version

boolean
isUnlimited
Optional

Indicates if the license key has unlimited usage

object
licenseKeyUsage
Optional

Defines license key usage

object
licenseKeyValidity
Optional

Defines license key validity details

array of string
features
Optional

License key features

string
licenseEdition
Optional

License key edition

string
licenseUnit
Optional

License capacity unit

integer As int32 As int32
minimumCore
Optional

The minimum number of core licenses required per CPU, when license unit is cpu core

Responses
201

Created

Operation doesn't return any data structure

500

Internal server error

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"description:"string","key:"string","productType:"string"}' https://{api_host}/v1/license-keys
On This Page
License Keys Operations
PUT
Set License Key For Resource
POST
Start License Check By Resource
GET
Get License Keys
POST
Add License Key
PATCH
Update License Key
GET
Get License Check Result By ID
GET
Get License Information
GET
Get System Licensing Info
GET
Get Domain Licensing Info
GET
Get License Key
DELETE
Remove License Key
GET
Get License Product Types