Cisco Cisco ASA 5580 Adaptive Security Appliance
About the ASA REST API v1.2.1
Special APIs
Special APIs
24
Only S2S Configuration is supported. Certificate Management as seen in ASDM is not yet supported.
Special APIs
Bulk API
This API allows to group multiple POST, PUT, PATCH, DELETE for different resources in a single HTTP POST call. This is
for optimization purposes to make a single request to modify multiple configurations. This will provide a wrapper where
individual request for each resource data could be grouped together in a single JSON content. It might provide atomicity
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 the 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.
users 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.