License Keys APIs
APIs for managing License Keys
Table of Contents
1. Add a License Key
This API is used to add a license key.
Adding a license key which is already added , will give an error.
Tip : Refer to: Get a License Key to check if a license key is already present.
- Adding an incorrect (key size and format) or an invalid license key (invalid or expired), will give an error.
1.1. Prerequisites
The following data is required
License key
Product type
License key description
1.2. Steps
- Invoke the API
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/license-keys' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....' \
-d '{
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
"productType" : "NSXT",
"description" : "NSXT license key"
}'
HTTP Request
POST /v1/license-keys HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 109
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
{
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
"productType" : "NSXT",
"description" : "NSXT license key"
}
HTTP Response
HTTP/1.1 201 Created
Location: /v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX
2. Get the License Keys
This API is used to get all the license keys.
This also gives the license key metrics like usage and validity of a license key.
License keys can be filtered based on product type and/or license key status.
2.1. Prerequisites
None
Get All License Keys
2.2. Steps
- Invoke the API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/license-keys' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/license-keys HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 910
{
"elements" : [ {
"id" : "47dfde8d-31c7-4ccb-b2a7-8860f59b8dda",
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
"productType" : "VCENTER",
"description" : "vCenter license key",
"isUnlimited" : false,
"licenseKeyUsage" : {
"total" : 5,
"remaining" : 4,
"used" : 1,
"licenseUnit" : "INSTANCE"
},
"licenseKeyValidity" : {
"licenseKeyStatus" : "ACTIVE",
"expiryDate" : "2029-05-23T16:12:53.001Z"
}
}, {
"id" : "3f4adf31-a45d-497b-8e04-a910af88d295",
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
"productType" : "NSXT",
"description" : "NSX license key",
"isUnlimited" : false,
"licenseKeyUsage" : {
"total" : 15,
"remaining" : 14,
"used" : 1,
"licenseUnit" : "VM"
},
"licenseKeyValidity" : {
"licenseKeyStatus" : "ACTIVE",
"expiryDate" : "2029-05-23T16:12:53.001Z"
}
} ]
}
Get License Keys By Product Type
2.3. Steps
- Invoke the API by specifying the _"productType".
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/license-keys?productType=VCENTER,ESXI' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/license-keys?productType=VCENTER,ESXI HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 22
{
"elements" : [ ]
}
Get License Keys By Status Of The License Key
2.4. Steps
- Invoke the API by specifying the _"licenseKeyStatus".
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/license-keys?licenseKeyStatus=ACTIVE,NEVER_EXPIRES' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/license-keys?licenseKeyStatus=ACTIVE,NEVER_EXPIRES HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 22
{
"elements" : [ ]
}
3. Get a License Key
This API is used to get the license key metrics like usage and validity of a license key.
If the license key does not exist, you will get an error.
3.1. Prerequisites
The following data is required
- License key
3.2. Steps
- Invoke the API
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 416
{
"id" : "0b8a5643-bec0-49bf-8bee-8af63cb60c28",
"key" : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX",
"productType" : "VCENTER",
"description" : "vCenter license key",
"isUnlimited" : false,
"licenseKeyUsage" : {
"total" : 5,
"remaining" : 4,
"used" : 1,
"licenseUnit" : "INSTANCE"
},
"licenseKeyValidity" : {
"licenseKeyStatus" : "ACTIVE",
"expiryDate" : "2029-05-23T16:12:53.001Z"
}
}
4. Delete a License Key
- This API is used to delete a license key.
Warning : Deleting a license key which is in use, will give an error.
4.1. Prerequisites
The following data is required
- License key
4.2. Steps
- Invoke the API
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX' -i -X DELETE \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
DELETE /v1/license-keys/XX0XX-XX0XX-XX0XX-XX0XX-XX0XX HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 204 No Content
Last updated 2024-03-14 07:59:42 -0700
Operations
POST
Add License Key
Add a a new license key
GET
Get License Check Result By ID
Retrieve the results of a license check by its ID
GET
Get License Information
Retrieve licensing information
GET
Get License Key
Retrieve a license key
GET
Get License Keys
Retrieve a list of license keys
DELETE
Remove License Key
Remove a license key
PUT
Set License Key For Resource
Update a license key for a resource
POST
Start License Check By Resource
Start a license check for a resource