STstackhawk
Scan Configuration

Validate Scan Configuration

Validates a HawkScan Configuration for potential problems.

Requires read:scan_config permission.

post/api/v1/configuration/{orgId}/validate

Request

  • Base URL
    https://api.stackhawk.com
  • URL
    https://api.stackhawk.com/api/v1/configuration/{orgId}/validate
  • Auth
    HTTP bearer

Path parameters

orgIdstring uuid required

UUID identifier for this StackHawk Organization.

Request body

confstring

The HawkScan YAML configuration to save for this organization.

configType'ORG' | 'APP' | 'TARGET'

Whether the app is tied to a single application or shared by an organization.

namestring

The name of this saved scan configuration. The name should match the conf appId if the configuration is saved for an organization's application.

Response

  • a response of validation problems (markers) for an asset, that work with code editor linters

Changes

No recorded changes to this operation across all 8 revisions of this API.