Get License Detail V2 Using GET

Get License Detail V2 Using GET

This API is used to get complete information of a License based on the vmid.

Request
URI
GET
https://{api_host}/lcm/locker/api/v2/licenses/detail/{vmid}
COPY
Path Parameters
string
vmid
Required

vmid

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LicenseResponseDTO of type(s) application/json 
{
    "End DateH": "string",
    "Start Date": "string",
    "account": "Admin",
    "alias": "license1",
    "casId": "string",
    "connected": false,
    "description": "VMware vRealize Suite 2019 Enterprise",
    "edition": "string",
    "endDate": 0,
    "expired": false,
    "expiresIn": "3 months and 28 days",
    "expiresOn": "Mon Jan 11 2021 00:00:00",
    "falconId": "string",
    "healthy": false,
    "key": "YK0AN-JO280-48RJ1-001124-1TV",
    "lastRefreshed": 0,
    "lintId": "string",
    "onPremAllocation": "string",
    "orgName": "string",
    "presentInMyVmware": false,
    "quantity": 32,
    "refreshStatus": "string",
    "status": "ACTIVE",
    "transactionId": "string",
    "type": "vRealizeSuite",
    "unit": "string",
    "validations": [
        {
            "message": "string",
            "strict": false
        }
    ],
    "vmid": "6c9fca27-678d-4e79-9a0f-5f690735e67c"
}
string
End DateH
Optional

End DateH

string
Start Date
Optional

Start Date

string
account
Optional

Account

string
alias
Optional

Alias for license

string
casId
Optional

casId

boolean
connected
Optional

connected

string
description
Optional

Description of License

string
edition
Optional

edition

Possible values are : ENTERPRISE, ADVANCED, STANDARD,
integer As int64 As int64
endDate
Optional

endDate

boolean
expired
Optional

expired

string
expiresIn
Optional

Expiry duration

string
expiresOn
Optional

Expiry Time

string
falconId
Optional

falconId

boolean
healthy
Optional

healthy

string
key
Optional

License Key

integer As int64 As int64
lastRefreshed
Optional

lastRefreshed

string
lintId
Optional

lintId

string
onPremAllocation
Optional

onPremAllocation

string
orgName
Optional

orgName

boolean
presentInMyVmware
Optional

presentInMyVmware

integer As int32 As int32
quantity
Optional

Quantity

string
refreshStatus
Optional

refreshStatus

string
status
Optional

License Status

string
transactionId
Optional

transactionId

string
type
Optional

Type

string
unit
Optional

Unit

array of ValidationResultDTO
validations
Optional

validations

string
vmid
Optional

vmid


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


On This Page
Locker License Controller Operations
GET
Get License Detail V2 Using GET
GET
Get Licenses By Alias V2 Using GET
GET
List Licenses V2 Using GET
GET
Refresh Licenses V2 Using GET
POST
Validate And Add License V2 Using POST