REST API for Oracle SD-WAN Edge Release 9.1.1

Disable the appliance

post

http://<SDWAN_TENANT_IP>/restapi/service/disable

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing the diag dump action and timestamp

Root Schema : schema

Type: object

Show Source

doDiagDump: string

Default Value: off

Allowed Values: [ "on", "off" ]

Example: on
timestamp: string

Example: MXe8234hjDs23==

{
    "type":"object",
    "properties":{
        "doDiagDump":{
            "type":"string",
            "default":"off",
            "enum":[
                "on",
                "off"
            ],
            "example":"on"
        },
        "timestamp":{
            "type":"string",
            "example":"MXe8234hjDs23=="
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Result OK

Root Schema : schema

Type: object

Show Source

data: string

Example: [ [ { "isDisabled":1, "disabledOutput":{ "cm_net":0, "cm_local":0, "add_enable_button":1, "out_str":"", "extra_html":"" } } ] ]
status: string

Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"success"
        },
        "data":{
            "type":"string",
            "example":[
                [
                    {
                        "isDisabled":1,
                        "disabledOutput":{
                            "cm_net":0,
                            "cm_local":0,
                            "add_enable_button":1,
                            "out_str":"",
                            "extra_html":""
                        }
                    }
                ]
            ]
        }
    }
}

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

Examples

Example of Accessing the API with cURL

The following example shows how to disable Talari service 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/restapi/service/disable"

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

{
  "doDiagDump":"on",
  "timestamp":<timestamp>
}

Example of the Response Body

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

{
  "data": [
      [
        {
          "disabledOutput": {
              "add_enable_button": 1,
              "cm_local": 0,
              "cm_net": 0,
              "extra_html": "",
              "out_str": "The Oracle service has previously been disabled from the web interface.<br> The Oracle service was disabled at: Wed Dec 16 09:58:16 2020"
          },
          "isDisabled": 1
        }
      ]
    ],
  "status": "success"
}