--- title: "Get application config" method: GET path: "/api/v1/app/{appId}/config/{configHash}" tags: ["Applications"] --- # Get application config `GET /api/v1/app/{appId}/config/{configHash}` Gets this application configuration by its config hash. > Requires `read:scan_config` permission. ## Path parameters - `appId` string, uuid, required - `configHash` string, required ## Response `200` Response of the HawkScan configuration for this application. - ApplicationApplicationConfigResponse — Response of the HawkScan configuration for this application. - `conf` HawkscanHawkscanConf — The HawkScan configuration. The `stackhawk.yml` file follows this structure. A run of HawkScan will use this configuration to inform the scanner how to operate. The minimum stackhawk.yml required is the following: ```yaml app: applicationId: kkAAAKAW-kAWW-kkAA-WWwW-kAAkkAAAAwWW env: Test host: http://localhost:1337 ``` [Signup for a StackHawk account](https://auth.stackhawk.com/signup) and [Get Started](https://docs.stackhawk.com/getting-started). - `app` HawkscanAppConf — Define key settings for the application to be scanned, including properties like the application's host URL, authentication methods, API type, and custom paths. This section includes essential parameters, such as: - `applicationId`: **Required**. The unique identifier for the application in the StackHawk platform. - `env`: **Required**. The environment name used to organize scan results (e.g., "Production" or "Staging"). - `host`: **Required**. The base URL of the application to scan, e.g., `http://localhost:8000`. The scan will not proceed if the URL is unreachable. Additionally, specify other optional details such as session tokens, CSRF parameters, API-specific configurations (e.g., GraphQL, OpenAPI, SOAP, gRPC), and any paths to exclude or include in the scan. - `antiCsrfParam` string — The name of your CSRF security parameter used in any application form inputs. Globally set, HawkScan will parse this parameter value from form responses to use in subsequent requests. - `applicationId` string — **Required**. Your StackHawk application UUID. Create an application in the [StackHawk platform](https://app.stackhawk.com) to obtain this identifier. - `authentication` HawkscanAuthentication — Configuration block for application authentication to enable scanning as the provided user of your application. If provided, HawkScan will first attempt to sign into your web application with the provided login credentials. Only after successfully verifying will scanning occur. For more information, see the Authenticated Scanning section. - `cookieAuthorization` HawkscanCookieAuthorization — An optional configuration specifying if authorization is maintained via a cookie session. - `cookieNames` string[] — A list of strings that are the names of cookies used for maintaining a session. Typically this is one value like `jsessionid` or `PHPSESS`. When used in combination with authentication HawkScan will use this value to persist authenticated session state with your application. - `external` HawkscanExternalCredentials — Optional configuration block for specifying an externally supplied authorization token, HawkScan will attempt to access a protected path in your web application with the supplied token before scanning. For more information, see the [Authenticated Scanning section](https://docs.stackhawk.com/hawkscan/configuration/authenticated-scanning.html). - `type` 'TOKEN' | 'COOKIE' — Specifies the type of token being supplied. If `COOKIE` is specified the .external.value should be in the form of a cookie value = . Defaults to `TOKEN`. - `value` string — **Required**. The value containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`. Use value or values but not both. The value containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`. - `values` HawkscanAuthTokens[] — The value pairs containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`. - `tokenType` string — If specified tokenType will be prepended the header value e.g. tokenType: Bearer -> "Bearer xxxxxxxxx" - `type` 'TOKEN' | 'COOKIE' — Specifies the type of token being supplied, either `TOKEN` or `COOKIE`. Defaults to `TOKEN`. - `value` HawkscanNameValParam — General name / value parameter. - … - `externalCommand` HawkscanExternalCommandCredentials — Optional configuration block allowing HawkScan to run a specified command line process. HawkScan will attempt to access a protected path in your web application with the supplied headers or cookies before scanning. For more information, see the [Authenticated Scanning section](https://docs.stackhawk.com/hawkscan/configuration/authenticated-scanning.html). - `command` string — The command to start the process e.g. `bash`, `python` - `parameters` string[] — Parameters required to run the script e.g. `-c`, `--verbose` - `timeoutSeconds` integer — Maximum time in seconds to wait for the process to complete. Defaults to 60 seconds. - `loggedInIndicator` string — A regex to match against http responses from pages in the web application to determine if the scanned pages user session is still logged in to the app, provided as a string (ex. `".*signed in as.*"`). Required if authorization token is not a JWT. - `loggedOutIndicator` string — A regex to match against http responses from pages in the web application to determine if the scanned pages user session is logged out of the app, provided as a string. Required if authorization token is not a JWT. - `oauth` HawkscanOAuth — Optional configuration block allowing HawkScan to authorize requests with a 3rd party [OAuth 2.0](https://oauth.net/2/) auth provider. - `credentials` HawkscanOAuthCredentials — Credential parameters sent to an OAuth/3rd party provider. - `additionalCreds` object — A list of name/value pairs of any additional fields or credentials that need to be posted to the OAuth provider token endpoint. - `clientId` string — The client id of your application registered with your OAuth provider which will be posted n the request body to the token endpoint with the field name of `client_id`. - `clientSecret` string — The client secret of your application registered with your OAuth provider which will be posted n the request body to the token endpoint with the field name of `client_secret`. - `password` string — Password which will be posted in the request body to the token endpoint with the field name of `password`. - `username` string — Username which will be posted in the request body to the token endpoint with the field name of `username`. - `parameters` HawkscanOAuthParameters — Configuration parameters sent to an OAuth/3rd party provider. - `additionalBodyParams` object — A list of optional additional name/value pairs to be included in the request body of the post. **NOTE:** These values are not redacted, if you need additional sensitive values please use `outhCredentials.additionalCreds` - `additionalQueryParams` object — A list of optional additional name/value pairs to be passed to the query string. - `grantType` string — Grant type of token request, this will be passed to the request body of the token endpoint as `grant_type`. - `requestHeaders` object — Additional headers to be sent along with the request to the token endpoint - `requestMethod` 'POST' | 'PUT' | 'DELETE' | 'GET' | 'OPTIONS' | 'PATCH' | 'HEAD' — Http method for accessing the token endpoint. The default is POST. - `scope` string — Scope type of token request, this will be passed to the request body of the token endpoint as `scope`. - `tokenEndpoint` string — URL of the endpoint to get a token - `overrideJWTAutoRenew` boolean — If set to true HawkScan will not try to autorenew a JWT. - `profiles` HawkscanUserProfile[] — Optional extra creds - `authScript` HawkscanUserProfileProfileScript — Custom authentication script configuration for this user profile requiring custom authentication logic. - `credentials` object — Key-value pairs of sensitive credentials required by the authentication script that will be redacted from logs. - `name` string — **Required**. The name of the authentication script defined in `hawkAddOn.scripts` to use for this profile. - `external` HawkscanUserProfileExternal — External authentication tokens for this user profile using pre-obtained tokens (e.g., JWT tokens, API keys, or session cookies). - `authTokens` HawkscanAuthTokens[] — List of authentication tokens to use for this user profile. Can include multiple tokens or cookies. - … - `globalParameters` object — Use this for parameters for individual users that can't be discovered by smart crawling. - `isPrivileged` boolean — Indicates whether this user profile has elevated privileges (true for admin/privileged users, false for standard users). - `name` string — **Required**. A unique identifier name for this user profile to distinguish between different users during multi-user scans. - `userNamePassword` HawkscanUserProfileUserNamePassword — Username and password credentials for basic authentication similar to the primary authentication configuration. - `password` string — **Required**. The password for this user profile. Use environment variable interpolation (e.g., `${USER2_PASSWORD}`). - `username` string — **Required**. The username for this user profile. Use environment variable interpolation (e.g., `${USER2_USERNAME}`). - `script` HawkscanAuthenticationScript — Configuration for a custom authentication script. HawkScan will run the provided authentication script until a request matches the `loggedInIndicator`, or if the `loggedOutIndicator` is tripped on a request. The authentication script name should also be included in the `hawkAddOn.scripts.name` - `credentials` object — The credentials required for the authentication script. These values will be redacted. - `name` string — The name of the authentication script, as specified in the `hawkAddOn.scripts.name`. - `parameters` object — The parameters required for the authentication script. - `sessionScript` HawkscanSessionScript — Optional configuration block for specifying a custom session management script. To learn more about session scripts, reference the [HawkScan Examples](https://github.com/kaakaww/hawkscan-examples){:target="_blank"} repository. - `name` string — *Required* The name of the session script defined in `hawkAddons.scripts`. The script `type` must be `session`, and match the `hawkAddOn.scripts.name` field. - `parameters` object — A map of key/value pairs that will be passed to your session script, which can be accessed via `sessionWrapper.getParam()` function. - `testPath` HawkscanAuthTestPath — A configuration specifying how to verify if Scan authentication and authorization is working before running a scan. An example configuration of `app.authentication.testPath`: ```yaml app: authentication: testPath: type: HEADER path: /user/profile success: ".*200.*" requestMethod: POST requestBody: '{"feeling": "KaaKaww!"}' requestHeaders: Content-Type: "application/json" ``` This uses either `success` or `fail` criteria to determine if authorized access is working correctly. - `fail` string — A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`. A match of the regex supplied will indicate that scanning should halt and enter an error state. HawkScan requires that either `success` OR `fail` be configured (do not configure both). - `grpcTestMethod` string — The gRPC method path to call for authentication validation (e.g., "/auth.AuthService/ValidateToken"). Only used when authentication type is GRPC. - `path` string — **Required**. The path to a protected route in your application that requires authorization. For example `/mysettings`. A `GET` request will be made to this path using the configured authentication. - `requestBody` string — The request content to send along with POST or PUT requests for authentication verification. - `requestHeaders` object — List of key/value pairs to be included as headers in the request to the `path`. Headers that match the following pattern are unable to be added or modified `'^(Host|Origin|Proxy-.*|Sec-.*|Content-Length)'`. - `requestMethod` 'GET' | 'POST' | 'PUT' | 'PATCH' — Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings. - `success` string — A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`. A match of the regex supplied will indicate that scanning should proceed with the specified authentication. HawkScan requires that either `success` OR `fail` be configured (do not configure both). - `type` 'HEADER' | 'BODY' — An enum value representing what to match against in the response from issuing a request to the `testPath.path`. The supported values are `HEADER` and `BODY`. - `tokenAuthorization` HawkscanTokenAuthorization — An optional configuration telling HawkScan how to pass the authorization token to your application on each request to maintain authorized access. - `isJWT` boolean — If the token is a JWT, mark this field as true - `renewMillis` integer — If isJWT is set to true, this field will determine the time in milliseconds before expiration to auto renew the JWT. - `tokenType` string — TokenType will be prepended the header value e.g. tokenType: TOKEN -> "TOKEN xxxxxxxxx" - `type` 'HEADER' | 'QUERY_PARAM' — An enum value representing how to pass the authorization token to your application. `HEADER` indicates that each request should have the authorization token header added to the requests. `QUERY_PARAM` indicates that the token should be passed as a query parameter. - `value` string — **Required**. The name of the `HEADER` or `QUERY_PARAM` the token should be passed as. - `tokenExtraction` HawkscanTokenExtraction — Token extraction is optional unless you're using the `tokenAuthorization` in combination with `usernamePassword` authentication. This configuration specifies how to extract the authorization token from the authentication response. - `type` 'TOKEN_PATH' | 'HEADER_NAME' — Specifying `TOKEN_PATH` tells HawkScan to extract the token from the JSON payload of the response from authentication. `HEADER` tells HawkScan to extract the token from a header in the response from authentication. defaults to `TOKEN_PATH`. - `value` string — *Required**. String containing the path to the token in the JSON payload authentication response or the name of the response header containing the token. Example: if the authentication response JSON payload looks like `{"auth" : {"token": ""}}` the value would be `auth.token`. If the authentication response has a header named `AuthToken: `, then the value should be `AuthToken`. - `usernamePassword` HawkscanUsernamePasswordCredentials — Optional configuration specifying a username and password based authentication configuration. Currently POSTing the credentials via `FORM` or `JSON` type is supported. Use in conjunction `cookieAuthorization` or `tokenAuthorization` to maintain authorized access to your application. - `grpcMethod` string — The gRPC method path for authentication (e.g., "/auth.AuthService/Login"). Required when type is GRPC. Uses grpcConf for descriptor. - `jsonrpcMethod` string — The JSON-RPC method name to call for authentication (e.g., "auth.login"). Required when type is JSON_RPC. - `loginPagePath` string — The path to your login form, if applicable. This is an optional path but is often required if the `POST` to the loginPath requires an anti csrf token to be passed as part of the `POST`. The `app.antiCsrfParam` will be extracted from the response body of a GET request to this page. - `loginPath` string — **Required**. login route to `POST` credentials for a user in the application (ex. `/login`). An http `POST` request using the type specified will be made to this path. - `otherParams` HawkscanNameValParam[] — Other request parameters required by your login payload, provided as an array of objects with `name` and `value` string keys. This setting is helpful if your authentication process requires other parameters included in the form POST besides the username and password parameters. If in doubt, this setting can be safely left unconfigured. - `name` string — Param name. - `val` string — Param value. - `passwordField` string — **Required**. The password html field used in your application form or json, provided as a string. - `realm` string — Realm for NTLM authentication - `scanPassword` string — *Required**. The password credentials provided to authentication when attempting to login to the web application, provided as a string. HawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. "${SCAN_PASSWORD}" will use the $SCAN_PASSWORD environment variable as the scanPassword). - `scanUsername` string — *Required**. The username credentials provided to authentication when attempting to login to the web application, provided as a string. HawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. "${SCAN_USERNAME:admin}" will use the $SCAN_USERNAME environment variable as the scanUsername, or fallback to admin). - `type` 'FORM' | 'JSON' | 'HTTP' | 'JSON_RPC' | 'GRPC' — An enum value describing the type of `POST` data expected by the `loginPath` - `usernameField` string — **Required**. the username html field used in your application form or json, provided as a string. - `autoInputVectors` boolean — Set to `true` to automatically enabled the correct input data types when scanning APIs like GraphQL and OpenAPI. This can increase scan accuracy and reduce false positives. Defaults to True. - `autoPolicy` boolean — Set to `true` to enable an optimized policy when scanning specific APIs like GraphQL and OpenAPI. Defaults to True. - `badAuthentication` HawkscanAuthentication — Configuration block for application authentication to enable scanning as the provided user of your application. If provided, HawkScan will first attempt to sign into your web application with the provided login credentials. Only after successfully verifying will scanning occur. For more information, see the Authenticated Scanning section. - `cookieAuthorization` HawkscanCookieAuthorization — An optional configuration specifying if authorization is maintained via a cookie session. - `cookieNames` string[] — A list of strings that are the names of cookies used for maintaining a session. Typically this is one value like `jsessionid` or `PHPSESS`. When used in combination with authentication HawkScan will use this value to persist authenticated session state with your application. - `external` HawkscanExternalCredentials — Optional configuration block for specifying an externally supplied authorization token, HawkScan will attempt to access a protected path in your web application with the supplied token before scanning. For more information, see the [Authenticated Scanning section](https://docs.stackhawk.com/hawkscan/configuration/authenticated-scanning.html). - `type` 'TOKEN' | 'COOKIE' — Specifies the type of token being supplied. If `COOKIE` is specified the .external.value should be in the form of a cookie value = . Defaults to `TOKEN`. - `value` string — **Required**. The value containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`. Use value or values but not both. The value containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`. - `values` HawkscanAuthTokens[] — The value pairs containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`. - `tokenType` string — If specified tokenType will be prepended the header value e.g. tokenType: Bearer -> "Bearer xxxxxxxxx" - `type` 'TOKEN' | 'COOKIE' — Specifies the type of token being supplied, either `TOKEN` or `COOKIE`. Defaults to `TOKEN`. - `value` HawkscanNameValParam — General name / value parameter. - … - `externalCommand` HawkscanExternalCommandCredentials — Optional configuration block allowing HawkScan to run a specified command line process. HawkScan will attempt to access a protected path in your web application with the supplied headers or cookies before scanning. For more information, see the [Authenticated Scanning section](https://docs.stackhawk.com/hawkscan/configuration/authenticated-scanning.html). - `command` string — The command to start the process e.g. `bash`, `python` - `parameters` string[] — Parameters required to run the script e.g. `-c`, `--verbose` - `timeoutSeconds` integer — Maximum time in seconds to wait for the process to complete. Defaults to 60 seconds. - `loggedInIndicator` string — A regex to match against http responses from pages in the web application to determine if the scanned pages user session is still logged in to the app, provided as a string (ex. `".*signed in as.*"`). Required if authorization token is not a JWT. - `loggedOutIndicator` string — A regex to match against http responses from pages in the web application to determine if the scanned pages user session is logged out of the app, provided as a string. Required if authorization token is not a JWT. - `oauth` HawkscanOAuth — Optional configuration block allowing HawkScan to authorize requests with a 3rd party [OAuth 2.0](https://oauth.net/2/) auth provider. - `credentials` HawkscanOAuthCredentials — Credential parameters sent to an OAuth/3rd party provider. - `additionalCreds` object — A list of name/value pairs of any additional fields or credentials that need to be posted to the OAuth provider token endpoint. - `clientId` string — The client id of your application registered with your OAuth provider which will be posted n the request body to the token endpoint with the field name of `client_id`. - `clientSecret` string — The client secret of your application registered with your OAuth provider which will be posted n the request body to the token endpoint with the field name of `client_secret`. - `password` string — Password which will be posted in the request body to the token endpoint with the field name of `password`. - `username` string — Username which will be posted in the request body to the token endpoint with the field name of `username`. - `parameters` HawkscanOAuthParameters — Configuration parameters sent to an OAuth/3rd party provider. - `additionalBodyParams` object — A list of optional additional name/value pairs to be included in the request body of the post. **NOTE:** These values are not redacted, if you need additional sensitive values please use `outhCredentials.additionalCreds` - `additionalQueryParams` object — A list of optional additional name/value pairs to be passed to the query string. - `grantType` string — Grant type of token request, this will be passed to the request body of the token endpoint as `grant_type`. - `requestHeaders` object — Additional headers to be sent along with the request to the token endpoint - `requestMethod` 'POST' | 'PUT' | 'DELETE' | 'GET' | 'OPTIONS' | 'PATCH' | 'HEAD' — Http method for accessing the token endpoint. The default is POST. - `scope` string — Scope type of token request, this will be passed to the request body of the token endpoint as `scope`. - `tokenEndpoint` string — URL of the endpoint to get a token - `overrideJWTAutoRenew` boolean — If set to true HawkScan will not try to autorenew a JWT. - `profiles` HawkscanUserProfile[] — Optional extra creds - `authScript` HawkscanUserProfileProfileScript — Custom authentication script configuration for this user profile requiring custom authentication logic. - `credentials` object — Key-value pairs of sensitive credentials required by the authentication script that will be redacted from logs. - `name` string — **Required**. The name of the authentication script defined in `hawkAddOn.scripts` to use for this profile. - `external` HawkscanUserProfileExternal — External authentication tokens for this user profile using pre-obtained tokens (e.g., JWT tokens, API keys, or session cookies). - `authTokens` HawkscanAuthTokens[] — List of authentication tokens to use for this user profile. Can include multiple tokens or cookies. - … - `globalParameters` object — Use this for parameters for individual users that can't be discovered by smart crawling. - `isPrivileged` boolean — Indicates whether this user profile has elevated privileges (true for admin/privileged users, false for standard users). - `name` string — **Required**. A unique identifier name for this user profile to distinguish between different users during multi-user scans. - `userNamePassword` HawkscanUserProfileUserNamePassword — Username and password credentials for basic authentication similar to the primary authentication configuration. - `password` string — **Required**. The password for this user profile. Use environment variable interpolation (e.g., `${USER2_PASSWORD}`). - `username` string — **Required**. The username for this user profile. Use environment variable interpolation (e.g., `${USER2_USERNAME}`). - `script` HawkscanAuthenticationScript — Configuration for a custom authentication script. HawkScan will run the provided authentication script until a request matches the `loggedInIndicator`, or if the `loggedOutIndicator` is tripped on a request. The authentication script name should also be included in the `hawkAddOn.scripts.name` - `credentials` object — The credentials required for the authentication script. These values will be redacted. - `name` string — The name of the authentication script, as specified in the `hawkAddOn.scripts.name`. - `parameters` object — The parameters required for the authentication script. - `sessionScript` HawkscanSessionScript — Optional configuration block for specifying a custom session management script. To learn more about session scripts, reference the [HawkScan Examples](https://github.com/kaakaww/hawkscan-examples){:target="_blank"} repository. - `name` string — *Required* The name of the session script defined in `hawkAddons.scripts`. The script `type` must be `session`, and match the `hawkAddOn.scripts.name` field. - `parameters` object — A map of key/value pairs that will be passed to your session script, which can be accessed via `sessionWrapper.getParam()` function. - `testPath` HawkscanAuthTestPath — A configuration specifying how to verify if Scan authentication and authorization is working before running a scan. An example configuration of `app.authentication.testPath`: ```yaml app: authentication: testPath: type: HEADER path: /user/profile success: ".*200.*" requestMethod: POST requestBody: '{"feeling": "KaaKaww!"}' requestHeaders: Content-Type: "application/json" ``` This uses either `success` or `fail` criteria to determine if authorized access is working correctly. - `fail` string — A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`. A match of the regex supplied will indicate that scanning should halt and enter an error state. HawkScan requires that either `success` OR `fail` be configured (do not configure both). - `grpcTestMethod` string — The gRPC method path to call for authentication validation (e.g., "/auth.AuthService/ValidateToken"). Only used when authentication type is GRPC. - `path` string — **Required**. The path to a protected route in your application that requires authorization. For example `/mysettings`. A `GET` request will be made to this path using the configured authentication. - `requestBody` string — The request content to send along with POST or PUT requests for authentication verification. - `requestHeaders` object — List of key/value pairs to be included as headers in the request to the `path`. Headers that match the following pattern are unable to be added or modified `'^(Host|Origin|Proxy-.*|Sec-.*|Content-Length)'`. - `requestMethod` 'GET' | 'POST' | 'PUT' | 'PATCH' — Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings. - `success` string — A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`. A match of the regex supplied will indicate that scanning should proceed with the specified authentication. HawkScan requires that either `success` OR `fail` be configured (do not configure both). - `type` 'HEADER' | 'BODY' — An enum value representing what to match against in the response from issuing a request to the `testPath.path`. The supported values are `HEADER` and `BODY`. - `tokenAuthorization` HawkscanTokenAuthorization — An optional configuration telling HawkScan how to pass the authorization token to your application on each request to maintain authorized access. - `isJWT` boolean — If the token is a JWT, mark this field as true - `renewMillis` integer — If isJWT is set to true, this field will determine the time in milliseconds before expiration to auto renew the JWT. - `tokenType` string — TokenType will be prepended the header value e.g. tokenType: TOKEN -> "TOKEN xxxxxxxxx" - `type` 'HEADER' | 'QUERY_PARAM' — An enum value representing how to pass the authorization token to your application. `HEADER` indicates that each request should have the authorization token header added to the requests. `QUERY_PARAM` indicates that the token should be passed as a query parameter. - `value` string — **Required**. The name of the `HEADER` or `QUERY_PARAM` the token should be passed as. - `tokenExtraction` HawkscanTokenExtraction — Token extraction is optional unless you're using the `tokenAuthorization` in combination with `usernamePassword` authentication. This configuration specifies how to extract the authorization token from the authentication response. - `type` 'TOKEN_PATH' | 'HEADER_NAME' — Specifying `TOKEN_PATH` tells HawkScan to extract the token from the JSON payload of the response from authentication. `HEADER` tells HawkScan to extract the token from a header in the response from authentication. defaults to `TOKEN_PATH`. - `value` string — *Required**. String containing the path to the token in the JSON payload authentication response or the name of the response header containing the token. Example: if the authentication response JSON payload looks like `{"auth" : {"token": ""}}` the value would be `auth.token`. If the authentication response has a header named `AuthToken: `, then the value should be `AuthToken`. - `usernamePassword` HawkscanUsernamePasswordCredentials — Optional configuration specifying a username and password based authentication configuration. Currently POSTing the credentials via `FORM` or `JSON` type is supported. Use in conjunction `cookieAuthorization` or `tokenAuthorization` to maintain authorized access to your application. - `grpcMethod` string — The gRPC method path for authentication (e.g., "/auth.AuthService/Login"). Required when type is GRPC. Uses grpcConf for descriptor. - `jsonrpcMethod` string — The JSON-RPC method name to call for authentication (e.g., "auth.login"). Required when type is JSON_RPC. - `loginPagePath` string — The path to your login form, if applicable. This is an optional path but is often required if the `POST` to the loginPath requires an anti csrf token to be passed as part of the `POST`. The `app.antiCsrfParam` will be extracted from the response body of a GET request to this page. - `loginPath` string — **Required**. login route to `POST` credentials for a user in the application (ex. `/login`). An http `POST` request using the type specified will be made to this path. - `otherParams` HawkscanNameValParam[] — Other request parameters required by your login payload, provided as an array of objects with `name` and `value` string keys. This setting is helpful if your authentication process requires other parameters included in the form POST besides the username and password parameters. If in doubt, this setting can be safely left unconfigured. - `name` string — Param name. - `val` string — Param value. - `passwordField` string — **Required**. The password html field used in your application form or json, provided as a string. - `realm` string — Realm for NTLM authentication - `scanPassword` string — *Required**. The password credentials provided to authentication when attempting to login to the web application, provided as a string. HawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. "${SCAN_PASSWORD}" will use the $SCAN_PASSWORD environment variable as the scanPassword). - `scanUsername` string — *Required**. The username credentials provided to authentication when attempting to login to the web application, provided as a string. HawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. "${SCAN_USERNAME:admin}" will use the $SCAN_USERNAME environment variable as the scanUsername, or fallback to admin). - `type` 'FORM' | 'JSON' | 'HTTP' | 'JSON_RPC' | 'GRPC' — An enum value describing the type of `POST` data expected by the `loginPath` - `usernameField` string — **Required**. the username html field used in your application form or json, provided as a string. - `env` string — **Required**. The `env` environment name to organize Scan Results. - `excludePaths` string[] — An array of strings, used as regexes to match against routes that should be ignored entirely by HawkScan. If populated, paths that match any supplied regex will be excluded from the scan. This field is useful for prohibiting asset directories or other resources that don't require vulnerability scanning. - `graphqlConf` HawkscanGraphQLConf — Configure how HawkScan interacts with [GraphQL](https://spec.graphql.org/June2018/) APIs. One of the following is **Required**: - `schemaPath`: Relative path to the introspection endpoint (based on the host address). - `filePath`: Relative path to a GraphQL schema file (SDL format). The following are **Optional**: - `operation`: Adjust the operation requests generated by the spider (`QUERY` or `MUTATION`, defaults to both). - `excludeOperations`: Exclude particular GraphQL operations from being scanned. For full details, see [GraphQL Configuration Documentation](https://docs.stackhawk.com/hawkscan/configuration/graphql-configuration.html). - `customVariables` HawkscanGraphQLCustomVariable[] — Define custom variables and values for use in GraphQL scanning. - `field` string — The field name of the param to inject values into. - `operationName` string — An optional operationName that will only inject custom values if the name of the operation on the request matches. - `operationType` 'ALL' | 'QUERY' | 'MUTATION' — An optional GraphQL operation type (MUTATION or QUERY) that will inject custom values only when the request matches the operation type. - `values` string[] — A list of possible values to be randomly selected for the given field. - `deprecatedCustomVariables` HawkscanCustomVariable[] — Define custom variables and values for use in GraphQL scanning. - `field` string — The field name of the param to inject values into. Using object notation will resolve nested objects for request bodies e.g. myobject.id - `path` string — Optional path for the endpoint or gRPC service to hit e.g. /myservice/myfunction - `values` string[] — A list of possible values to be randomly selected for the given field. - `enabled` boolean — Enable GraphQL scan support. HawkScan will enumerate all possible field types and input values for GraphQL Queries and Mutations. Provide relative path to the API endpoint. - `excludeOperations` HawkscanGraphQLExcludeOperationParam[] — GraphQL operations to exclude from the spider. - `name` string — GraphQL operation name. - `type` 'ALL' | 'QUERY' | 'MUTATION' — Graphql operation type. Options are `All`, `QUERY` and `MUTATION`. - `fakerEnabled` boolean — Enables faker for a GraphQL scan to generate more realistic values when format is provided on the API spec or custom variables. - `filePath` string — Path to a local GraphQL schema file (SDL format) to use instead of introspection. - `maxDepth` integer — Maximum depth for generated query graphs. - `operation` 'ALL' | 'QUERY' | 'MUTATION' — GraphQL operation to enumerate and scan. Defaults to find all Query and Mutation operations. Options are `All`, `QUERY` and `MUTATION`. - `requestMethod` 'POST' | 'GET' — Request method to use for queries. Will generate GraphQL queries as either `POST` payloads or `GET` uri strings. - `schemaPath` string — Path to the GraphQL introspection endpoint, relative to the target URI. - `uriMaxLength` integer — Max length of URIs when generation queries for GET requests. - `grpcConf` HawkscanGrpcConf — Configure HawkScan for [gRPC](https://grpc.io/) API scanning. One of the following is **Required**: - `path`: Reflection endpoint for reading gRPC schema. - `filePath`: Relative path to a [protobuf descriptor_set](https://protobuf.com/docs/descriptors) file. - `filePaths`: List of relative paths to a [protobuf descriptor_set](https://protobuf.com/docs/descriptors) file. For full details such as custom variable injection, see [gRPC Configuration Documentation](https://docs.stackhawk.com/hawkscan/configuration/gRPC-configuration.html). - `customVariables` HawkscanCustomVariable[] — Define custom variables and values for use in gRPC scanning. - `field` string — The field name of the param to inject values into. Using object notation will resolve nested objects for request bodies e.g. myobject.id - `path` string — Optional path for the endpoint or gRPC service to hit e.g. /myservice/myfunction - `values` string[] — A list of possible values to be randomly selected for the given field. - `filePath` string — Path to a local gRPC [protobuf descriptor_set](https://protobuf.com/docs/descriptors) file. - `filePaths` string[] — A list of paths to the grpc [protobuf descriptor_set](https://protobuf.com/docs/descriptors) file. - `maxDepth` integer — Maximum depth for resolving nested protobuf. - `path` string — Host path for the grpc reflection endpoint. Set to a non-empty value to use gRPC server reflection. - `host` string — **Required**. The base url of the application to scan ex: `http://localhost:8000`. If the url cannot be reached, the scan will not proceed. - `includePaths` string[] — An array of strings, used as regexes to limit which application routes HawkScan will specifically visit. If populated, paths must match at least one supplied regex to be included as part of the scan. This field is useful for constraining the reach of the HawkScan scanner and spider. - `inputVectors` HawkscanAppConfInputVectorParams — Fine-grained configuration of HawkScan input vectors. This configuration is how and where testable inputs are applied on http requests. - `enabledRpcParam` ScanpolicyEnabledRPCParam — Advanced Configuration* The specific input shapes for http request bodies made by HawkScan. Enabling additional RPC params will increase scan time. Do not set these values unless instructed to by StackHawk Support. - `directWebRemoting` boolean — Support for direct web remoting request bodies. Deprecated. - `googleWebToolkit` boolean — Support for GWT request bodies. Deprecated. - `json` boolean — Support for json request bodies. - `multipartFormData` boolean — Support for `multipart/form-data` request bodies. - `odataId` boolean — Support for Odata request bodies. Deprecated. - `xmlTag` boolean — Support for xml request bodies. - `injectableParam` ScanpolicyInjectableParam — Advanced Configuration* The specific parts of an http request that can be modified by HawkScan. Different http protocols like `REST (OpenAPI)` `graphQL` `gRPC` and `SOAP` use different parts of http requests to function. This setting is configured dynamically depending on the scan protocol used, and should only be modified for advanced scan configuration. Enabling additional injectable params will increase scan time. Do not set these values unless instructed to by StackHawk Support. - `cookieData` boolean — Allow injection of testable inputs for cookie data. - `httpHeaders` boolean — Allow injection of testable inputs for http headers. - `postData` boolean — Allow injection of testable inputs request body inputs on POST requests. - `urlPath` boolean — Allow injection of testable inputs url paths. - `urlQuery` boolean — Allow injections of testable inputs url query parameter names. - `urlQueryParam` boolean — Allow injection of testable inputs url query parameter values. - `jsonRpcConf` HawkscanJsonRpcConf — Configure HawkScan for [JSON-RPC 2.0](https://www.jsonrpc.org/specification) API scanning. One of the following is **Required**: - `endpoint`: The JSON-RPC endpoint path (e.g., `/jsonrpc` or `/api/rpc`). - `path`: Host path to a hosted OpenRPC specification (e.g., `/openrpc.json`). - `filePath`: Relative path to a local OpenRPC schema file (JSON format). For full details such as custom variable injection, see [JSON-RPC Configuration Documentation](https://docs.stackhawk.com/hawkscan/configuration/json-rpc-configuration.html). - `customVariables` HawkscanJsonRpcCustomVariable[] — Define custom variables and values for use in JSON-RPC scanning. - `field` string — The field name of the param to inject values into. Using dot notation will resolve nested objects for request bodies (e.g., `user.address.id`). - `path` string — An optional regex pattern that will only inject custom values if the JSON-RPC method name matches. - `values` string[] — A list of possible values to be randomly selected for the given field. - `enabled` boolean — Enable JSON-RPC scan support. - `endpoint` string — The JSON-RPC endpoint path relative to the target host (e.g., `/jsonrpc`). Defaults to `/`. - `excludeMethods` string[] — Regex patterns for JSON-RPC method names to exclude from scanning. - `fakerEnabled` boolean — Enables faker for JSON-RPC scanning to generate more realistic values when format is provided on the schema or custom variables. - `filePath` string — Path to a local OpenRPC schema file (JSON format) to use instead of network discovery. - `maxDepth` integer — Maximum depth for generated nested objects. Defaults to 3. - `mcp` HawkscanMcpConf — MCP (Model Context Protocol) server configuration for JSON-RPC scanning. - `customValues` HawkscanMcpCustomVariable[] — Define custom variables and values for use in MCP tool scanning. - `param` string — Parameter name within the tool's inputSchema. Using dot notation resolves nested objects (e.g., `user.address.id`). - `tool` string — MCP tool name this variable applies to. - `values` string[] — A list of possible values to be randomly selected for the given parameter. - `endpoint` string — MCP server endpoint path relative to target host. Defaults to `/mcp`. - `excludeTools` string[] — MCP tool names to exclude from scanning. - `path` string — Host path to a hosted OpenRPC specification, relative to the target host (e.g., `/openrpc.json`). - `requestTimeout` integer — HTTP request timeout in milliseconds. Defaults to 30000 (30 seconds). - `openApiConf` HawkscanOpenApiConf — Define how HawkScan scans [OpenAPI](https://swagger.io/specification/) endpoints. One of the following is **Required**: - `filePath`: Path to a local OpenAPI specification file (JSON or YAML). - `path`: URL path to fetch the OpenAPI spec from the scanned host. For full details such as custom variable injection, see [OpenAPI Configuration Documentation](https://docs.stackhawk.com/hawkscan/configuration/openapi-configuration.html). - `customVariables` HawkscanOpenApiCustomVariable[] — Define custom variables and values for use in REST API scanning. - `field` string — The field name of the param to inject values into. - `path` string — An optional path regex that will only inject custom values if the path of the request matches. - `requestMethods` string[] — A list of optional HTTP request methods that will inject custom values only when the request matches one of those methods. - `values` string[] — A list of possible values to be randomly selected for the given field. - `deprecatedCustomVariables` HawkscanCustomVariable[] — Define custom variables and values for use in REST API scanning. - `field` string — The field name of the param to inject values into. Using object notation will resolve nested objects for request bodies e.g. myobject.id - `path` string — Optional path for the endpoint or gRPC service to hit e.g. /myservice/myfunction - `values` string[] — A list of possible values to be randomly selected for the given field. - `fakerEnabled` boolean — Enables faker for a REST API scan to generate more realistic values when format is provided on the API spec or custom variables. - `filePath` string — Path to a local OpenAPI specification file (JSON or YAML format). - `filePaths` string[] — A list of relative path to specification file(s) (JSON or YAML) for the open api generation for specs with multiple open api files. - `forbiddenVariables` HawkscanOpenApiCustomVariable[] — Custom variables that the user should not see for tenancy checks. - `field` string — The field name of the param to inject values into. - `path` string — An optional path regex that will only inject custom values if the path of the request matches. - `requestMethods` string[] — A list of optional HTTP request methods that will inject custom values only when the request matches one of those methods. - `values` string[] — A list of possible values to be randomly selected for the given field. - `globalParameters` object — Use this for parameters for all users that can't be discovered by smart crawling. - `includeAllMethods` boolean — When custom variables are provided, DELETE's are skipped for injection. Set this to true to override this default and include all methods in variable injection. - `includedMethods` string[] — List of methods to include in custom variable injection. Note: if 'includeAllMethods' is set to true, this list is ignored and all methods will be used for custom variable injection. - `inline` string — Define your openapi specification yaml inlined as a string. - `maxAliasesForCollections` integer — Maximum number of aliases for a collection when parsing YAML. Increase this value if you see the "Number of aliases for non-scalar nodes exceeds the specified max=100" error. - `path` string — A string relative path to an OpenAPI specification file (JSON or YAML) from the scanned host. - `strict` boolean — Whether to enable strict parsing of the OpenAPI. - `usePlatform` boolean — Use the OpenApi Specifications mapped to this application from the StackHawk Platform for this scan. - `redact` HawkscanAppRedactions — Redaction policy of scan logs and stdout when scanning this application. HawkScan maintains a list of redacted tokens; strings that are sensitive and should be scrubbed preemptively from logs and collected messages. By default, HawkScan redacts `app.authentication` credentials, and any provided script / discovery credentials. - `headers` string[] — List of string header names: the values of HTTP headers matching these names will be redacted from alerts and logs. - `values` string[] — List of string static values: the values here will be added to the redacted token list. This is best used with ${ENV_VAR:default} interpolation. - `scanPolicy` HawkscanOrganizationPolicy — Configure the policy to be applied for the scan, optionally specifying which plugins to include or exclude. **Note**: Applies to scan policies created with Organization Policy Management. - `excludePluginIds` string[] — Plugin ids to exclude from the named scan policy. - `includePluginIds` string[] — Plugin ids to include in the scan that are not in the named scan policy. - `name` string — **Required**. The unique name of the organization scan policy. - `sessionTokens` string[] — The names of any session tokens used by your application, provided as an array of strings (Hint: these are the names of session cookies used by your application). - `soapConf` HawkscanSoapConf — Set parameters for scanning [SOAP](https://www.w3.org/TR/soap/) APIs. One of the following is **Required**: - `path`: Relative URL to fetch the SOAP API WSDL from the scanned host. - `filePath`: Path to a local SOAP API WSDL specification file. For full details, see [SOAP Configuration Documentation](https://docs.stackhawk.com/hawkscan/configuration/soap-configuration.html). - `filePath` string — Relative path to the SOAP WSDL schema definition file. - `path` string — Host path to the SOAP WSDL, prefixed with a `/` . - `waitForAppTarget` HawkscanWaitForAppTarget — Configuration specifying how to determine if the web application is up, responsive and ready for scanning. - `path` string — The path to a public reachable route in your application. For example `/index`. A `GET` request will be made to this path to confirm the host is up and ready to receive traffic. - `pollDelay` integer — The maximum amount of time in milliseconds in between requests to your application to see if it's running - `requestBody` string — The request content to send along with POST or PUT requests for target verification. - `requestHeaders` object — Key-value map of additional headers to be sent along with the request to the app target host. - `requestMethod` 'GET' | 'POST' | 'PUT' | 'PATCH' — Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings. - `waitTimeoutMillis` integer — The maximum amount of time in milliseconds that HawkScan will wait for your app to be available before it starts scanning - `hawk` HawkscanHawkConf — Define global HawkScan settings, independent of the scanned application: - `spider`: Configure application crawling and scan discovery. Enable `base` and `ajax` crawlers, set `maxDurationMinutes`, add `seedPaths`, use `custom` commands, or import `har` files. - `startupTimeoutMinutes`: Maximum time to wait for the scanner to start (default: 5). - `failureThreshold`: Alert severity level to fail a scan (`high`, `medium`, or `low`). - `scan`: Set runtime behavior like max duration, request throttling, and concurrency. - `config`: Advanced scanner configuration overrides. - `outboundProxy`: Configure an outbound proxy, including host, credentials, and CA certificate. For more details, see [HawkScan Configuration Documentation](https://docs.stackhawk.com/hawkscan/configuration/). - `config` string[] — Scanner configuration overrides, provided as a list of key=value strings. A list of strings in the form of key=value pairs passed to the scanner as scanner configuration overrides. This is an advanced feature to configure HawkScan plugins and override their default behavior. - `failureThreshold` string — The lowest alert level that returns a failed scan status. Accepted values: high, medium, or low. - `outboundProxy` HawkscanProxy — Configuration block for a proxy. This enables HawkScan to traffic scanner requests through an outbound network proxy. - `credentials` HawkscanProxyCredentials — Credential details for the outbound proxy behavior. - `password` string — **Required**. The password for proxy credentials. - `realm` string — Realm for proxy credentials. - `scheme` string — Scheme of proxy authentication. Currently `BASIC`, `NTLM` are supported. - `username` string — **Required**. The username for proxy credentials. - `host` string — The host of the outbound explicit proxy, including port (e.g. https://localhost:8888). - `rootCACertPath` string — Path to root CA Certificate for transparent outbound proxies. This can be used without specifying host or credentials. - `scan` HawkscanHawkConfScanConf — Configuration block for HawkScan runtime. - `concurrentRequests` integer — Number of request threads. _If you need that little extra push._ defaults to 20. - `crashDetection` HawkscanHawkConfScanConfCrashDetection — Configuration for detecting and reacting to a target application that crashes or stops responding mid-scan. - `action` 'ABORT' | 'WARN' | 'DISABLED' — Action to take once a liveness probe confirms the target is down. - `maxTimeouts` integer — Number of new timeouts + connection failures (since the last check) that triggers a liveness probe. Defaults to 5x the configured concurrentRequests (i.e. ~5 "waves" of in-flight failures) when unset/zero. - `includedPlugins` string[] — Specify to only scan with these listed plugins. - `maxDurationMinutes` integer — Maximum duration that a scan will run. - `maxRuleDurationMinutes` integer — Maximum duration that a scan will spend on a rule. - `policyName` string — Name of a specific named scan policy to use. This field is optional, and an applicable scan policy will be selected if omitted. - `requestDelayMillis` integer — Delay time between sending requests. - `throttleIntervalSeconds` integer — How often the throttle check is run, in seconds. - `throttlePassiveBacklog` integer — Pause active scan when passive backlog is greater than this value, resumes once backlog is empty. defaults to 50. - `throttleTempRecordDeleteQuota` integer — The percentage of throttleTempRecordMax records to delete on each throttleIntervalSeconds. - `throttleTempRecordMax` integer — The max number of temp records allowed before pruning of temp records begins. - `spider` HawkscanHawkConfSpider — Configuration block for the application crawling and Discovery Phase aka Spider. See the [Scan Discovery](https://docs.stackhawk.com/hawkscan/scan-discovery/) page for more details. - `ajax` boolean — Enable the ajax web crawler for discovering your application’s routes. This spider is appropriate for single-page web applications. - `ajaxBrowser` 'FIREFOX_HEADLESS' | 'CHROME_HEADLESS' | 'FIREFOX' | 'CHROME' — The browser type and style to use when running the AjaxSpider. When running the `stackhawk/hawkscan` docker container, this setting is ignored and will use the default CHROME_HEADLESS. The options are CHROME_HEADLESS and CHROME. FIREFOX_HEADLESS and FIREFOX are deprecated. - `base` boolean — Enable the basic web crawler for discovering your application's routes. This spider is appropriate for most traditional web applications. - `custom` HawkscanHawkConfSpiderCustomDiscovery — Configuration for custom scan discovery. See the [Custom Scan Discovery](https://docs.stackhawk.com/hawkscan/scan-discovery/custom.html) section for more details. - `arguments` string[] — Command arguments provided as an array of strings. These arguments can be used in addition to or instead of the command. This should be used if the command is sufficiently complex or is exceptionally whitespace sensitive. - `command` string — Provide a command to run as part of the scan discovery phase. This command will be split from its arguments and execute on its own thread in a context with additional environment variables set with the proxy configuration for HawkScan to intercept http traffic. - `credentials` object — Key-Value map of additional environment variables or secrets to pass along into the execution of the command. These values will be redacted from the logs. - `environment` object — Key-Value map of environment variable names and values to pass along into the execution of the command. - `excludeParentEnvironment` boolean — Only provide the environment variables and credentials as configured. By default also includes the environment from the parent process environment for convenience. - `logOutputToForeground` boolean — This command prints the stdout and stderr of the command to the foreground. - `workingDir` string — The absolute path working directory these commands are run from. - `disableSmartCrawling` boolean — Disable smart crawling for openApiConf to enable legacy openapi import process. - `har` HawkscanHARImportConfig — Configuration for using a HAR file as the discovery for a scan. HAR files often contain requests including urls from many hosts, but only URLs matching the `app.host` or `replaceHost` will be included in the scan. - `dir` HawkscanHARImportDirectory — Paths to directories, for use with HARImportConfig. - `path` string — Path to directory containing .har files. Only files with the .har extension will be loaded in alphanumeric order. - `file` HawkscanHARImportFiles — Paths to .har HTTP Archive formatted files, for use with HARImportConfig. - `paths` string[] — Paths to HAR files to import. Files will be loaded in order provided. - `replaceHost` string — The hostname of URLs in the HAR file that will be replaced with the host defined in `app.host`. Leave blank if the `app.host` is then same hostname in the HAR file. - `maxDurationMinutes` integer — Maximum allowed time for enabled spiders to crawl your web application. - `postmanConfig` HawkscanPostmanConfig — Configuration for the Postman Collection. - `apikey` string — API key to authenticated the user with Postman. - `collectionUID` string — Id of the collection to be pulled from Postman. - `filePath` string — File path of the Postman collection. - `responseBodyFilter` HawkscanHawkConfSpiderSpiderResponseBodyFilter — Configuration for filtering which response bodies are included when uploading spider HTTP messages. This allows customization of which content types have their response bodies uploaded for security analysis. By default, useful content types (HTML, JSON, XML) are included while large or binary content (images, CSS, JS) is excluded. - `excludeContentTypes` string[] — Content types to exclude from response body uploads. If specified, adds to the default exclude list. Exclusions take precedence over inclusions. Supports wildcards (e.g., `image/*`). - `includeContentTypes` string[] — Content types to include in response body uploads. If specified, replaces the default include list. Supports wildcards (e.g., `application/*+json`, `image/*`). - `seedPaths` string[] — List of paths to supplement the spider. These paths will be used as additional starting points for crawling your application. Useful for paths that are not crawlable from the root of your application. For example, `/admin`. **Note**: this configuration is NOT a replacement for an API spec and provides no benefit to pure REST API's. - `startupTimeoutMinutes` integer — Maximum time in minutes to wait for the scanner process to start. - `hawkAddOn` HawkscanHawkAddOnConf — Extend HawkScan functionality with add-ons and custom scripts: - `replacer`: Modify or replace HTTP request headers using `rules` with properties like `matchString`, `replacement`, `isRegex`, and `replaceOnly`. - `scripts`: Configure custom scripts to customize scan behavior with `name`, `type` (e.g., active, authentication), `path`, `language` (KOTLIN, JAVASCRIPT), and `vars`. For more detail, see [HawkScan Configuration Documentation](https://docs.stackhawk.com/hawkscan/configuration/#hawkaddon). - `replacer` HawkscanReplacer — Configuration block for header value replacement. These rules support manipulating request headers, useful for modifying requests to web applications running behind a proxy. - `rules` HawkscanReplacerRules[] — List of regex match and replace rules for request headers. - `initiators` string[] — Replacer rule initiators. - `isRegex` boolean — Enable regex search for `matchString`. Useful when `replaceOnly` is true (e.g. `Referer:.*` will replace the entire `Referer:` header line). - `matchString` string — If `replaceOnly` is false, only match the header name. If `replaceOnly` is true, matches the exact string on the header line. - `replaceOnly` boolean — If false, replace existing header value or add the missing header using replacement as the value. If true, only replace the matchString of an existing header line. - `replacement` string — If false, replace existing header value or add the missing header using replacement as the value. If true, only replace the matchString of an existing header line. - `scripts` HawkscanScript[] — List of configurations for custom scripts. - `id` integer — Plugin Id for script. - `language` 'KOTLIN' | 'JAVASCRIPT' — **Required**. The language of this script. Either `KOTLIN` or `JAVASCRIPT`. - `name` string — The name of this custom script. - `path` string — Path to the file location for the custom script. - `type` 'active' | 'authentication' | 'httpsender' | 'passive' | 'proxy' | 'session' — The type of this script. One of `active`, `authentication`, `httpsender`, `passive`, `proxy`, `session`. - `vars` HawkscanNameValParam[] — Named variables to expose to the script. - `name` string — Param name. - `val` string — Param value. - `tags` HawkscanTag[] — Searchable keywords to associate with this scan. - `name` string — The keyword name. - `value` string — An arbitrary value to associate with the keyword. - `configHash` string — The hash of the HawkScan configuration. ## Other responses - `401` — Unauthorized --- [API](https://skmtc.net/stackhawk/apis/stackhawk-public-api.md) · [All operations](https://skmtc.net/stackhawk/apis/stackhawk-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stackhawk/stackhawk-public-api/revisions/ad3dfd54cb63/schema)