REST API for Oracle SD-WAN Edge Release 9.1.1

Update service attributes

post

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

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing the restore_defaults value

Root Schema : schema

Type: object

Show Source

apply: string

Example: apply
t2_vars: object object t2_vars
timestamp: string

Example: MK3jd4==

{
    "type":"object",
    "properties":{
        "apply":{
            "type":"string",
            "example":"apply"
        },
        "t2_vars":{
            "type":"object",
            "example":[
                {
                    "name":"Version",
                    "value":15
                },
                {
                    "name":"CONDUIT_IN_DEMAND_PACKET_NUM_THRESHOLD",
                    "value":5
                },
                {
                    "name":"GDN_DETECT_REG_DIFFERENT_TAKEOVER_S",
                    "value":60
                }
            ]
        },
        "timestamp":{
            "type":"string",
            "example":"MK3jd4=="
        }
    }
}

Nested Schema : t2_vars

Type: object

Example:

[
    {
        "name":"Version",
        "value":15
    },
    {
        "name":"CONDUIT_IN_DEMAND_PACKET_NUM_THRESHOLD",
        "value":5
    },
    {
        "name":"GDN_DETECT_REG_DIFFERENT_TAKEOVER_S",
        "value":60
    }
]

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 update service attributes 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/manage_appliance/edge_options/updateServiceAttr"

The following shows other examples of accessing this API resource.

curl -X POST -b cookies.txt -d '{"restore_defaults":"restore_defaults","timestamp":<timestamp>}' -H "Content-Type: application/json" "https://$IPADDR/v1/admin/manage_appliance/edge_options/updateServiceAttr"

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

{
  "apply":"apply",
  "t2_vars":[
    {
      "name":"Version",
      "value":15
    },{
      "name":"CONDUIT_IN_DEMAND_PACKET_NUM_THRESHOLD"
    }
  ],
  "timestamp":<timestamp>
}

Example of the Response Body

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

{
  "data": [
    {
      "apply_status": "An Adaptive Private Network Service Restart (on Manage SD-WAN Edge Restart/Reboot SD-WAN Edge) may be required."
    }
  ],
  "status": "success"
}