Update Site
Update an existing site, to support actions like offboarding and reconnecting.
Update an existing site to support actions like offboarding and reconnecting.
Request
URI
PUT
https://{api_host}/v3/sites/{site-id}
COPY
Path Parameters
string
site-id
Required
site_id is used to identify which site the action is being taken on.
Request Body
All required details for taking action on a site
SiteV3
of type(s)
application/json
Optional
{
"site_type": "string",
"desired_state": "string",
"site_discovery_info": {
"discovery_hostname": "string",
"username": "string",
"password": "string",
"certificate": "string"
},
"site_name": "string",
"virtual_ip": "number",
"manager_hostname": "string",
"cluster_manager_ips": [
"string"
],
"status": {
"connection_status": "string",
"infrastructure_sync_agent_status": {
"status": "string",
"last_transition_time": "string"
},
"inventory_sync_agent_status": {
"status": "string",
"last_transition_time": "string"
},
"cluster_status": "string",
"nsx_cluster_id": "string",
"nsx_version": "string",
"configuration_status": {
"site_precheck_status": "string",
"site_precheck_message": "string",
"current_status": "string"
},
"conditions": [
{
"name": "string",
"message": "string",
"last_transition_time": "string",
"state": "string"
}
]
}
}Responses
202
ACCEPTED
Returns
AsyncApiResponse
of type(s)
application/json
"AsyncApiResponse Object"
default
unexpected error
Returns
Error
of type(s)
application/json
"Error Object"Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v3/sites/{site-id}