REST API for Oracle SD-WAN Edge Release 9.1.1

Get OS partition status

get

http://<SDWAN_TENANT_IP>/restapi/os_partition/get_status

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

Root Schema : schema

Type: object

Show Source

data: object object data
message: string

Example: Successfully retrieved OS Partition information.
status: string

Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"success"
        },
        "message":{
            "type":"string",
            "example":"Successfully retrieved OS Partition information."
        },
        "data":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

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 current OS partition 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/restapi/os_partition/get_status"

Example of the Response Body

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

{
  "data": {
    "allow_azure_os_downgrade": 1,
    "change_partition_allowed": 1,
    "hardware_model_str": "VT800v1",
    "image_files": [],
    "isDisabled": "0",
    "partition_info": [
      {
        "active": {
          "name": "Primary_OS",
          "next_boot_choice": 1,
          "os_version_display": "7.0.1.0.0 (OS_7_0_1_0_0_GA_03162020)",
          "os_version_last_boot": "7.0.1.0.0",
          "state": "Active"
        },
        "backup": {
          "name": "Secondary_OS",
          "next_boot_choice": 0,
          "os_version_display": "7.0.1.0.0 (OS_7_0_1_0_0_GA_03162020)",
          "os_version_last_boot": "7.0.1.0.0",
          "state": "Backup"
        }
      }
    ],
    "patch_files": [],
    "patch_level": "7.0P0",
    "uptime_seconds": "28044.13",
    "uptime_str": "up 7 hours, 47 minutes"
  },
  "message": "Successfully retrieved OS Partition information.",
  "status": "success"
}