Cisco Cisco ASA 5555-X Adaptive Security Appliance
About the ASA REST API
Special APIs
Special APIs
29
individual request for each resource data could be grouped together in a single JSON content. It might provide atomicity
for certain level of validations where the complete request is rejected if syntax validations fail for some.
This digresses from REST paradigm although each individual operation specified will follow REST convention and users
don’t need to relearn new API but just how to package up multiple REST calls in bulk.
don’t need to relearn new API but just how to package up multiple REST calls in bulk.
The details of request payload, response structure are as follows.
Post URL: /api
Post request payload: [{}, {}, {} ..] – each JSON object is an operation wrapper. The object wrapper is given below.
{
method:<HTTP_REQUEST_METHOD_FOR_RESOURCE >,
resourceUri:<RESOURCE_URI>,
data:<POST_CONTENT_FOR_THIS_URI_IF_APPLICABLE>
}
Property
Type
Description
method
string Supported are ‘GET’, ‘POST’, ‘DELETE’, ‘PATCH’
resourceUri
string The resource URI if the request was made independently
data
string JSON data sent as raw body if the request was made individually. For ‘DELETE’ method, this is not needed.
The bulk request response structure will be as follows.
{
"entryMessages":[{}, {}, ..],
"commonMessages": []
}
Entry messages will be an array of objects, with each corresponding to the bulk entry.
Generic CLI Command Executer API
This special API can take single or multi-line CLI commands and will present the output of the CLI as the API response
Post URL: