Example of Accessing the API with cURL

The following example shows how to verify and validate contents of 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 Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Thu, 10 Dec 2020 12:07:37 GMT
Server: Apache/2.4.6 () OpenSSL/1.0.2k-fips mod_fcgid/2.3.9 PHP/5.4.40
Vary: Accept-Encoding
X-UA-Compatible: IE=Edge,chrome=1
Transfer-Encoding: chunked
Content-Type: application/json

Example of the Response Body

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

{
    "status": "fail",
    "message": "Error 'Network staging validation failed' while trying to verify_inbox the network staging.",
    "config_filename": "Eng_routing_1_R8_2_HA_port5vl3_cfg.cfg",
    "data": {
        "result_rows": [{
            "hw_model": null,
            "file_type": "2",
            "reason_string": "Could not compile the config file",
            "file_name": "",
            "result_type": "4",
            "misc_text": "*Line: 14-> ERROR: EC836:  Error parsing configuration. An unrecognized command, parameter or parameter value ('cloud_global_properties') was encountered in the configuration at line 14.\n\nThis Configuration is invalid. Please fix the above errors and recompile the configuration.\n\nFiles created:\n Eng_routing_1_R8_2_HA_port5vl3_cfg.xml\n        Eng_routing_1_R8_2_HA_port5vl3_cfg-xml.lst\n"
        }, {
             "hw_model": null,
             "file_type": null,
             "reason_string": "Network staging validation failed",
             "file_name": null,
             "result_type": "6",
             "misc_text": null
         }]
    }
}