Add Vcd Configuration

Add Vcd Configuration
Add vCloud Director Configuration

Add new VMware Cloud Director (VCD) configuration. Validates VCD connectivity, retrieves and populates VCD components (public URL, AMQP details). Automatically enriches configuration with systemExchange, systemPrefix, and UI EndPoint from VCD.

Request
URI
POST
https://{server}:9443/api/admin/global/config/vcd
COPY
Request Body
VcdPostRequestBody of type(s) application/json
Required
{
    "data": {
        "items": [
            {
                "config": {
                    "url": "https://vcd.example.com",
                    "userName": "administrator",
                    "password": "VkNEUGFzc3dvcmQxMjMh"
                }
            }
        ]
    }
}
object
data
Optional

data

Authentication
This operation uses the following authentication methods.
Responses
200

VCD configuration created successfully

Returns VcdGetResponse200 of type(s) application/json
{
    "data": {
        "items": [
            {
                "section": "vcd",
                "config": {
                    "userName": "administrator",
                    "url": "https://vcd.example.com",
                    "publicUrlBase": "https://vcd.example.com",
                    "uiEndPoint": "https://vcd.example.com/cloud",
                    "systemExchange": "systemExchange",
                    "systemPrefix": "vcd",
                    "UUID": "e5f6a7b8-c9d0-1234-ef12-345678901234"
                }
            }
        ]
    }
}
object
data
Required

data


400

Bad request - validation failed, duplicate VCD, invalid credentials, VCD components validation failed, or SSL certificate error

{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}

500

Internal server error - configuration save failed

Returns ErrorResponse of type(s) application/json
{
    "isSuccess": false,
    "message": "Unable to save VCD configuration",
    "httpStatusCode": 500
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/admin/global/config/vcd