REST API for Oracle SD-WAN Edge Release 9.1.1

Get log files

get

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

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

Example: success

{
    "type":"object",
    "example":{
        "status":"success",
        "data":[
            "APN_access.log",
            "APN_change_management.log",
            "APN_change_management_summary.log",
            "APN_common.log",
            "APN_config_update.log",
            "APN_congestion.log",
            "APN_db.log",
            "APN_db.old.1.log.gz",
            "APN_drop_debug.log",
            "APN_dynamic_conduit.log",
            "APN_ethernet_port_mgt.log",
            "APN_events.log",
            "APN_exceptions.log",
            "APN_external.log",
            "APN_filetransfer.log",
            "APN_firewall.log",
            "APN_hd.log",
            "APN_icmp.log",
            "APN_init.log",
            "APN_ip_learned.log",
            "APN_management.log",
            "APN_misc.log",
            "APN_paths.log",
            "APN_routes.log",
            "APN_security.log",
            "APN_snmp_poll.log",
            "APN_system_command.log",
            "APN_traffic_impact.log",
            "APN_wd.log",
            "APN_webconsole.log",
            "auth.log",
            "init.log",
            "install.log",
            "provision.log",
            "top.log",
            "top.old.log",
            "wanop.log",
            "watchdog_failsafe.log"
        ]
    },
    "properties":{
        "status":{
            "type":"string",
            "example":"success"
        },
        "data":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"-\"APN_access.log\" -\"APN_change_management\""
            }
        }
    }
}

Example:

{
    "status":"success",
    "data":[
        "APN_access.log",
        "APN_change_management.log",
        "APN_change_management_summary.log",
        "APN_common.log",
        "APN_config_update.log",
        "APN_congestion.log",
        "APN_db.log",
        "APN_db.old.1.log.gz",
        "APN_drop_debug.log",
        "APN_dynamic_conduit.log",
        "APN_ethernet_port_mgt.log",
        "APN_events.log",
        "APN_exceptions.log",
        "APN_external.log",
        "APN_filetransfer.log",
        "APN_firewall.log",
        "APN_hd.log",
        "APN_icmp.log",
        "APN_init.log",
        "APN_ip_learned.log",
        "APN_management.log",
        "APN_misc.log",
        "APN_paths.log",
        "APN_routes.log",
        "APN_security.log",
        "APN_snmp_poll.log",
        "APN_system_command.log",
        "APN_traffic_impact.log",
        "APN_wd.log",
        "APN_webconsole.log",
        "auth.log",
        "init.log",
        "install.log",
        "provision.log",
        "top.log",
        "top.old.log",
        "wanop.log",
        "watchdog_failsafe.log"
    ]
}

Nested Schema : data

Type: array

Show Source

Array of: string

Example: -"APN_access.log" -"APN_change_management"

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"-\"APN_access.log\" -\"APN_change_management\""
    }
}

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 a list of log 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/getLogFiles"

Example of the Response Body

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

{
 "data": [
  "APN_access.log",
  "APN_change_management.log",
  "APN_change_management_summary.log",
  "APN_common.log",
  "APN_config_update.log",
  "APN_congestion.log",
  "APN_db.log",
  "APN_db.old.1.log.gz",
  "APN_drop_debug.log",
  "APN_dynamic_conduit.log",
  "APN_ethernet_port_mgt.log",
  "APN_events.log",
  "APN_exceptions.log",
  "APN_external.log",
  "APN_filetransfer.log",
  "APN_firewall.log",
  "APN_hd.log",
  "APN_icmp.log",
  "APN_init.log",
  "APN_ip_learned.log",
  "APN_management.log",
  "APN_misc.log",
  "APN_paths.log",
  "APN_routes.log",
  "APN_security.log",
  "APN_snmp_poll.log",
  "APN_system_command.log",
  "APN_traffic_impact.log",
  "APN_wd.log",
  "APN_webconsole.log",
  "auth.log",
  "init.log",
  "install.log",
  "provision.log",
  "top.log",
  "top.old.log",
  "wanop.log",
  "watchdog_failsafe.log"
 ],
 "status": "success"
}