REST API for Oracle SD-WAN Edge Release 9.1.1

Create, download or delete diagnostics packages

post

http://<SDWAN_TENANT_IP>/v1/admin/log_diag/diagDumpOperations

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing the diag dump operation and the filename

Root Schema : schema

Type: object

Show Source

diagnostics: object object diagnostics
timestamp: string

Example: MK3jd4==

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "example":"MK3jd4=="
        },
        "diagnostics":{
            "type":"object",
            "properties":{
                "operation":{
                    "type":"string",
                    "enum":[
                        "create",
                        "download",
                        "delete"
                    ],
                    "example":"create"
                },
                "filename":{
                    "type":"string",
                    "example":"NCN0-2019-11-21-20-10-diagnostics.tar.gz"
                }
            }
        }
    }
}

Nested Schema : diagnostics

Type: object

Show Source

filename: string

Example: NCN0-2019-11-21-20-10-diagnostics.tar.gz
operation: string

Allowed Values: [ "create", "download", "delete" ]

Example: create

{
    "type":"object",
    "properties":{
        "operation":{
            "type":"string",
            "enum":[
                "create",
                "download",
                "delete"
            ],
            "example":"create"
        },
        "filename":{
            "type":"string",
            "example":"NCN0-2019-11-21-20-10-diagnostics.tar.gz"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Result OK

Root Schema : schema

Type: object

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 : 405ExpectedPost

Type: object

Show Source

message: string

Example: Operation must use a POST
status: string

Example: fail

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

Examples

Example of Accessing the API with cURL

The following example shows how to create, download or delete diagnostics packages by submitting a POST 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 POST \
    -b cookies.txt \
    -d@request.json \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/log_diag/diagDumpOperations"

The following shows other examples of accessing this API resource.

curl -X POST -b cookies.txt -d '{"diagnostics":{"operation":"download","filename":"diagtest123.tar.gz"},"timestamp":<timestamp>}' -o diagdumpdownload.tar.gz -H "Content-Type: application/json" "https://$IPADDR/v1/admin/log_diag/diagDumpOperations"
curl -X POST -b cookies.txt -d '{"diagnostics":{"operation":"delete","filename":"diagtest123.tar.gz"},"timestamp":<timestamp>}' -H "Content-Type: application/json" "https://$IPADDR/v1/admin/log_diag/diagDumpOperations"

The following shows an example of the contents of the request.json file sent as the request body.

{
  "diagnostics": {
    "operation":"create",
    "filename":"diagtest123.tar.gz"
    },
  "timestamp":<timestamp>
}

Example of the Response Body

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

{
  "status":"success",
  "data":"Successfully created Diagnostics File diagtest123.tar.gz"
}