Configure 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
Configure site request.
ConfigureSiteRequest of type(s) application/json
Required
{
"site": "site1"
}string
site
Optional
The site name. Allowed characters are: letter, number, dash, and underscore.
Responses
200
OK
Returns ManagerConfigResponse of type(s) application/json;charset=UTF-8
This response body class contains all of the following: ConfigResponse
{
"id": "2bfb7696-3aa1-49d3-bb40-d9e97df1baba",
"site": "site1",
"lsUrl": "https://localhost/lookupservice/sdk",
"lsThumbprint": "SHA-256:0D:80:21:91:C7:DC:94:BC:9D:E8:A7:04:0F:6B:F1:09:5C:AA:97:C8:4A:72:E5:CF:5E:8F:84:A7:B9:CC:8C:85"
}string
site
Optional
The site name.
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.