<header id="hub-header" style="height: auto; position: relative; top: 0px; left: 0px; width: 1383px; z-index: 100; -webkit-box-flex: 1; flex: 0 0 auto; color: rgb(76, 85, 90); font-family: &quot;proxima nova&quot;, proxima-nova, -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, &quot;open sans&quot;, Helvetica, Arial, sans-serif, &quot;Apple Color Emoji&quot;, &quot;Segoe UI Emoji&quot;; letter-spacing: normal;">

<div id="header-top" style="height: auto; padding: 2px 30px; background-position: left top; background-repeat: no-repeat; background-color: rgb(0, 30, 255); background-size: cover; background-image: url(&quot;https://files.readme.io/b1ba90b-AquaDoc_Cover.jpg&quot;);">

<div class="hub-container" style="max-width: none; margin: 0px; position: relative;">

<div class="clearfix" style="height: 60px; display: flex; -webkit-box-align: center; align-items: center;"> [# Aqua Enterprise](https://docs.aquasec.com/)

<nav style="width: 1183px;">

* [Guides](https://docs.aquasec.com/docs "Guides")
* [API Reference](https://docs.aquasec.com/reference "API Reference")
* [Knowledge Base](https://support.aquasec.com/)

* <span login="login" class="" style="height: 40px; line-height: 40px; margin: 3px 0px; padding: 4px 10px; color: rgba(255, 255, 255, 0.5);"><span ng-show="!user.loggedIn" class="login"></span></span>

</nav>

</div>

</div>

</div>

<div id="hub-subheader-parent" style="height: 38px;">

<div id="hub-subheader" style="height: 38px; background-color: rgb(246, 247, 248); padding: 0px 30px; font-size: 15px; position: relative; border-bottom: 1px solid rgb(218, 222, 226);">

<div class="hub-container" style="max-width: none; margin: 0px; position: relative;">

<nav id="header-bottom-nav" style="position: relative;">

<div id="header-icon-nav">

<div class="icons" style="height: 38px;">

<div class="hub-subheader-breadcrumbs" style="display: inline-block; vertical-align: top; margin-left: -10px;"><span dropdown="" class="left-dropdown dropdown ng-isolate-scope" style="display: inline-block; margin-left: 0px; margin-right: 10px; height: 38px;"></span><span dropdown="" class="left-dropdown dropdown ng-isolate-scope" style="display: inline-block; margin-left: 0px; margin-right: 10px; height: 38px;"></span></div>

<div>

<div id="hub-search" searchbox="" newux="enabled" class="ng-scope"> <button data-symbol="⌃" class="searchbox searchbox-button searchbox-input" style="color: rgb(136, 136, 136); bottom: 0px; height: 38px; position: absolute; right: 0px; top: 0px; width: 224.906px; z-index: 1001; -webkit-box-align: center; align-items: center; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial; border-width: 0px; border-style: initial; border-color: initial; display: flex; transition: width 0.3s ease-out 0s;"><div class="search-symbol ng-binding" style="color: rgb(147, 158, 174); font-family: sans-serif; font-size: 0.66rem; position: absolute; right: 0px; top: 19px; transform: translate(0px, -50%); line-height: 1; padding: 5px 4px; border: 1px solid rgb(222, 229, 232); border-radius: 3px; background: rgb(255, 255, 255); opacity: 0.7;">⌃K</div></button> </div>

</div>

</div>

</div>

</nav>

</div>

</div>

</div>

</header>

<div id="hub-container" ng-class="{loading:contentLoadingSection}" style="transition: opacity 0.1s ease-out 0s; opacity: 1; filter: none; -webkit-box-flex: 1; flex: 1 0 auto; color: rgb(76, 85, 90); font-family: &quot;proxima nova&quot;, proxima-nova, -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, &quot;open sans&quot;, Helvetica, Arial, sans-serif, &quot;Apple Color Emoji&quot;, &quot;Segoe UI Emoji&quot;; font-size: 15px; letter-spacing: normal;">

<div class="hub-container" style="max-width: none; margin: 0px; position: relative; display: flex;">

<div id="hub-sidebar-parent" sidebar="sidebar" class="hub-sidebar-sticky" style="width: 246px; left: auto; height: 100vh; z-index: 10; min-width: 246px; max-height: 100vh; position: sticky !important; top: 0px !important;">

<nav id="hub-sidebar" style="height: 1489px; max-height: 100vh; overflow: auto; position: relative; background-image: initial; background-position: initial; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial; font-size: 13px; margin-left: 10px;">

<div class="scrollable-parent" style="height: 1489px; width: 236px;">

<div class="nano ng-isolate-scope has-scrollbar" scroll-to-top="state.current().root" style="position: relative; width: 236px; height: 1489px; overflow: hidden; border-right: 1px solid rgb(221, 221, 221); margin-right: -1px;">

<div class="nano-content" ng-transclude="" tabindex="0" style="position: absolute; overflow: hidden scroll; inset: 0px -17px 0px 0px;">

<div id="hub-sidebar-content" class="ng-scope" style="margin: 40px 0px 10px; padding: 0px 10px;">

<div ng-show="state.current().root == 'reference' || state.current().root == 'preview'">

<div class="hub-sidebar-category">

### GENERAL INFORMATION

* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Aqua Enterprise API Overview</div>](https://docs.aquasec.com/reference#aqua-api-overview "Aqua Enterprise API Overview")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Authentication</div>](https://docs.aquasec.com/reference#rest-api "Authentication")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Trying the Aqua Enterprise v2 API Endpoints</div>](https://docs.aquasec.com/reference#trying-the-aqua-csp-v2-api-endpoints "Trying the Aqua Enterprise v2 API Endpoints")

</div>

<div class="hub-sidebar-category active">

### AQUA ENTERPRISE V1 API

* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Access Control Policies</div>](https://docs.aquasec.com/reference#access-control-policies "Access Control Policies")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Aqua Consoles</div>](https://docs.aquasec.com/reference#api-aqua-consoles "Aqua Consoles")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Aqua Labels</div>](https://docs.aquasec.com/reference#aqua-labels-api "Aqua Labels")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Audit Events</div>](https://docs.aquasec.com/reference#audit-events-api "Audit Events")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Aqua Servers</div>](https://docs.aquasec.com/reference#aqua-servers "Aqua Servers")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Container Firewall Policies</div>](https://docs.aquasec.com/reference#container-firewall-policies-api "Container Firewall Policies")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Enforcer Groups</div>](https://docs.aquasec.com/reference#enforcer-batch-deployment "Enforcer Groups")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Enforcer Host Management</div>](https://docs.aquasec.com/reference#enforcer-host-management "Enforcer Host Management")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Image Assurance</div>](https://docs.aquasec.com/reference#image-assurance "Image Assurance")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Image Export and Import</div>](https://docs.aquasec.com/reference#image-export-and-import "Image Export and Import")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Image Manipulation</div>](https://docs.aquasec.com/reference#image-manipulation "Image Manipulation")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Image Profiles</div>](https://docs.aquasec.com/reference#image-profiles "Image Profiles")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Image Registries</div>](https://docs.aquasec.com/reference#image-registries "Image Registries")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Image Scan Queue</div>](https://docs.aquasec.com/reference#image-scan-queue "Image Scan Queue")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Image Scanning</div>](https://docs.aquasec.com/reference#image-scanning-api "Image Scanning")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Integration: Qualys Configuration</div>](https://docs.aquasec.com/reference#integration-qualys-configuration "Integration: Qualys Configuration")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Integration: Syslog Configuration</div>](https://docs.aquasec.com/reference#integration-syslog-configuration "Integration: Syslog Configuration")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Orchestration</div>](https://docs.aquasec.com/reference#orchestration "Orchestration")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Secret Key Stores</div>](https://docs.aquasec.com/reference#secret-key-stores "Secret Key Stores")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Secrets</div>](https://docs.aquasec.com/reference#secrets "Secrets")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Service Network Monitoring</div>](https://docs.aquasec.com/reference#application-network-monitoring "Service Network Monitoring")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Services</div>](https://docs.aquasec.com/reference#services "Services")
* [<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">User Management</div>](https://docs.aquasec.com/reference#user-management "User Management")

</div>

<div class="hub-sidebar-category">

### AQUA ENTERPRISE V2 API

* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Application Scopes</div>](https://docs.aquasec.com/reference#application-scopes-1 "Application Scopes")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Applications</div>](https://docs.aquasec.com/reference#applications "Applications")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Assurance Policies</div>](https://docs.aquasec.com/reference#assurance-policies "Assurance Policies")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Containers</div>](https://docs.aquasec.com/reference#containers-1 "Containers")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Custom Vulnerability Severities</div>](https://docs.aquasec.com/reference#custom-vulnerability-severities "Custom Vulnerability Severities")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Database</div>](https://docs.aquasec.com/reference#database "Database")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Firewall Policies</div>](https://docs.aquasec.com/reference#firewall-policies-1 "Firewall Policies")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Images</div>](https://docs.aquasec.com/reference#images "Images")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Infrastructure</div>](https://docs.aquasec.com/reference#infrastructure-1 "Infrastructure")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Licenses</div>](https://docs.aquasec.com/reference#licenses "Licenses")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Notifications</div>](https://docs.aquasec.com/reference#notifications "Notifications")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Permission Sets</div>](https://docs.aquasec.com/reference#permission-sets-1 "Permission Sets")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Roles</div>](https://docs.aquasec.com/reference#roles-1 "Roles")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Scopes</div>](https://docs.aquasec.com/reference#scopes "Scopes")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Registries</div>](https://docs.aquasec.com/reference#registries "Registries")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Reports</div>](https://docs.aquasec.com/reference#reports "Reports")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Repositories</div>](https://docs.aquasec.com/reference#repositories "Repositories")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Risk Explorer</div>](https://docs.aquasec.com/reference#risk-explorer "Risk Explorer")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Risks</div>](https://docs.aquasec.com/reference#risks "Risks")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Runtime Policies</div>](https://docs.aquasec.com/reference#runtime-policies "Runtime Policies")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Server Information</div>](https://docs.aquasec.com/reference#server-information "Server Information")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Serverless Functions</div>](https://docs.aquasec.com/reference#serverless-functions "Serverless Functions")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Serverless Applications</div>](https://docs.aquasec.com/reference#serverless-applications-1 "Serverless Applications")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Settings</div>](https://docs.aquasec.com/reference#settings "Settings")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Users</div>](https://docs.aquasec.com/reference#users-1 "Users")
* [<span ng-click="toggleMenu()" class="fa fa-chevron-right" style="font-size: 0.8em; transform: rotate(0deg); margin-bottom: auto; -webkit-box-ordinal-group: 1; order: 1; margin-left: auto; transition: transform 0.3s ease-out 0s; color: inherit; padding: 2px; cursor: default;"></span>

<div class="link-title" style="font-weight: 400; overflow: hidden; text-overflow: ellipsis;">Workloads</div>](https://docs.aquasec.com/reference#workloads-1 "Workloads")

</div>

</div>

</div>

</div>

</div>

</div>

</nav>

</div>

<section id="hub-content" style="width: 1137px; padding: 0px; max-width: calc(100% - 246px); margin: 0px 0px 0px auto;">

<div state-container="" ng-class="{loading: contentLoading}" class="hub-content-container" data-state-container="true" style="transition: opacity 0.1s ease-out 0s;">

<div id="api-explorer" ng-non-bindable="" class="ng-scope">

<div class="is-lang-curl">

<div class="content-body hub-reference-sticky hub-reference-theme-row" id="hub-reference">

<div class="hub-reference" id="page-aqua-api-overview" style="clear: both; position: relative;"><a class="anchor-page-title" id="aqua-api-overview" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 0px;">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Aqua Enterprise API Overview

</header>

</div>

</div>

<div class="hub-reference-section" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell;">

<div class="content-body" style="padding-top: 30px;">

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

Aqua Enterprise provides a RESTful HTTP API, covering all of the Server's functionality, therefore allowing complete usage of the system without the internal UI. Clients can use this API from other software or from the command line (via tools like `<span class="cm-s-neo">curl</span>`), or they can construct their own UIs.

After deployment of the Aqua Server, the API will be available using HTTP (usually on port 8080) and HTTPS (port 8443). There are two major API versions:

* <span style="font-weight: 700;">v1</span>: available under the `<span class="cm-s-neo">/api/v1</span>` base path; this was the original API provided by Aqua Enterprise since its initial release. This API is being progressively deprecated in favor of the v2 API.
* <span style="font-weight: 700;">v2</span>: available under the `<span class="cm-s-neo">/api/v2</span>` base path; this API was introduced in Aqua Enterprise v3.0.0\. It is currently meant to be used alongside v1 until it completely supersedes v1\. As opposed to the v1 API, this API is sub-versioned, meaning clients use the API at a specific sub-version, with the server automatically providing backwards compatibility depending on the sub-version used. See more information later on.

On the host running the Aqua Server, the base URI for the v1 API will be `<span class="cm-s-neo">http://localhost:8080/api/v1</span>` and `<span class="cm-s-neo">https://localhost:8443/api/v1</span>`, for example, while the v2 API will be `<span class="cm-s-neo">http://localhost:8080/api/v2</span>` and `<span class="cm-s-neo">https://localhost:8443/api/v2</span>`.

All API requests containing a body (i.e. `<span class="cm-s-neo">POST</span>` and `<span class="cm-s-neo">PUT</span>` requests) are expected to be JSON-formatted, unless otherwise stated in the API specification. The body must also be UTF-8 encoded. Requests must therefore include a `<span class="cm-s-neo">Content-Type</span>` header with the value `<span class="cm-s-neo">application/json; charset=UTF-8</span>`.

All API responses will either include a JSON-formatted UTF-8 response (and thus will include a `<span class="cm-s-neo">Content-Type</span>` header with the value `<span class="cm-s-neo">application/json; charset=UTF-8</span>`), or no content at all (in which case a _204 HTTP_ status code will be returned). You must ensure that requests include an `<span class="cm-s-neo">Accept</span>` header with `<span class="cm-s-neo">application/json</span>` included in the value.

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="get-api-information"></span>Get API Information

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

General information about the API, including its version and the base path, can be accessed by sending a `<span class="cm-s-neo">GET</span>` request to the `<span class="cm-s-neo">/api</span>` path.

<span style="font-weight: 700;">Description</span>: Get API version and information
Usage: GET /api
Security: No authentication required
Produces: application/json

Response structure:

* <span style="font-weight: 700;">product</span>: the name of the product ("Aqua Container Security"); string, required
* <span style="font-weight: 700;">version</span>: the version number, in "major.minor.build" format; string, required
* <span style="font-weight: 700;">major_version</span>: the major version number; string, required
* <span style="font-weight: 700;">minor_version</span>: the minor version number; string, required
* <span style="font-weight: 700;">build_date</span>: the compilation date of the server software; string, required
* <span style="font-weight: 700;">api_endpoint</span>: the base path of the API (e.g. "/api/v1"); string, required
* <span style="font-weight: 700;">company</span>: the name of the copyright holder; string, required
* <span style="font-weight: 700;">copyright</span>: copyright message; string, required

Sample response:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [JSON](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

{
"api_endpoint": "/api/v1",
"build_date": "May 26 2016 12:22:11",
"company": "Aqua Security Software Ltd",
"copyright": "Copyright © 2016 Aqua Security Software Ltd. All rights reserved.",
"major_version": "1",
"minor_version": "1",
"product": "Aqua Container Security",
"version": "1.1.1d2addb"
}

</div>

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="api-errors"></span>API Errors

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

Whenever requests fail due to user errors, authentication errors or any other error, a non-success response will be returned including the text of the error. The response content structure will be:

* <span style="font-weight: 700;">message</span>: the text of the error; string, required
* <span style="font-weight: 700;">code</span>: an internal error code; integer, required

For example:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

HTTP/1.1 401 Unauthorized
Content-Length: 100
Content-Type: application/json
Date: Tue, 10 May 2016 15:47:28 GMT
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Xss-Protection: 1; mode=block

{ "message": "You are not authorized to perform this action", "code": 401 }

</div>

</div>

</div>

</div>

</div>

</div>

<div class="hub-reference" id="page-rest-api" style="clear: both; position: relative;"><a class="anchor-page-title" id="rest-api" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Authentication

</header>

</div>

</div>

<div class="hub-reference-section" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell;">

<div class="content-body" style="padding-top: 30px;">

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

In order to use the REST API, clients must authenticate with the Aqua Server. There are two methods to perform authentication. These are described below.

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="jwt-authentication"></span>JWT Authentication

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

This is the preferred method of authentication, as it provides better safety in untrusted environments. Clients authenticate with a simple HTTP request, and receive a session token (a JSON Web Token) from the server. Further requests to the API must include an Authorization header including this token. By default, tokens are valid for 9 hours, but clients can ask for an extended session of up to 30 days.

To authenticate, send a `<span class="cm-s-neo">POST</span>` request to the path `<span class="cm-s-neo">/api/v1/login</span>`. The JSON request should include the following parameters:

* <span style="font-weight: 700;">id</span>: the ID of the user to authenticate as; string, required
* <span style="font-weight: 700;">password</span>: the password of the user; string, required
* <span style="font-weight: 700;">remember</span>: whether to create an extended 30 day session; boolean; if false or missing, session token will be valid for 9 hours

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [JSON](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

{ "id": "administrator", "password": "SuperSecret" }

</div>

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

Successful authentication will result in a `<span class="cm-s-neo">200 OK</span>` response, with the following content structure:

* <span style="font-weight: 700;">token:</span> the session token generated; string, required
* <span style="font-weight: 700;">user:</span> the information of the authenticated user, including:
* <span style="font-weight: 700;">id:</span> the ID of the user; string, required
* <span style="font-weight: 700;">name:</span> the name of the user; string
* <span style="font-weight: 700;">type:</span> the type of the user; string, required
* <span style="font-weight: 700;">email:</span> the email address of the user; string, required

Unsuccessful authentication will result in a `<span class="cm-s-neo">401 Unauthorized</span>` response, with general [error structure](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#api-errors).

Example of a successful request:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

POST /api/v1/login HTTP/1.1
Accept: application/json
Content-Length: 47
Content-Type: application/json
Host: localhost:8080

{
"id": "administrator",
"password": "SuperSecret"
}

</div>

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

Example of successful response:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

HTTP/1.1 200 OK
Content-Length: 619
Content-Type: application/json
Date: Tue, 10 May 2016 15:47:28 GMT
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Xss-Protection: 1; mode=block

{
"token": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0NjI5Mjc2NDgsImlhdCI6MTQ2Mjg5NTI0OCwic3ViIjoiYWRtaW5pc3RyYXRvciJ9.Sp8JtncVdDcmn2TlBy9dAlzVAPNMiP6sFRa7_GMeCcjIJhmwReSM_keYBri58BHvFUljL8nts6cSpo2P8j3wvMupmgREpupJw-W-svDbAwh-pCTmIAk96ME-Cwt9A9bCEU4ClrEAZvlmCpGWSUUc8PoQhcCGsYIWVxWMWRmQPnorZLGh6zOQmxIVO2PhtFCGDCyCWFDy0n4fHP5xq6JrdgDrSWo-D6dG8qzN_g1qgKbgl0QNATfp6jGuugVUxQ-0wV89yg5fJjZeml84KGS6YF5GcyIK61ZWTfyi5_svMuMT15pA53pJtRayC_oqbifUu__BQJFHX4b_spudWJsYAg",
"user": {
"admin": true,
"email": "",
"id": "administrator",
"image": null,
"name": "administrator",
"type": ""
}
}

</div>

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

Once a token has been generated, all subsequent HTTP requests must include the token in the `<span class="cm-s-neo">Authorization</span>` header, appended to the string "Bearer ", like this:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

Authorization: Bearer eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0NjI5Mjc2NDgsImlhdCI6MTQ2Mjg5NTI0OCwic3ViIjoiYWRtaW5pc3RyYXRvciJ9.Sp8JtncVdDcmn2TlBy9dAlzVAPNMiP6sFRa7_GMeCcjIJhmwReSM_keYBri58BHvFUljL8nts6cSpo2P8j3wvMupmgREpupJw-W-svDbAwh-pCTmIAk96ME-Cwt9A9bCEU4ClrEAZvlmCpGWSUUc8PoQhcCGsYIWVxWMWRmQPnorZLGh6zOQmxIVO2PhtFCGDCyCWFDy0n4fHP5xq6JrdgDrSWo-D6dG8qzN_g1qgKbgl0QNATfp6jGuugVUxQ-0wV89yg5fJjZeml84KGS6YF5GcyIK61ZWTfyi5_svMuMT15pA53pJtRayC_oqbifUu__BQJFHX4b_spudWJsYAg

</div>

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="basic-authentication"></span>Basic Authentication

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

This method uses standard Basic HTTP Authentication. While simple, its usage is discouraged, and support for it will be removed in later versions of the server. When using Basic Authentication, all HTTP requests from clients must include an Authorization header with the username and password in Base64 encoding. To generate this header, the username and password are combined with a separating colon (e.g. "username:password"), and the resulting string is encoded using Base64\. This encoded value is appended to the string "Basic ", and used as the value of the Authorization header, for example:

See [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basic_access_authentication) for more information.

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

</div>

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

See [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basic_access_authentication) for more information.

</div>

</div>

</div>

</div>

</div>

<div class="hub-reference" id="page-trying-the-aqua-csp-v2-api-endpoints" style="clear: both; position: relative;"><a class="anchor-page-title" id="trying-the-aqua-csp-v2-api-endpoints" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Trying the Aqua Enterprise v2 API Endpoints

</header>

</div>

</div>

<div class="hub-reference-section" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell;">

<div class="content-body" style="padding-top: 30px;">

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

To use the <span style="font-weight: 700;">Try It</span> tool:
1\. Set the parameter values from the <span style="font-weight: 700;">Try It</span> tool on the page.
2\. Copy the constructed command, in your language of choice, to the clipboard.
3\. Paste the command to your console.
4\. Insert the address of your Aqua server into the URL (after the `<span class="cm-s-neo">https://</span>`).
5\. Run the command.

</div>

</div>

</div>

</div>

</div>

<div class="hub-reference" id="page-access-control-policies" style="clear: both; position: relative;"><a class="anchor-page-title" id="access-control-policies" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Access Control Policies

</header>

</div>

</div>

<div class="hub-reference-section" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell;">

<div class="content-body" style="padding-top: 30px;">

<div class="magic-block-callout type-info " style="margin-left: 31px; border-left: 4px solid rgb(91, 192, 222); padding: 13px 13px 13px 23px; position: relative; margin-bottom: 13px; background-color: rgb(240, 250, 255); border-top-color: rgb(91, 192, 222); border-right-color: rgb(91, 192, 222); border-bottom-color: rgb(91, 192, 222);">

### <span class="fa fa-info-circle" title="Info" style="font-size: 18px; transform: translate(0px, 0px); pointer-events: none; opacity: 0.3; margin-right: 6px; position: relative; top: 1px;"></span>Note

<div class="callout-body" style="margin-top: 10px; padding-left: 22px;">

Access Control Policies define container-side access control on hosts running the Aqua Enforcer. For server-side user management (i.e., user access to the Aqua Server or the REST API itself), see [User Management](file:///C:/docs/user-management).

</div>

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="list-policies"></span>List Policies

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

<span style="font-weight: 700;">Description:</span> Returns a list of all access control policies in the system.
<span style="font-weight: 700;">Usage</span>: GET /api/v1/adminrules
<span style="font-weight: 700;">Security:</span> Requires JWT or basic authentication
<span style="font-weight: 700;">Produces:</span> application/json

This route returns a JSON array of policy structures. Pagination is supported by the use of URI query parameters. By default, the first 100 policies are returned.

Supported query parameters:

* <span style="font-weight: 700;">pagesize</span>: the number of policies to return per request; integer, defaults to 100
* <span style="font-weight: 700;">page</span>: the number of the page to return results for; integer, defaults to 1

Response structure:

* <span style="font-weight: 700;">count</span>: the total number of policies in the system; integer, required
* <span style="font-weight: 700;">page</span>: the current page of results returned; integer, required
* <span style="font-weight: 700;">pagesize</span>: the number of policies returned in this page; integer, required
* <span style="font-weight: 700;">result</span>: the list of policies in the current page; array of policy objects, required by may be empty; policy structure is as described in [Get Policy](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#get-policy)

Sample request:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

GET /api/v1/adminrules?pagesize=2 HTTP/1.1
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json

</div>

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

Sample response:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Length: 274
Content-Type: application/json; charset=utf-8
Date: Wed, 25 May 2016 15:11:04 GMT
Vary: Accept-Encoding
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Xss-Protection: 1; mode=block

{
"count": 3,
"page": 1,
"pagesize": 2,
"result": [{
"accessors": {
"users": ["bob"]
},
"author": "administrator",
"description": "Access policy for an auditor who can view logs",
"lastupdate": 1464187718,
"name": "auditor",
"resources": {
"containers": ["*"],
"images": ["*"]
},
"role": "administrator",
"version": ""
},
{
"accessors": {
"users": ["alice", "michael"]
},
"author": "administrator",
"description": "Access policy for image builders",
"lastupdate": 1464189014,
"name": "builder",
"resources": {
"images": ["*"]
},
"role": "image-builder",
"version": "1.1"
}
]
}

</div>

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="create-policy"></span>Create Policy

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

<span style="font-weight: 700;">Description:</span> Create a new access control policy.
<span style="font-weight: 700;">Usage:</span> POST /api/v1/adminrules
<span style="font-weight: 700;">Security:</span> Requires JWT or basic authentication
<span style="font-weight: 700;">Consumes:</span> application/json
<span style="font-weight: 700;">Produces:</span> application/json

The request content structure is as follows:

* <span style="font-weight: 700;">name:</span> the name of the policy to create; string, required; names should preferrably not include spaces or special characters
* <span style="font-weight: 700;">description:</span> a short description of the policy; string, optional
* <span style="font-weight: 700;">role:</span> the policy's role; string, required, one of:
* "administrator"
* "image-builder"
* "backup-operator"
* "container-operator"
* "image-deployer"
* "auditor"
* "docker-user"
* "container-owner"
see [Access Roles](file:///C:/docs/access-roles) for description of these roles.
* <span style="font-weight: 700;">accessors:</span> an object describing users/groups the policy is valid for, of the following structure:
* <span style="font-weight: 700;">users</span>: list of user IDs the policy is valid for; array of strings, optional
* <span style="font-weight: 700;">groups</span>: list of user groups the policy is valid for; array of strings, optional
At least one user or group must be defined.
* <span style="font-weight: 700;">resources:</span> an object describing a resource the policy is valid for, of the following structure:
* <span style="font-weight: 700;">containers:</span> list of container names/IDs, or "*" for all containers; array of strings, optional
* <span style="font-weight: 700;">Application:</span> list of application names, or "*" for all applications; array of strings, optional
* <span style="font-weight: 700;">Image:</span> list of image names, or "*" for all images; array of strings, optional
* <span style="font-weight: 700;">Volume:</span> list of volume names, or "*" for all volumes; array of strings, optional
* <span style="font-weight: 700;">Network:</span> list of network names, or "*" for all networks; array of strings, optional
At least one resource must be defined.

Sample request:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

POST /api/v1/adminrules HTTP/1.1
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json;charset=utf-8

{
"name": "auditor",
"description": "Access policy for an auditor who can view logs",
"role": "auditor",
"resources": {
"containers": ["*"],
"images": ["myapp:latest"]
},
"accessors": {
"users": ["bob"]
}
}

</div>

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

A successful response will have no content and return a `<span class="cm-s-neo">204 No Content</span>` status.

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="get-policy"></span>Get Policy

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

<span style="font-weight: 700;">Description:</span> Get the structure of an existing access control policy.
<span style="font-weight: 700;">Usage:</span> GET /api/v1/adminrules/{policy name}
<span style="font-weight: 700;">Security:</span> Requires JWT or basic authentication
<span style="font-weight: 700;">Produces:</span> application/json

The following response structure is returned:

* <span style="font-weight: 700;">name</span>: the name of the policy; string, required
* <span style="font-weight: 700;">description</span>: the policy's description; string, optional
* <span style="font-weight: 700;">lastupdate</span>: the last time the policy was updated in unix time; integer, required
* <span style="font-weight: 700;">role</span>: the policy's role, as described in [Create Policy](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#create-policy); string, required
* <span style="font-weight: 700;">author</span>: the ID of the user who created the policy; string, required
* <span style="font-weight: 700;">version</span>: the policy format version (current format version is 1.1); string, required
* <span style="font-weight: 700;">accessors</span>: the accessors object as described in [Create Policy](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#create-policy); required
* <span style="font-weight: 700;">resources</span>: the resources object as described in Create Policy; required

Sample response:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 1; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial; filter: none;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Type: application/json; charset=utf-8
Vary: Accept-Encoding
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
x-xss-protection: 1; mode=block
Date: Wed, 25 May 2016 14:38:00 GMT
Content-Length: 201

{
"name": "auditor",
"description": "Access policy for an auditor who can view logs",
"lastupdate": 1464186993,
"role": "auditor",
"author": "administrator",
"version": "1.1",
"accessors": {
"users": ["bob"]
},
"resources": {
"images": ["myapp:latest"],
"containers": ["*"]
}
}

</div>

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="update-policy"></span>Update Policy

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

<span style="font-weight: 700;">Description:</span> Update an existing access control policy.
<span style="font-weight: 700;">Usage:</span> PUT /api/v1/adminrules/{policy name}
<span style="font-weight: 700;">Security:</span> Requires JWT or basic authentication
<span style="font-weight: 700;">Consumes:</span> application/json
<span style="font-weight: 700;">Produces:</span> application/json

This method accepts the same structure as in the [policy creation](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#create-policy) method, and also returns `<span class="cm-s-neo">204 No Content</span>` on success.

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="delete-policy"></span>Delete Policy

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

<span style="font-weight: 700;">Description:</span> Delete an access control policy.
<span style="font-weight: 700;">Usage:</span> DELETE /api/v1/adminrules/{policy name}
<span style="font-weight: 700;">Security:</span> Requires JWT or basic authentication

No parameters are expected. Upon successful removal a `<span class="cm-s-neo">204 No Content</span>` status will be returned.

</div>

</div>

</div>

</div>

</div>

<div class="hub-reference" id="page-api-aqua-consoles" style="clear: both; position: relative;"><a class="anchor-page-title" id="api-aqua-consoles" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Aqua Consoles

</header>

</div>

</div>

<div class="hub-reference-section" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell;">

<div class="content-body" style="padding-top: 30px;">

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

This method is for retrieving information concerning all Aqua consoles. In [Active-Active Server Mode](file:///C:/docs/active-active-server-mode) there may be up to 6 consoles.

</div>

<div class="magic-block-api-header" style="margin-top: 30px; margin-bottom: 13px; position: relative;">

# <span id="console-information"></span>Console Information

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

<span style="font-weight: 700;">Description:</span> Retrieve information on the configured consoles
<span style="font-weight: 700;">Usage</span>: GET /api/v1/consoles
<span style="font-weight: 700;">Security:</span> Requires JWT or basic authentication
<span style="font-weight: 700;">Consumes:</span> application/json
<span style="font-weight: 700;">Produces:</span> application/json

Request structure - query parameters:

* <span style="font-weight: 700;">page</span>: page number to start at; integer, default: 1
* <span style="font-weight: 700;">pagesize</span>: number of results to display on each page; integer, default: 50

The <span style="font-weight: 700;">page</span> parameter is typically used to present the next page of the results.

Produces a JSON array of all consoles configured in the system. Each console entry includes information on (see full structure in the sample below):

* <span style="font-weight: 700;">Identification information</span>: the unique identifier of the console, its logical name, display name, and addresses to connect to the console.
* <span style="font-weight: 700;">System version information</span>: The current version and update information

Sample request:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)
* [cURL](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

POST /api/v1/consoles?page=1&pagesize=50 HTTP/1.1
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json;charset=utf-8

</div>

</div>

<div class="magic-block-textarea" style="margin-top: 13px; margin-bottom: 13px; position: relative;">

Sample response:

</div>

<div class="magic-block-code" style="background-color: rgb(246, 246, 246); margin-top: 19px; margin-bottom: 19px;">

* [HTTP](file:///C:/Users/zkvhxz0/Downloads/Aqua%20Consoles.html#)

<div class="block-code-code" style="padding: 20px 20px 20px 31px;"><button class="copy-code-button" type="button" style="color: rgb(255, 255, 255); opacity: 0; transition: opacity 0.25s ease 0s; float: right; border-width: initial; border-style: none; border-color: initial; padding: 0px; background-image: initial; background-position: 0px 0px; background-size: initial; background-repeat: initial; background-attachment: initial; background-origin: initial; background-clip: initial;"><span class="fa fa-clipboard" style="display: block; transform: translate(0px, 0px); padding: 5px; border-radius: 3px; width: 32px; background: rgba(0, 0, 0, 0.2);"></span></button>

HTTP/1.1 200 OK
Content-Encoding: application/json; charset=UTF-8
Vary: Accept-Encoding
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
x-xss-protection: 1; mode=block
Date: Thu, 23 July 2020 09:00:36 GMT
Content-Length: 1403

{
"count": 1,
"page": 1,
"pagesize": 50,
"result": [
{
"project_id": 1,
"id": "8522744b25e2_web",
"logicalname": "8522744b25e2",
"description": "",
"type": "WEB_SERVER",
"version": "5.3.20205",
"commit": "9790ccd8",
"hostname": "8522744b25e2",
"is_master": false,
"address": "172.17.0.3",
"grpc_address":"172.17.0.3:8443",
"public_addresses": "172.17.0.3",
"lastupdate": 1575968417,
"status": "connect",
"serverid": "",
"server_name": "",
"docker_version": "",
"host_os": "Alpine Linux v3.9"
}
]
}

</div>

</div>

</div>

</div>

</div>

</div>

<div class="hub-reference" id="page-aqua-labels-api" style="clear: both; position: relative;"><a class="anchor-page-title" id="aqua-labels-api" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Aqua Labels

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-audit-events-api" style="clear: both; position: relative;"><a class="anchor-page-title" id="audit-events-api" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Audit Events

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-aqua-servers" style="clear: both; position: relative;"><a class="anchor-page-title" id="aqua-servers" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Aqua Servers

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-container-firewall-policies-api" style="clear: both; position: relative;"><a class="anchor-page-title" id="container-firewall-policies-api" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Container Firewall Policies

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-enforcer-batch-deployment" style="clear: both; position: relative;"><a class="anchor-page-title" id="enforcer-batch-deployment" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Enforcer Groups

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-enforcer-host-management" style="clear: both; position: relative;"><a class="anchor-page-title" id="enforcer-host-management" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Enforcer Host Management

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-image-assurance" style="clear: both; position: relative;"><a class="anchor-page-title" id="image-assurance" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Image Assurance

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-image-export-and-import" style="clear: both; position: relative;"><a class="anchor-page-title" id="image-export-and-import" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Image Export and Import

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-image-manipulation" style="clear: both; position: relative;"><a class="anchor-page-title" id="image-manipulation" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Image Manipulation

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-image-profiles" style="clear: both; position: relative;"><a class="anchor-page-title" id="image-profiles" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Image Profiles

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-image-registries" style="clear: both; position: relative;"><a class="anchor-page-title" id="image-registries" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Image Registries

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-image-scan-queue" style="clear: both; position: relative;"><a class="anchor-page-title" id="image-scan-queue" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Image Scan Queue

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-image-scanning-api" style="clear: both; position: relative;"><a class="anchor-page-title" id="image-scanning-api" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Image Scanning

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-integration-qualys-configuration" style="clear: both; position: relative;"><a class="anchor-page-title" id="integration-qualys-configuration" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Integration: Qualys Configuration

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-integration-syslog-configuration" style="clear: both; position: relative;"><a class="anchor-page-title" id="integration-syslog-configuration" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Integration: Syslog Configuration

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-orchestration" style="clear: both; position: relative;"><a class="anchor-page-title" id="orchestration" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Orchestration

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-secret-key-stores" style="clear: both; position: relative;"><a class="anchor-page-title" id="secret-key-stores" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Secret Key Stores

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-secrets" style="clear: both; position: relative;"><a class="anchor-page-title" id="secrets" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Secrets

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-application-network-monitoring" style="clear: both; position: relative;"><a class="anchor-page-title" id="application-network-monitoring" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Service Network Monitoring

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-services" style="clear: both; position: relative;"><a class="anchor-page-title" id="services" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Services

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-user-management" style="clear: both; position: relative;"><a class="anchor-page-title" id="user-management" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## User Management

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-application-scopes-1" style="clear: both; position: relative;"><a class="anchor-page-title" id="application-scopes-1" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Application Scopes

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-get_access-management-scopes" style="clear: both; position: relative;"><a class="anchor-page-title" id="get_access-management-scopes" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## List application scopes

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

List all application scopes

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-post_access-management-scopes" style="clear: both; position: relative;"><a class="anchor-page-title" id="post_access-management-scopes" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Create application scope

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Create a new application scope

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-get_access-management-scopes-name" style="clear: both; position: relative;"><a class="anchor-page-title" id="get_access-management-scopes-name" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Get application scope

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Get a specific application scope by its name

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-put_access-management-scopes-name" style="clear: both; position: relative;"><a class="anchor-page-title" id="put_access-management-scopes-name" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Update application scope

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Update an application scope. System-created application scopes cannot be modified.

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-delete_access-management-scopes-name" style="clear: both; position: relative;"><a class="anchor-page-title" id="delete_access-management-scopes-name" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Remove application scope

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Remove an application scope. An application scope can be removed only if it was not created by the system. In addition, application scopes cannot be removed if they are already associated with an Aqua Policy or Service; you need to remove the association first.

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-post_access-management-scopes-delete" style="clear: both; position: relative;"><a class="anchor-page-title" id="post_access-management-scopes-delete" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Delete application scopes

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Delete one or more application scopes

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-get_access-management-scopes-name-affected-entities" style="clear: both; position: relative;"><a class="anchor-page-title" id="get_access-management-scopes-name-affected-entities" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Get entities affected by application scope

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Get all entities affected by a specific application scope, such as Aqua Policies and Services

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-get_access-management-scopes-available" style="clear: both; position: relative;"><a class="anchor-page-title" id="get_access-management-scopes-available" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Get user's application scopes

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Get the logged user's available (enrolled) application scope names

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-get_access-management-categories" style="clear: both; position: relative;"><a class="anchor-page-title" id="get_access-management-categories" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## List RBAC categories

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

List all RBAC (Role-Based Access Control) categories

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-applications" style="clear: both; position: relative;"><a class="anchor-page-title" id="applications" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Applications

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-get_applications" style="clear: both; position: relative;"><a class="anchor-page-title" id="get_applications" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## List Aqua services

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Return a list of all Aqua services

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-get_applications-appid" style="clear: both; position: relative;"><a class="anchor-page-title" id="get_applications-appid" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Get Aqua service

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Return information about an Aqua service

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-assurance-policies" style="clear: both; position: relative;"><a class="anchor-page-title" id="assurance-policies" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Assurance Policies

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-assurance-policy-list" style="clear: both; position: relative;"><a class="anchor-page-title" id="assurance-policy-list" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## List all Assurance Policies

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Get list of Assurance Policies

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-new-assurance-policy" style="clear: both; position: relative;"><a class="anchor-page-title" id="new-assurance-policy" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## Create Assurance Policy

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Create new Assurance Policy based on details specified. Note: The 'readonly' attribute can only be set to false when creating an Assurance Policy.

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-assurance-policy-list-type" style="clear: both; position: relative;"><a class="anchor-page-title" id="assurance-policy-list-type" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2px; pointer-events: auto;"></a>

<div class="hub-reference-section hub-reference-section-top" style="position: relative; clear: both; display: table; table-layout: fixed; width: 1137px;">

<div class="hub-reference-left" style="display: table-cell; border-top: 1px solid rgb(221, 221, 221);">

<header style="padding-left: 30px; padding-top: 40px; padding-right: 30px; margin-left: 0px; margin-bottom: 0px;">

## List Assurance Policies of specified type

<div class="markdown-body excerpt" style="font-size: var(--markdown-font-size,14px); text-size-adjust: 100%; font-family: var(--markdown-font); line-height: var(--markdown-line-height); color: var(--markdown-text); margin-top: 15px; margin-bottom: 15px; padding: 0px; width: 687px; max-width: 100%;">

Get list of Assurance Policies of the specified type

</div>

</header>

</div>

</div>

</div>

<div class="hub-reference" id="page-delete-assurance-policy" style="clear: both; position: relative;"><a class="anchor-page-title" id="delete-assurance-policy" style="color: rgb(7, 177, 212); font-weight: 700; top: 1px; position: absolute; width: 2px; height: 2