REST API for Oracle SD-WAN Edge Release 9.1.1

~~Upload and install a package~~

post

http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/edge_options/sdwanEdgeUploadAndInstall

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

pkgfile: string (binary)

The package file to upload
timestamp: string

Example: MXe8234hjDs23==

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "example":"MXe8234hjDs23=="
        },
        "pkgfile":{
            "description":"The package file to upload",
            "type":"string",
            "format":"binary"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

data: string

Example: { "status":"Success", "upload_status_pkg_file":"Upload and install of new Configuration Editor Package version:version successful." }
status: string

Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"success"
        },
        "data":{
            "type":"string",
            "example":{
                "status":"Success",
                "upload_status_pkg_file":"Upload and install of new Configuration Editor Package version:version successful."
            }
        }
    }
}

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 upload and install a package file 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 \
    -F pkgfile=@<filename> \
    -F timestamp=<timestamp> \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/manage_appliance/edge_options/sdwanEdgeUploadAndInstall"

Note:

This API is deprecated.

Example of the Response Body

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

{
  "data": {
    "inbox_files": [
      "DefaultConfig.cfg"
    ]
  },
  "state": "network_staging",
  "state_int": 0,
  "status": "success"
}