Retrieve All Sites
Get all sites currently in SSP.
Get all sites currently in SSP.
Request
URI
GET
https://{api_host}/v3/sites
COPY
Query Parameters
string
site_name
Optional
Use this request param to filter by site name.
string
site_type
Optional
Use this request param to filter by site type.
Possible values are :
NSX,
SSP,
AVI,
string
current_state
Optional
Use this request param to filter by a site's current status.
Possible values are :
READY,
NOT_READY,
INACTIVE,
UNKNOWN,
Authentication
This operation uses the following authentication methods.
Responses
200
OK
Returns
SiteListV3
of type(s)
application/json
This response body class contains all of the following:
ListResult
{
"0": "L",
"1": "i",
"2": "s",
"3": "t",
"4": "R",
"5": "e",
"6": "s",
"7": "u",
"8": "l",
"9": "t",
"10": " ",
"11": "O",
"12": "b",
"13": "j",
"14": "e",
"15": "c",
"16": "t",
"sites": [
{
"0": "M",
"1": "a",
"2": "n",
"3": "a",
"4": "g",
"5": "e",
"6": "d",
"7": "R",
"8": "e",
"9": "s",
"10": "o",
"11": "u",
"12": "r",
"13": "c",
"14": "e",
"15": " ",
"16": "O",
"17": "b",
"18": "j",
"19": "e",
"20": "c",
"21": "t",
"site_type": "string",
"desired_state": "string",
"site_discovery_info": {
"discovery_hostname": "string",
"username": "string",
"password": "string",
"certificate": "string"
},
"site_name": "string",
"virtual_ip": "string",
"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"
}
]
}
}
]
}
default
unexpected error
Returns
Error
of type(s)
application/json
"Error Object"Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v3/sites