License Keys APIs

APIs for managing License Keys

Table of Contents

Add a License Key
Get the License Keys
Get a License Key
Delete a License Key

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 API

The following data is required

License key
Product type
License key description

1.2. Steps API

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

1.3. Related APIs API

[_addlicensekey] API

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 API

None
Get All License Keys

2.2. Steps API

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: 1038

{
  "elements" : [ {
    "id" : "61fa1fe8-0347-41ec-9560-03e66385c717",
    "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"
    },
    "features" : [ "item1", "item2", "item3" ],
    "licenseUnit" : "INSTANCE"
  }, {
    "id" : "c5585e89-4d2e-4f6d-89c2-f53ebe36bad8",
    "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"
    },
    "features" : [ ],
    "licenseUnit" : "VM"
  } ]
}

Get License Keys By Product Type

2.3. Steps API

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 API

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" : [ ]
}

2.5. Related APIs API

[_getlicensekeys] API [_getlicensekey] API

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 API

The following data is required

License key

3.2. Steps API

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: 492

{
  "id" : "55a53cff-16eb-48a3-8d58-a6faf9f37639",
  "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"
  },
  "features" : [ "item1", "item2", "item3" ],
  "licenseUnit" : "INSTANCE"
}

3.3. Related APIs API

[_getlicensekeys] API [_getlicensekey] API

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 API

The following data is required

License key

4.2. Steps API

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

4.3. Related APIs API

[_removelicensekey] API [_getlicensekeys] API [_getlicensekey] API
Last updated 2024-06-21 01:22:12 -0700

Operations

POST

Add License Key

Add a a new license key

GET

Get Domain Licensing Info

Get the Licensing information of a domain

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

GET

Get License Product Types

Get product types

GET

Get System Licensing Info

Get the Licensing information of system

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

PATCH

Update License Key

Update the license key