Update Depot Settings

Update Depot Settings
Configure depot settings

Updates the depot settings using a VMware Depot account. If a trusted certificate chain is provided for an offline HTTPS depot configuration, each certificate in the chain is added to the appliance trust stores (VCF CS keystore and JVM cacerts). The certificates are also propagated to the OS trust store (/etc/ssl/certs) on the VMs.

Request
URI
PUT
https://{api_host}/v1/system/settings/depot
COPY
Request Body
DepotSettings of type(s) application/json
Required   
{
    "vmwareAccount": {
        "username": "string",
        "password": "string",
        "status": "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
        "message": "string",
        "downloadToken": "string",
        "downloadActivationCode": "string"
    },
    "offlineAccount": {
        "username": "string",
        "password": "string",
        "status": "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
        "message": "string",
        "downloadToken": "string",
        "downloadActivationCode": "string"
    },
    "depotConfiguration": {
        "isOfflineDepot": false,
        "hostname": "string",
        "port": 0,
        "url": "string",
        "trustedCertificates": [
            "string"
        ]
    }
}
object
vmwareAccount
Optional

VMware Depot Account Information

object
offlineAccount
Optional

VMware Depot Account Information

object
depotConfiguration
Optional

Depot Configuration

Responses
202

Accepted

Returns DepotSettings of type(s) application/json 
{
    "vmwareAccount": {
        "username": "string",
        "password": "string",
        "status": "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
        "message": "string",
        "downloadToken": "string",
        "downloadActivationCode": "string"
    },
    "offlineAccount": {
        "username": "string",
        "password": "string",
        "status": "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL",
        "message": "string",
        "downloadToken": "string",
        "downloadActivationCode": "string"
    },
    "depotConfiguration": {
        "isOfflineDepot": false,
        "hostname": "string",
        "port": 0,
        "url": "string",
        "trustedCertificates": [
            "string"
        ]
    }
}
object
vmwareAccount
Optional

VMware Depot Account Information

object
offlineAccount
Optional

VMware Depot Account Information

object
depotConfiguration
Optional

Depot Configuration


400

Bad Request

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "notifications": [
        {
            "severity": "string",
            "message": "string",
            "remediations": [
                {
                    "message": "string",
                    "link": "string"
                }
            ],
            "impactMessage": "string"
        }
    ],
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        {
            "errorCode": "string",
            "errorType": "string",
            "arguments": [
                "string"
            ],
            "context": {
                "context": "string"
            },
            "notifications": [
                {
                    "severity": "string",
                    "message": "string",
                    "remediations": [
                        {
                            "message": "string",
                            "link": "string"
                        }
                    ],
                    "impactMessage": "string"
                }
            ],
            "message": "string",
            "remediationMessage": "string",
            "causes": [
                {
                    "type": "string",
                    "message": "string"
                }
            ],
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string",
            "label": "string",
            "remediationUrl": "string"
        }
    ],
    "referenceToken": "string",
    "label": "string",
    "remediationUrl": "string"
}
string
errorCode
Read-Only  

The minor error code

string
errorType
Read-Only  

The error type

array of string
arguments
Read-Only  

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

object
context
Read-Only  

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

array of object
notifications
Read-Only  

Detailed results of the precheck validation.

string
message
Read-Only  

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of object
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Read-Only  

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Read-Only  

The localized label message

string
remediationUrl
Read-Only  

The URL string for remediation documentation link


500

Internal Server Error

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Read-Only  

The minor error code

string
errorType
Read-Only  

The error type

array of string
arguments
Read-Only  

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

object
context
Read-Only  

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

array of object
notifications
Read-Only  

Detailed results of the precheck validation.

string
message
Read-Only  

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
Read-Only  

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Read-Only  

The localized label message

string
remediationUrl
Read-Only  

The URL string for remediation documentation link


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/system/settings/depot
On This Page
Depot Settings Operations
GET
Get Depot Settings
PUT
Update Depot Settings
DELETE
Delete Depot Settings
GET
Get Depot Sync Info
PATCH
Sync Depot Metadata
GET
Get Machine Details