Cisco Cisco ASA 5555-X Adaptive Security Appliance

About the ASA REST API v1.3.2 
REST API Agent in ASA 

 

REST API Agent in ASA 

Installing and Enabling the ASA REST API Agent 

For physical ASAs, the REST API Agent is published separately from other ASA images on cisco.com. That is, shipped 

physical ASA images do not include the REST API plug-in package. The REST API package must be downloaded to the 
device’s flash and installed using the "rest-api image" command. The REST API Agent is then enabled using the "rest-

api agent" command. 

With a virtual ASA (ASAv), the deployment package includes the REST API image, provided in the "boot:" partition. The 
ASAv is not configured to use the REST API by default, so you must issue the "rest-api image" command, followed by 

the "rest-api agent" command, to access and enable the REST API Agent. 

In multi-context mode, the REST API Agent commands are available only in the System context. 

Note: The REST API Agent is a Java-based application. The Java Runtime Environment (JRE) is bundled in the REST 

API Agent package. 

 ‘rest-api image’ Command 

This command will perform compatibility/validation checks and inform you if there are problems. If all checks pass, it will 
install the REST API image. To uninstall, use the "no" form of the command. 

 

[no] rest-api image disk0:/<package> 

image - Use this keyword to install/uninstall the REST API image on an ASA; provide the destination (in this case, 

"disk0:" for the ASA’s flash memory) and the name of the REST API image package. 

Installing/updating the rest-api package will not trigger a reboot of the ASA. 

This configuration will be saved in the startup config file.  

Example 

This example downloads the REST API package from a TFTP server and then installs it: 

rest-api image disk0:/asa-restapi-121-lfbff-k8.SPA 

Supported Modes 

single/multiple context, routed/transparent 

Additional Boot-strapping Required for the REST API Agent 

•  Enable HTTP server and let clients connect over management interface:  

    http server enable 

    http 0.0.0.0 0.0.0.0 <mgmt interface nameif> 

•  Configure (static) routes.