STstackhawk
Scan Policies

Toggle app scan policy plugin

Changed on

Toggle Application Scan Policy

This endpoint allows for enabling or disabling a specific plugin within the scan policy of an application, based on the provided application and plugin ID.

Error Handling:

  • 400 Bad Request: This response is returned if the pluginId provided does not correspond to any plugin included in the application's current scan policy.

Additional Information:

Scan Policy plugins represent a security test designed to work with the StackHawk platform. HawkScan will run the plugin in a scan if it's enabled in the application scan policy.

🧾 Audited This is recorded as APPLICATION_POLICY_MODIFIED User Activity.

Requires write:policy permission.

get/api/v1/app/{appId}/policy/plugins/{pluginId}/{toggle}

Request

  • Base URL
    https://api.stackhawk.com
  • URL
    https://api.stackhawk.com/api/v1/app/{appId}/policy/plugins/{pluginId}/{toggle}
  • Auth
    HTTP bearer

Path parameters

appIdstring uuid required

UUID identifier for this StackHawk Application.

pluginIdstring required

Identifier for the Plugin.

toggle'enabled' | 'disabled' required

Toggles this plugin, either as 'enabled' or 'disabled'.

Response

OK

Changes

  • 8e10c864fd67Revision 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)