Configure Update Endpoints

Configure Update Endpoints

This request updates the management endpoint configuration to advertise to local and/or remote components.

Request
URI
POST
https://{api_host}/config/endpoints
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body

Update endpoint configuration request.

EndpointConfiguration of type(s) application/json
Required
This request body class requires all of the following: MgmtEndpointConfiguration 
{
    "mgmtAddress": "10.71.249.18",
    "mgmtPort": 8046,
    "mgmtPublicAddress": "tn-3b0f0539-869d-4e37-8005-e1c6f01a2ef3.tnexus.io",
    "mgmtPublicPort": 8048,
    "apiAddress": "s2-vcav-v1248-249-018.eng.vmware.com",
    "apiPort": 8443,
    "apiPublicAddress": "10.71.249.18",
    "apiPublicPort": 8048
}
string
apiAddress
Optional

The API address.

integer As int32 As int32
apiPort
Optional

The API port.

string
apiPublicAddress
Optional

The public API address.

integer As int32 As int32
apiPublicPort
Optional

The public API port.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EndpointsInfo of type(s) application/json;charset=UTF-8 
{
    "configured": {
        "mgmtAddress": "",
        "mgmtPort": 8046,
        "mgmtPublicAddress": "tn-3b0f0539-869d-4e37-8005-e1c6f01a2ef3.tnexus.io",
        "mgmtPublicPort": 8048,
        "apiAddress": "",
        "apiPort": 8443,
        "apiPublicAddress": "10.71.249.18",
        "apiPublicPort": 8048
    },
    "effective": {
        "mgmtAddress": "10.71.249.18",
        "mgmtPort": 8046,
        "mgmtPublicAddress": "tn-3b0f0539-869d-4e37-8005-e1c6f01a2ef3.tnexus.io",
        "mgmtPublicPort": 8048,
        "apiAddress": "s2-vcav-v1248-249-018.eng.vmware.com",
        "apiPort": 8443,
        "apiPublicAddress": "10.71.249.18",
        "apiPublicPort": 8048
    }
}
EndpointConfiguration
configured
Optional

configured

EndpointConfiguration
effective
Optional

effective


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Configs Operations
POST
Change Root Password
GET
Check Root Password Expiration
GET
Config Is Configured
POST
Config Site
POST
Config Vcd
GET
Configure Get
GET
Configure Get Endpoints
POST
Configure Set Lookup Service
POST
Configure Update Endpoints