Validate Scan Configuration

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

Validates a HawkScan Configuration for potential problems.

Requires read:scan_config permission.

Path parameters

orgIdstring · uuidrequired

UUID identifier for this StackHawk Organization.

Body

conf

string

The HawkScan YAML configuration to save for this organization.

configType

enum<string>

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

3 available options

ORGAPPTARGET

name

string

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

application/json

markers

configuration.Marker[]

the list of schema validation markers

Hide child attributesShow child attributes

markers.code

string

problem code line

markers.endColumn

integer<int32>

markers.endLineNumber

integer<int32>

markers.message

string

problem message

markers.owner

string

"StackHawk"

markers.resource

string

name of validated file

markers.severity

enum<string>

severity of the problem

4 available options

HINTINFOWARNINGERROR

markers.source

string

source deriving where the problem definition comes from

markers.startColumn

integer<int32>

markers.startLineNumber

integer<int32>

Bad Request

Unauthorized

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

cURL

curl --request POST \
  --url 'https://api.stackhawk.com/api/v1/configuration/{orgId}/validate' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

Copy

Validate Scan Configuration

Path parameters

Body

Response

Your privacy settings