REST API for Oracle SD-WAN Edge Release 9.1.1

Verify and validate contents of inbox

post

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

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

Default Value:

Example: MXe8234hjDs23==

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

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

config_filename: string

Example: talari_config.cfg
data: object object data
message: string

Example: Success verifying network staging package.
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
        },
        "config_filename":{
            "type":"string",
            "example":"talari_config.cfg"
        },
        "message":{
            "type":"string",
            "example":"Success verifying network staging package."
        },
        "data":{
            "type":"object",
            "properties":{
                "result_rows":{
                    "type":"array",
                    "items":{
                        "example":{
                            "hw_model":"",
                            "file_type":"2",
                            "reason_string":"",
                            "file_name":"''",
                            "result_type":"4",
                            "misc_text":""
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Show Source

result_rows: array array result_rows

{
    "type":"object",
    "properties":{
        "result_rows":{
            "type":"array",
            "items":{
                "example":{
                    "hw_model":"",
                    "file_type":"2",
                    "reason_string":"",
                    "file_name":"''",
                    "result_type":"4",
                    "misc_text":""
                }
            }
        }
    }
}

Nested Schema : result_rows

Type: array

Show Source

Array of:

Example: { "hw_model":"", "file_type":"2", "reason_string":"", "file_name":"''", "result_type":"4", "misc_text":"" }

{
    "type":"array",
    "items":{
        "example":{
            "hw_model":"",
            "file_type":"2",
            "reason_string":"",
            "file_name":"''",
            "result_type":"4",
            "misc_text":""
        }
    }
}

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 verify and validate the contents of the inbox 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/verify_inbox"

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.

{
  "config_filename": "DefaultConfig.cfg",
  "data": {
    "result_rows": [
      {
        "file_name": null,
        "file_type": null,
        "hw_model": null,
        "misc_text": "* -> WARNING: EC477:  internet_default_set 'Default_Internet_Policy' is not used by any Internet Service in this network.\n* -> WARNING: EC477:  intranet_default_set 'Default_Intranet_Policy' is not used by any Intranet Service in this network.\n\nThis Configuration is valid, but please note the above warnings.  (version 1613603847)\n\nFiles created:\n        DefaultConfig.xml\n\tconfig_id_file.lst\n\n",
        "reason_string": "Network staging validation successful",
        "result_type": "1"
      }
    ]
  },
  "message": "Success verifying network staging package.  Validation Results: Network staging validation successful",
  "state": "network_staging",
  "state_int": 0,
  "status": "success"
}