Config Site
This request configures the site that this appliance is running on. Warning: Once the site is set it can never be changed again!
Request
URI
POST
https://{api_host}//config/site
COPY
Header Parameters
string
operationID
Optional
Operation ID for correlating logs across multiple services
Request Body
Request to configure the local site.
ConfigureSiteRequest of type(s) application/json
Required
{
"site": "site1"
}string
localSite
Optional
Site name of the site this Cloud Service is running on.
string
localSiteDescription
Optional
Description of the site this Cloud Service is running on.
Responses
200
OK
Returns CloudConfigResponse of type(s) application/json;charset=UTF-8
This response body class contains all of the following: ConfigResponse , InlineCloudConfigResponse1
{
"id": "3b0f0539-869d-4e37-8005-e1c6f01a2ef3",
"lsThumbprint": "SHA-256:8F:96:C8:A4:59:75:42:CE:6B:5E:E2:7A:D5:CF:05:E5:FB:39:89:C2:A5:6C:0E:92:D7:AF:6C:F7:38:E3:8C:E4",
"lsUrl": "https://s2-vcav-v1248-252-234.eng.vmware.com:443/lookupservice/sdk",
"localSite": "site1",
"localSiteDescription": "site1 descirption",
"vcdUrl": "https://vcdaddr:443/api",
"vcdThumbprint": "SHA-256:D3:A3:4B:1F:B6:42:AB:F9:D6:FF:D5:AB:F4:14:9F:B5:F8:3B:E7:42:09:53:2D:6E:28:32:28:CE:B3:CB:DB:2A",
"vcdUsername": "root@System",
"isCombined": false
}
401
The returned error codes include (but are not limited to): NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+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.6+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.