REST API for Oracle SD-WAN Edge Release 9.1.1

Upload Oracle Software

post

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

Request

There are no request parameters for this operation.

Supported Media Types

multipart/form-data

Root Schema : schema

Type: object

Show Source

installfile: string (binary)

Example: Talari_APNWare_VT800_install_R9_0_0_0_0_QA_D1_04222020-44-g1661bce.tar
timestamp: string

Example: MK3jd4==

{
    "type":"object",
    "properties":{
        "installfile":{
            "type":"string",
            "format":"binary",
            "example":"Talari_APNWare_VT800_install_R9_0_0_0_0_QA_D1_04222020-44-g1661bce.tar"
        },
        "timestamp":{
            "type":"string",
            "example":"MK3jd4=="
        }
    }
}

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 upload Oracle software 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 installfile=@<filename> \
    -F timestamp=<timestamp> \
    "https://$IPADDR/v1/admin/manage_appliance/edge_options/sdwanOptionsUploadOracleSoftware"

Example of the Response Body

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

{
  "data": {
    "license_text": "by installing, updating, and using these products, you agree to follow and be bound by the agreement available at: https://www.oracle.com/a/ocom/docs/corporate/talari-toma.pdf.  if you are installing and/or updating these products on behalf of a company or other legal entity, you represent that you have the authority to bind such entity to the agreement and, in such event, &#34you&#34 and &#34your&#34 as used in the agreement shall refer to such entity. if you do not have such authority to bind such entity, or if you or such entity do not agree to follow and be bound by the agreement, you shall not install or use these products",
    "upload_status": "upload_success"
  },
  "status": "success"
}