REST API for Oracle SD-WAN Edge Release 9.1.1

Get the system information

get

http://<SDWAN_TENANT_IP>/v1/admin/system/system_info

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

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's system information like software version, mode, and siteName 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/system/system_info"

Example of the Response Body

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

{
  "data": [
    [
      {
        "systemInfo": [
          [
            {
              "isDisabled": 0
            },{
              "mode": "SD-WAN Controller"
            },{
              "siteName": "IPSEC-TB-NCN"
            },{
              "hadata": []
            },{
              "SD-WAN Edge Mode": "SD-WAN Controller"
            },{
              "Management IP": "(Not configured)"
            }{
              "PublicIP": ""
            },{
              "Hardware Model": "VT800v1"
            },{
              "Software Version": "9.1.1.0.0"
            },{
              "Software Build Label": "R9_1_1_0_0_CI_07192021"
            },{
              "Built On": " Jul 19 2021 at 20:53:39"
            },{
              "SD-WAN Edge Uptime": "03 hour(s):53 minute(s):06 second(s)"
            },{
              "Service Uptime": "01 hour(s):54 minute(s):33 second(s)"
            },{
              "OS Partition Version": "7.0.5.0.0"
            },{
              "OS Build Label": "7.0.5.0.0 (OS_7_0_5_0_0_GA_04272021)"
            },{
              "Serial Number": "333f6b03-3ff5-848-8d9b-7650e8de716"
            },{
              "BIOS version": "1.11.0-2.el7"
            }
          ]
        ]
      }
    ]
  ],
  "status": "success"
}