Start License Check By Resource

Start a license check for a resource

Request

URI

POST

https://{api_host}/v1/resources/license-checks

COPY

Request Body

ResourcesLicenseCheckSpec of type(s) application/json

Required

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

array of LicenseCheckResource

licenseCheckResources

Optional

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

boolean

forAllDomains

Optional

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

Responses

202

Accepted

Returns ResourcesLicenseCheckResult of type(s) */*

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

string

Optional

ID of the resources license check task

string

startTimestamp

Optional

Task start timestamp

string

endTimestamp

Optional

Task end timestamp

string

status

Optional

Task status

array of ResourceLicensingInfo

resourceLicensingInfos

Optional

List of licensing infos of resources

400

Bad Request

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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 ErrorCause

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.

500

Internal server error

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

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.