System Administration >
Configuration
>
Site Management
Get the site configuration
Request:
Method:
GET
URI Path(s):
/api/v1/sites
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/sites
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
FederationConfiguration
+
FederationConfiguration
(
schema
)
Name
Description
Type
Notes
epoch
Epoch
integer
Required
id
Federation id
string
Required
sites
Sites
array of
FederationSite
Required
Example Response:
{ "sites": [ { "id": "c69dd550-841d-4064-bc92-476e977ad04d", "name": "name1", "active_gm": "true", "aph_list": [ { "address": "10.11.12.13", "port": "8000", "certificate": "-----BEGIN CERTIFICATE-----\nMIIC1TCCAb2gAwIBAgIEX135sjANBgkqhkiG9w0BAQsFADAaMRgwFgYDVQQDEw9j\nbHVzdGVyLW1hbmFnZXIwIBcNMTgwODAzMTgyNTI1WhgPMjExODA3MTAxODI1MjVa\nMBoxGDAWBgNVBAMTD2NsdXN0ZXItbWFuYWdlcjCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBALKz/i+SQzpB7dkaF6tGTm1oP4esjEtd5Pv9beE01qpZv+CA\npAB/BosbDLFvBSwlEwqFZNbNSPlgyfbHCCe28IibWWrkVtIIH/9XVTdsH+iJEG3N\nDXgcn3Qj+PBbYK9K+imF2fQdypeYokMova3YQnBadfTKZgJSc5gt0fKPehLceeHE\nIZz07tfDRMzZg4kYFBURU1u/V17coPD7y/Ja0kGJSBSjN6t/eFqI1PvVLw9niddz\n+yjsRqnvdGnQFoB43LewnbpYxn69qOd9Knu81MP2HR4G2jhVevf/qkG8mS3fS8gu\nFGm2JwtncnWsxGFdb2c/KTMxH0iQEcBCjbph6T0CAwEAAaMhMB8wHQYDVR0OBBYE\nFHhBeWEQrmNTv4otlztUkfVLCzwkMA0GCSqGSIb3DQEBCwUAA4IBAQBAu/jFw3QY\n5eWm3lOBJe67MXXOFVbCLRgcMlXzXoNWStI/3ncH1ZUDH0pz0pcOmyWoWUZ0OSjr\nLz+XMZN6MFgHx2w7RvLXYewFzowVaNu7l/V375Vhv18KpnJ6EjemVQRMZmJQFwda\nMrLU5dSuWVJYoTR6yVneSPasxHMCorTc+K3msVbP/1nh/wSls5Zj8L7jszLOqMpz\nUQL8eYN2r+A/sWFW5Ge6qGTOuOVpUS24isBwRqcyYLD7iJsIzpdebanuTNlXeJJQ\n49yPXri4nzQ4mNsiVCNFGGZyUmBzEpvcx3Lzol790Azk8SHkiGaOQJRKVr8CPszv\nZ12pIgNkADz8\n-----END CERTIFICATE-----\n" } ], } ], "epoch": 1, "version": 1 }
Required Permissions:
read
Feature:
cluster_management
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable