REST API for Oracle SD-WAN Edge Release 9.1.1

Get the site information

get

http://<SDWAN_TENANT_IP>/v1/admin/topmenu/siteInfo

Request

There are no request parameters for this operation.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Result OK

Root Schema : schema

Type: object

Show Source

data: object object data
status: string

Example: success

{
    "type":"object",
    "example":{
        "status":"success",
        "localSiteID":"0",
        "data":[
            [
                {
                    "siteInfo":[
                        {
                            "disabled":0,
                            "siteName":"NCN0",
                            "ha":"",
                            "apn":"SD-WAN Controller"
                        }
                    ]
                }
            ]
        ]
    },
    "properties":{
        "status":{
            "type":"string",
            "example":"success"
        },
        "data":{
            "type":"object",
            "properties":{
                "siteInfo":{
                    "type":"object",
                    "properties":{
                        "disabled":{
                            "type":"boolean",
                            "example":0
                        },
                        "siteName":{
                            "type":"string",
                            "example":"NCN0"
                        },
                        "ha":{
                            "type":"string",
                            "enum":[
                                "HA-Active",
                                "HA-Standby",
                                "HA-Disabled",
                                ""
                            ],
                            "example":"HA-Active"
                        },
                        "apn":{
                            "type":"string",
                            "enum":[
                                "SD-WAN Contoller",
                                "Client",
                                "Geo",
                                "SD-WAN Edge"
                            ],
                            "example":"HA-Active"
                        }
                    }
                }
            }
        }
    }
}

Example:

{
    "status":"success",
    "localSiteID":"0",
    "data":[
        [
            {
                "siteInfo":[
                    {
                        "disabled":0,
                        "siteName":"NCN0",
                        "ha":"",
                        "apn":"SD-WAN Controller"
                    }
                ]
            }
        ]
    ]
}

Nested Schema : data

Type: object

Show Source

siteInfo: object object siteInfo

{
    "type":"object",
    "properties":{
        "siteInfo":{
            "type":"object",
            "properties":{
                "disabled":{
                    "type":"boolean",
                    "example":0
                },
                "siteName":{
                    "type":"string",
                    "example":"NCN0"
                },
                "ha":{
                    "type":"string",
                    "enum":[
                        "HA-Active",
                        "HA-Standby",
                        "HA-Disabled",
                        ""
                    ],
                    "example":"HA-Active"
                },
                "apn":{
                    "type":"string",
                    "enum":[
                        "SD-WAN Contoller",
                        "Client",
                        "Geo",
                        "SD-WAN Edge"
                    ],
                    "example":"HA-Active"
                }
            }
        }
    }
}

Nested Schema : siteInfo

Type: object

Show Source

apn: string

Allowed Values: [ "SD-WAN Contoller", "Client", "Geo", "SD-WAN Edge" ]

Example: HA-Active
disabled: boolean

Example: 0
ha: string

Allowed Values: [ "HA-Active", "HA-Standby", "HA-Disabled", "" ]

Example: HA-Active
siteName: string

Example: NCN0

{
    "type":"object",
    "properties":{
        "disabled":{
            "type":"boolean",
            "example":0
        },
        "siteName":{
            "type":"string",
            "example":"NCN0"
        },
        "ha":{
            "type":"string",
            "enum":[
                "HA-Active",
                "HA-Standby",
                "HA-Disabled",
                ""
            ],
            "example":"HA-Active"
        },
        "apn":{
            "type":"string",
            "enum":[
                "SD-WAN Contoller",
                "Client",
                "Geo",
                "SD-WAN Edge"
            ],
            "example":"HA-Active"
        }
    }
}

401 Response

Not Logged into the SDWAN-Edge device

Root Schema : 401NotLoggedin

Type: object

Show Source

message: string

Example: Not logged in.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

message: string

Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
required_user_level: string

Example: ADMIN
status: string

Example: fail
user_level: string

Example: GUEST
user_name: string

Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Root Schema : 405ExpectedGet

Type: object

Show Source

message: string

Example: Operation must use a GET
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a GET"
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to get the Site information like name, type, and HA status by submitting a GET request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X GET \
    -b cookies.txt \
    "https://$IPADDR/v1/admin/topmenu/siteInfo"

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "data": [
    [{
      "siteInfo": [
        {
          "apn": "SD-WAN Controller",
          "disabled": 0,
          "ha": "",
          "siteName": "IPSEC-TB-NCN"
        }
      ]
    }]
  ],
  "localSiteID": "0",
  "status": "success",
  "tenantName": "Not Available"
}