Cisco Cisco ASA 5580 Adaptive Security Appliance

Page of 29
 
About the ASA REST API v1.3.2 
Special APIs 
 
24 
Special APIs 
Bulk API 
As a convenience, this API lets you group multiple POST, PUT, PATCH, and DELETE requests for different resources into 
a single HTTP POST call. This means you can make a single request to modify multiple resources, with each contained 
request being processed in order of appearance in the payload. However, note that the content of a bulk request is 
treated as an atomic configuration change: if any of the requests within it fail, the whole payload is rejected, and no 
changes are made to the ASA configuration. 
The details of the request payload and response structure are as follows: 
POST URL: /api 
Request payload format: [{}, {}, {}, ...] where each JSON object is an operation wrapper: 
 method:<HTTP_REQUEST_METHOD_FOR_RESOURCE >,  
 resourceUri:<RESOURCE_URI>, 
 data:<POST_CONTENT_FOR_THIS_URI_IF_APPLICABLE> 
 
Property 
Type 
Description 
method 
string 
 ‘GET’, ‘POST’, ‘DELETE’, ‘PATCH’ calls are supported. 
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 the ‘DELETE’ method, this is 
not needed. 
 
The bulk request response format is: 
entryMessages:[{}, {}, ...],  
commonMessages: []  
 
entryMessages is an array of objects, with each object corresponding to a bulk request entry. 
Generic CLI Command Executer API 
This special API can take single- or multi-line CLI commands and present the CLI output as the API response.