Aqua CSPM is based on a REST API that powers all of its core logic. Nearly all of this API can be accessed via an API key, without using the Aqua interface.


TABLE OF CONTENTS


Generating an API key

  1. Sign in to the Aqua console and navigate to the CSPM > Account Management > API Keys page.


If you are on the Enterprise plan, navigate to CSPM > Settings > API Keys. 


2. Click Generate API Key at the top right of the page.


Be sure to save the API secret because it will not be accessible after the window is closed.


Accessing API documentation

The Aqua API is well-documented and includes detailed code samples and response data. It can be accessed here


API key permissions

API key permissions allow you to control the specific endpoints and provide granular control. In addition to general permissions, additional restrictions such as IP address restriction and group restriction can be imposed to limit the scope of the API keys. To know more, see Controlling API Key Permissions.


API code samples

You can find sample code and scripts in our GitHub repository.