Get Release By Domain

Get Release By Domain

Get last selected upgrade version for the domain.

Request
URI
GET
https://{api_host}/v1/releases/domains/{domainId}
COPY
Path Parameters
string
domainId
Required

Domain ID to get target version of the domain

domainId example 
9ab78840-ee25-11e8-a8fc-d71c338107bd
Responses
200

Ok

Returns DomainReleaseView of type(s) application/json 
{
    "domainId": "string",
    "targetVersion": "string",
    "targetVxRailVersion": "string",
    "targetSddcManagerVersion": "string",
    "patches": [
        {
            "productType": "One among: SDDC_MANAGER, ESX, VCENTER, VXRAIL, NSX",
            "version": "string"
        }
    ],
    "isCustomizedBom": true
}
string
domainId
Required

Domain ID

string
targetVersion
Required

Target upgrade version of the domain

string
targetVxRailVersion
Optional

Target VxRail version

string
targetSddcManagerVersion
Optional

Target SDDC Manager version

array of object
patches
Optional

Target product release and patch versions

boolean
isCustomizedBom
Optional

Identifier for VCF Release vs Customized BOM


404

Domain not found

Returns Error of type(s) application/json 
"Error Object"
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 object
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

InternalServerError

Returns Error of type(s) application/json 
"Error Object"
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 object
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.


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/v1/releases/domains/{domainId}
On This Page
Target Upgrade Version Operations
POST
Validate Release By Domain ID
GET
Get Release By Domain
DELETE
Delete Release By Domain ID
PATCH
Update Release By Domain ID
GET
Get Release By Domains
GET
Get Domain Release View Validation