Start License Check By Resource

Start License Check By Resource

Start a license check for a resource

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/resources/license-checks
COPY
Request Body

Resources license check spec

ResourcesLicenseCheckSpec of type(s) application/json
Required 
{
    "forAllDomains": false,
    "licenseCheckResources": [
        {
            "productInfo": {
                "errorResponse": {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "context": {
                        "context": "string"
                    },
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                },
                "licenseKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
                "licenseKeyExpirationDate": "2021-04-08T04:37:51.662Z",
                "licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
                "licensingMode": "One among: SUBSCRIPTION, PERPETUAL",
                "type": "One among: VCENTER, NSXT, VSAN, WCP, ESXI"
            },
            "resourceInfo": {
                "clusterId": "a0bf0f65-f719-4c2d-980a-29a9094045b5",
                "domainId": "f0bf0f65-f719-4c2d-980a-29a9094045b5",
                "hostId": "b0bf0f65-f719-4c2d-980a-29a9094045b5"
            }
        }
    ]
}
boolean
forAllDomains
Optional

Value that defines whether to get license check for all domains or not

array of LicenseCheckResource
licenseCheckResources
Optional

A list of resources for which license check needs to be performed

Responses
200

OK

Returns ResourcesLicenseCheckResult of type(s) */* 
{
    "endTimestamp": "string",
    "id": "string",
    "resourceLicensingInfos": [
        {
            "productInfo": {
                "errorResponse": {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "context": {
                        "context": "string"
                    },
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                },
                "licenseKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
                "licenseKeyExpirationDate": "2021-04-08T04:37:51.662Z",
                "licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
                "licensingMode": "One among: SUBSCRIPTION, PERPETUAL",
                "type": "One among: VCENTER, NSXT, VSAN, WCP, ESXI"
            },
            "resourceInfo": {
                "clusterId": "a0bf0f65-f719-4c2d-980a-29a9094045b5",
                "domainId": "f0bf0f65-f719-4c2d-980a-29a9094045b5",
                "hostId": "b0bf0f65-f719-4c2d-980a-29a9094045b5"
            }
        }
    ],
    "startTimestamp": "string",
    "status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED"
}
string
endTimestamp
Optional

Task end timestamp

string
id
Optional

ID of the resources license check task

array of ResourceLicensingInfo
resourceLicensingInfos
Optional

List of licensing infos of resources

string
startTimestamp
Optional

Task start timestamp

string
status
Optional

Task status


202

Accepted

Returns ResourcesLicenseCheckResult of type(s) */* 
{
    "endTimestamp": "string",
    "id": "string",
    "resourceLicensingInfos": [
        {
            "productInfo": {
                "errorResponse": {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "context": {
                        "context": "string"
                    },
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                },
                "licenseKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
                "licenseKeyExpirationDate": "2021-04-08T04:37:51.662Z",
                "licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
                "licensingMode": "One among: SUBSCRIPTION, PERPETUAL",
                "type": "One among: VCENTER, NSXT, VSAN, WCP, ESXI"
            },
            "resourceInfo": {
                "clusterId": "a0bf0f65-f719-4c2d-980a-29a9094045b5",
                "domainId": "f0bf0f65-f719-4c2d-980a-29a9094045b5",
                "hostId": "b0bf0f65-f719-4c2d-980a-29a9094045b5"
            }
        }
    ],
    "startTimestamp": "string",
    "status": "One among: PENDING, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED"
}
string
endTimestamp
Optional

Task end timestamp

string
id
Optional

ID of the resources license check task

array of ResourceLicensingInfo
resourceLicensingInfos
Optional

List of licensing infos of resources

string
startTimestamp
Optional

Task start timestamp

string
status
Optional

Task status


400

Bad Request

Returns Error of type(s) */* 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


500

Internal server error

Returns Error of type(s) */* 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


On This Page
License Keys Operations
POST
Add License Key
GET
Get License Check Result By ID
GET
Get License Information
GET
Get License Key
GET
Get License Keys
DELETE
Remove License Key
PUT
Set License Key For Resource
POST
Start License Check By Resource
PATCH
Update License Information