Example of Accessing the API with cURL

The following example shows how to clear out the contents of the change management 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/clear_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: Wed, 09 Dec 2020 20:18:50 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; charset=ISO-8859-1

Example of the Response Body

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

{
   "status": "success",
   "state": "network_staging",
   "state_int": 0,
   "data": {
     "inbox_files": []
   }
 }