StackHawk Documentation StackHawk Logo HawkDocs
api
scan policies
all stack hawk scan policies

No results found

Try different keywords or check your spelling

Search documentation

Find guides, API references, and more

↑ ↓ ↵ esc

All StackHawk scan policies

GET /api/v1/policy/all

StackHawk Policies

This endpoint lists all available StackHawk scan policies. Each scan policy provides details of the policy configuration, including the set of plugins and technology flags.

Functionality:

  • Useful for understanding the range of pre-configured scan policies available for HawkScan.
  • The list provided by this endpoint is dynamic, reflecting updates and additions to the scan policies. StackHawk makes regular updates to our policies as new plugins are made available.

Note:

  • This endpoint is not paginated, as the list of policies is finite.

Requires read:policy permission.

Response

200

OK

scanPolicies
scanpolicy.ScanPolicy[]
Hide child attributesShow child attributes
scanPolicies.applicationId
string read-only

The UUID identifier of the scan policy application. If no application ID is present, the scan policy is defined by StackHawk. If the application ID is present, then the scan policy is customized for the given application only.

scanPolicies.description
string

The description for this policy.

scanPolicies.displayName
string

The human readable display name for this policy.

scanPolicies.id
string read-only

The UUID identifier of this scan policy.

scanPolicies.isCustomized
boolean

Indicates whether the plugins have been updated from original scan policy.

scanPolicies.name
string

The referencable unique name of a StackHawk scan policy.

scanPolicies.plugins
scanpolicy.Plugin[]

List of the plugins defined for this policy.

Hide child attributesShow child attributes
scanPolicies.plugins.defaultRisk
enum<string> read-only

Default risk for this plugin. Currently unused.

5 available options
UNKNOWNINFOLOWMEDIUMHIGH
scanPolicies.plugins.enabled
boolean

Enables the plugin. Plugins will only run in a scan when marked as enabled.

scanPolicies.plugins.maxAlerts
integer<int32> read-only

Maximum number of alerts from this plugin reported to the platform. The plugin keeps testing past the limit; only reporting is capped. Unset or 0 means unlimited. Must be non-negative; HawkScan treats a negative value as 0 (unlimited). Managed by StackHawk.

scanPolicies.plugins.name
string

The Plugin name.

scanPolicies.plugins.pluginId
string

The UUID identifier of this plugin.

scanPolicies.plugins.pluginType
enum<string>

The type of plugin to run as. Either ACTIVE or PASSIVE.

2 available options
ACTIVEPASSIVE
scanPolicies.plugins.status
enum<string> read-only

The release quality of this plugin.

3 available options
ADDON_STATUS_ALPHAADDON_STATUS_BETAADDON_STATUS_RELEASE
scanPolicies.plugins.strength
enum<string> write-only

The strength of this plugin. Currently unused.

5 available options
STRENGTH_LOWSTRENGTH_MEDIUMSTRENGTH_HIGHSTRENGTH_INSANESTRENGTH_OFF
scanPolicies.plugins.threshold
enum<string> write-only

The threshold of this plugin. Currently unused.

4 available options
THRESHOLD_LOWTHRESHOLD_MEDIUMTHRESHOLD_HIGHTHRESHOLD_OFF
scanPolicies.techFlags
object read-only

Technology flags for this policy. This is a collection of specific technology identifiers that further configure scan behavior.

scanPolicies
scanpolicy.ScanPolicy[]
Hide child attributesShow child attributes
scanPolicies.applicationId
string read-only

The UUID identifier of the scan policy application. If no application ID is present, the scan policy is defined by StackHawk. If the application ID is present, then the scan policy is customized for the given application only.

scanPolicies.description
string

The description for this policy.

scanPolicies.displayName
string

The human readable display name for this policy.

scanPolicies.id
string read-only

The UUID identifier of this scan policy.

scanPolicies.isCustomized
boolean

Indicates whether the plugins have been updated from original scan policy.

scanPolicies.name
string

The referencable unique name of a StackHawk scan policy.

scanPolicies.plugins
scanpolicy.Plugin[]

List of the plugins defined for this policy.

Hide child attributesShow child attributes
scanPolicies.plugins.defaultRisk
enum<string> read-only

Default risk for this plugin. Currently unused.

5 available options
UNKNOWNINFOLOWMEDIUMHIGH
scanPolicies.plugins.enabled
boolean

Enables the plugin. Plugins will only run in a scan when marked as enabled.

scanPolicies.plugins.maxAlerts
integer<int32> read-only

Maximum number of alerts from this plugin reported to the platform. The plugin keeps testing past the limit; only reporting is capped. Unset or 0 means unlimited. Must be non-negative; HawkScan treats a negative value as 0 (unlimited). Managed by StackHawk.

scanPolicies.plugins.name
string

The Plugin name.

scanPolicies.plugins.pluginId
string

The UUID identifier of this plugin.

scanPolicies.plugins.pluginType
enum<string>

The type of plugin to run as. Either ACTIVE or PASSIVE.

2 available options
ACTIVEPASSIVE
scanPolicies.plugins.status
enum<string> read-only

The release quality of this plugin.

3 available options
ADDON_STATUS_ALPHAADDON_STATUS_BETAADDON_STATUS_RELEASE
scanPolicies.plugins.strength
enum<string> write-only

The strength of this plugin. Currently unused.

5 available options
STRENGTH_LOWSTRENGTH_MEDIUMSTRENGTH_HIGHSTRENGTH_INSANESTRENGTH_OFF
scanPolicies.plugins.threshold
enum<string> write-only

The threshold of this plugin. Currently unused.

4 available options
THRESHOLD_LOWTHRESHOLD_MEDIUMTHRESHOLD_HIGHTHRESHOLD_OFF
scanPolicies.techFlags
object read-only

Technology flags for this policy. This is a collection of specific technology identifiers that further configure scan behavior.

Your privacy settings

We use first and third party cookies to ensure that we give you the best experience on our website and in our products.

Privacy Policy