Cisco Cisco ASA 5555-X Adaptive Security Appliance

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

 

Output of Show Commands 

utput of Show Commands

 

 

REST API image file, <path to the file>  

E.g. CLI sequence for installing rest-api image: 

copy tftp://<tftpserver/asa-restapi-9.3.2-32.pkg disk0: 

rest-api image disk0:/asa-restapi-9.3.2-32.pkg 
E.g. CLI sequence for uninstalling rest-api image: 

no rest-api image disk0:/asa-restapi-9.3.2-32.pkg 

E.g. CLI sequence for Upgrading rest-api image: 
no rest-api image disk0:/asa-restapi-9.3.2-32.pkg 

copy tftp://<tftpserver/asa-restapi-9.3.2-33.pkg disk0: 

rest-api image disk0:/asa-restapi-9.3.2-33.pkg 

REST Agent is a process based on ASDM code. By default REST Agent process will not be started in ASA. A new CLI 

command when invoked by user will start the REST Agent process in ASA. 

[no] rest-api-agent 

Will start the REST Agent process in ASA. Prerequisite: http server should be enabled prior to this. If Http server was not 

enabled warning will be printed in the CLI. 

When enabled ‘/api’ URL requests will be redirected from ASA http server to the REST Agent. 

Will stop the REST Agent process in ASA.  

When disabled, ‘/api’ URL requests will be rejected by ASA http server with 404 status code response. 

Additional boot-strapping required for REST 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>’ 

•  Set the authentication approach for http: ‘aaa authentication http console LOCAL’ 

•  Create a local user with privilege 15 (for read/write operations): ‘username <user> password <pass> encrypted 

privilege 15 

•  Configure (static) routes 

REST Agent debugging 

"debug rest-api agent {event | error}" CLI command will enable and show the REST API Agent debug traces on CLI. 

When invoked the above command will trigger message from REST Daemon to REST Agent for enabling and forwarding 

the debug logs. Subsequently REST API Agent will forward debug logs over TCP to REST API Daemon; and these logs