PUT Config

PUT Config

Sets a new internal cluster configuration. Configuration is replicated internally to all cluster members. Some configuration options require a service restart to take effect. Option values modified using one of these methods are not checked for validity. Confirm all changes before applying them. Note: For direct manipulation of the internal configuration of a cluster see https://kb.vmware.com/kb/2123058.

Request
URI
PUT
https://{api_host}/api/v1/config
COPY
Query Parameters
boolean
validate
Optional
Constraints: default: true

Whether to perform limited validation on the new configuration blob. Default of true is highly recommended.


Request Body

Show optional properties

{
    "configBlob": "string"
}
{
    "configBlob": "<config><upgrade><upgrade-status-update-retry-count value=\"4\"/></upgrade></config>"
}
string
configBlob
Required

configBlob

Authentication
This operation uses the following authentication methods.
Responses
200
Operation doesn't return any data structure

Response Headers

string
Warning

Additional information about the life-cycle status of the API.

string
VMware-LI-API-Status

Indicates the life-cycle status of the API.


400

Failed to apply configuration changes, either because of a parse error or invalid configuration options.

{
    "success": false
}

401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"configBlob:"string"}' https://{api_host}/api/v1/config