StackHawk Documentation StackHawk Logo HawkDocs
api
scan policies
get stack hawk scan policy

No results found

Try different keywords or check your spelling

Search documentation

Find guides, API references, and more

↑ ↓ ↵ esc

Get StackHawk scan policy

GET /api/v1/policy

Get StackHawk Scan Policy

This endpoint retrieves a specific StackHawk scan policy. It provides details of the policy configuration, including the set of plugins and technology flags. StackHawk scan policies can be used as-is or as a starting point for customizing your application's scan policy.

Usage:

  • Use the All Scan Policies endpoint to get a list of named StackHawk scan policies.
  • If no policyName is provided in the request, this endpoint will return the DEFAULT scan policy.

Requires read:policy permission.

Query parameters

policyNamestring

A named StackHawk scan policy, or the DEFAULT policy if not provided.

default: "DEFAULT"

Response

200

OK

scanPolicy
scanpolicy.ScanPolicy
Hide child attributesShow child attributes
scanPolicy.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.

scanPolicy.description
string

The description for this policy.

scanPolicy.displayName
string

The human readable display name for this policy.

scanPolicy.id
string read-only

The UUID identifier of this scan policy.

scanPolicy.isCustomized
boolean

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

scanPolicy.name
string

The referencable unique name of a StackHawk scan policy.

scanPolicy.plugins
scanpolicy.Plugin[]

List of the plugins defined for this policy.

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

Default risk for this plugin. Currently unused.

5 available options
UNKNOWNINFOLOWMEDIUMHIGH
scanPolicy.plugins.enabled
boolean

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

scanPolicy.plugins.name
string

The Plugin name.

scanPolicy.plugins.pluginId
string

The UUID identifier of this plugin.

scanPolicy.plugins.pluginType
enum<string>

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

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

The release quality of this plugin.

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

The strength of this plugin. Currently unused.

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

The threshold of this plugin. Currently unused.

4 available options
THRESHOLD_LOWTHRESHOLD_MEDIUMTHRESHOLD_HIGHTHRESHOLD_OFF
scanPolicy.techFlags
object read-only

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

status
enum<string>
2 available options
OKNOT_FOUND
scanPolicy
scanpolicy.ScanPolicy
Hide child attributesShow child attributes
scanPolicy.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.

scanPolicy.description
string

The description for this policy.

scanPolicy.displayName
string

The human readable display name for this policy.

scanPolicy.id
string read-only

The UUID identifier of this scan policy.

scanPolicy.isCustomized
boolean

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

scanPolicy.name
string

The referencable unique name of a StackHawk scan policy.

scanPolicy.plugins
scanpolicy.Plugin[]

List of the plugins defined for this policy.

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

Default risk for this plugin. Currently unused.

5 available options
UNKNOWNINFOLOWMEDIUMHIGH
scanPolicy.plugins.enabled
boolean

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

scanPolicy.plugins.name
string

The Plugin name.

scanPolicy.plugins.pluginId
string

The UUID identifier of this plugin.

scanPolicy.plugins.pluginType
enum<string>

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

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

The release quality of this plugin.

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

The strength of this plugin. Currently unused.

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

The threshold of this plugin. Currently unused.

4 available options
THRESHOLD_LOWTHRESHOLD_MEDIUMTHRESHOLD_HIGHTHRESHOLD_OFF
scanPolicy.techFlags
object read-only

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

status
enum<string>
2 available options
OKNOT_FOUND

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