Get Depot Settings

Get Depot Settings

Get the depot configuration. In a fresh setup, this would be empty.

Request
URI
GET
https://{api_host}/v1/system/settings/depot
COPY
Responses
200

Ok

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"
    },
    "dellEmcSupportAccount": {
        "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"
    },
    "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"
    },
    "depotConfiguration": {
        "isOfflineDepot": false,
        "hostname": "string",
        "port": 0
    }
}
DepotAccount
vmwareAccount
Optional

VMware Depot Account Information

DepotAccount
dellEmcSupportAccount
Optional

VMware Depot Account Information

DepotAccount
offlineAccount
Optional

VMware Depot Account Information

DepotConfiguration
depotConfiguration
Optional

Depot Configuration


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.

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.


On This Page
Depot Settings Operations
DELETE
Delete Depot Settings
GET
Get Depot Settings
PUT
Update Depot Settings