REST API for Oracle SD-WAN Edge Release 9.1.1

Get configuration files

get

http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/delete_files/getCfgFiles

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
status: string

Example: success

{
    "type":"object",
    "example":{
        "status":"success",
        "data":[
            {
                "value":"/home/talariuser/config/archive/apn_base_20200620_1200.cfg",
                "label":"apn_base_20200620_1200.cfg (archived) - Sat Jun 20 12:00:22 2020"
            },
            {
                "value":"/home/talariuser/config/archive/apn_base_20200609_0311.cfg",
                "label":"apn_base_20200609_0311.cfg (archived) - Tue Jun  9 03:11:35 2020"
            },
            {
                "value":"/home/talariuser/config/archive/apn_base_20200609_0110.cfg",
                "label":"apn_base_20200609_0110.cfg (archived) - Tue Jun  9 01:10:18 2020"
            }
        ]
    },
    "properties":{
        "status":{
            "type":"string",
            "example":"success"
        },
        "data":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "example":"/home/talariuser/config/archive/apn_base_20200609_0110.cfg"
                },
                "label":{
                    "type":"string",
                    "example":"apn_base_20200609_0110.cfg (archived) - Tue Jun  9 01:10:18 2020"
                }
            }
        }
    }
}

Example:

{
    "status":"success",
    "data":[
        {
            "value":"/home/talariuser/config/archive/apn_base_20200620_1200.cfg",
            "label":"apn_base_20200620_1200.cfg (archived) - Sat Jun 20 12:00:22 2020"
        },
        {
            "value":"/home/talariuser/config/archive/apn_base_20200609_0311.cfg",
            "label":"apn_base_20200609_0311.cfg (archived) - Tue Jun  9 03:11:35 2020"
        },
        {
            "value":"/home/talariuser/config/archive/apn_base_20200609_0110.cfg",
            "label":"apn_base_20200609_0110.cfg (archived) - Tue Jun  9 01:10:18 2020"
        }
    ]
}

Nested Schema : data

Type: object

Show Source

label: string

Example: apn_base_20200609_0110.cfg (archived) - Tue Jun 9 01:10:18 2020
value: string

Example: /home/talariuser/config/archive/apn_base_20200609_0110.cfg

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "example":"/home/talariuser/config/archive/apn_base_20200609_0110.cfg"
        },
        "label":{
            "type":"string",
            "example":"apn_base_20200609_0110.cfg (archived) - Tue Jun  9 01:10:18 2020"
        }
    }
}

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 view the location of the configuration files 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 \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/manage_appliance/delete_files/getCfgFiles"

Example of the Response Body

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

{
  "data": [
    {
      "label": "apn_base_20200620_1200.cfg (archived) - Sat Jun 20 12:00:22 2020",
      "value": "/home/talariuser/config/archive/apn_base_20200620_1200.cfg"
    },
    {
      "label": "apn_base_20200609_0311.cfg (archived) - Tue Jun  9 03:11:35 2020",
      "value": "/home/talariuser/config/archive/apn_base_20200609_0311.cfg"
    },
    {
      "label": "apn_base_20200609_0110.cfg (archived) - Tue Jun  9 01:10:18 2020",
      "value": "/home/talariuser/config/archive/apn_base_20200609_0110.cfg"
    }
  ],
  "status": "success"
}