Scan Policies

Get StackHawk scan policy

Changed on

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.

get/api/v1/policy

Request

  • Base URL
    https://api.stackhawk.com
  • URL
    https://api.stackhawk.com/api/v1/policy
  • Auth
    HTTP bearer

Query parameters

policyNamestring

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

Response

OK

status'OK' | 'NOT_FOUND'

Changes

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/x-protobuf)