Cisco Cisco ASA 5512-X Adaptive Security Appliance
About the ASA REST API v1.2.2
Special APIs
Special APIs
23
VPN
/api/vpn/
Only Site-to-Site VPN configuration is supported in the REST API. IPv4 and IPv6 are both supported. Site-to-Site VPN
monitoring is not supported.
Limitations:
Only Site-to-Site configuration is supported. Certificate Management as seen in ASDM is not supported.
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
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: []