Update Release By Domain ID

Update last selected upgrade version for the domain

Request

URI

PATCH

https://{api_host}/v1/releases/domains/{domainId}

COPY

Path Parameters

string

domainId

Required

Domain ID

domainId example

9ab78840-ee25-11e8-a8fc-d71c338107bd

Request Body

DomainRelease of type(s) application/json

Optional

{
    "targetVersion": "string",
    "targetVxRailVersion": "string",
    "targetSddcManagerVersion": "string",
    "patches": [
        {
            "productType": "One among: SDDC_MANAGER, ESX, VCENTER, VXRAIL, NSX",
            "version": "string"
        }
    ]
}

string

targetVersion

Optional

Target version

string

targetVxRailVersion

Optional

Target VxRail version

string

targetSddcManagerVersion

Optional

Target SDDC Manager version

array of TargetProductVersion

patches

Optional

Target product release and patch versions

Responses

200

Operation doesn't return any data structure

404

Domain or VCF target release not found

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

InternalServerError

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.