REST API for Oracle SD-WAN Edge Release 9.1.1

Stage contents of inbox used in change management

post

http://<SDWAN_TENANT_IP>/restapi/change_management/stage

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing the timestamp

Root Schema : schema

Type: object

Show Source

timestamp: string

Example: MXe8234hjDs23==

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "example":"MXe8234hjDs23=="
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Result OK

Root Schema : schema

Type: object

Show Source

state: string

Example: staging
state_int: integer

Example: 1
status: string

Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"success"
        },
        "state":{
            "type":"string",
            "example":"staging"
        },
        "state_int":{
            "type":"integer",
            "example":1
        }
    }
}

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

500 Response

Error while attempting to prepare the inbox contents for staging

Root Schema : schema

Type: object

Show Source

message: string

Example: Error while attempting to preparing the inbox contents for staging.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Error while attempting to preparing the inbox contents for staging."
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to stage contents of inbox used in change management 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/change_management/stage"

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

{
  "timestamp": "<timestamp>"
}

Example of the Response Body

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

{
    "status": "success",
    "state": "appliance_staging",
    "state_int": 9,
    "message": "Staging successfully started."
}