Schema URL

Type: object

Settings for project analysis by the Application Inspector

Properties

ProgrammingLanguages string[] required
uniqueItems=true
ProjectName string required
ScanModules string[] required
uniqueItems=true
$schema string
Version string
Values: "1.0" "1.1" "1.2" "1.3" "1.4" "1.5"
BlackBoxSettings object | null
10 nested properties
AdditionalHttpHeaders array | null

Dictionary of additional HTTP headers

WhiteListedAddresses array | null

Addresses, that was added in white list

BlackListedAddresses array | null

Addresses, that was added in black list

Authentication object | null
One of: object object, object object, object object, object object, null null
4 nested properties
Cookie object | null

Cookie authentication options

3 nested properties
Cookie string required
ValidationAddress string required

Verification address

ValidationTemplate string required

String to search for

Form object | null

Form-based authentication options

Any of: object object, object object
8 nested properties
FormDetection string

Type of form authentication detection

Values: "Auto" "Manual"
FormAddress
FormXPath
Login
LoginKey
Password
PasswordKey
ValidationTemplate

String to search for

Http object | null

HTTP Basic authentication options

3 nested properties
Login string required
Password string required
ValidationAddress string required
Type string
Values: "Form" "Http" "RawCookie" "None"
Level string
Values: "None" "Fast" "Full" "Normal"
ProxySettings object | null

Proxy server settings

6 nested properties
Enabled boolean
Host null | string
Login null | string
Password null | string
Port integer
Type string
Values: "Http" "Socks4" "Socks5"
RunAutocheckAfterScan boolean

Autocheck vulnerabilities after scanning

ScanScope string
Values: "Domain" "Folder" "Path"
Site string
SslCheck boolean
WindowsDotNetSettings object | null
5 nested properties
ProjectType string
Values: "None" "Solution" "WebSite"
SolutionFile null | string

Path to a solution or project

UsePublicAnalysisMethod null | boolean
DownloadDependencies null | boolean
CustomParameters null | string

Custom DotNet kernel startup parameters

DotNetSettings object | null
5 nested properties
ProjectType string
Values: "None" "Solution" "WebSite"
SolutionFile null | string

Path to a solution or project

UsePublicAnalysisMethod null | boolean
DownloadDependencies null | boolean
CustomParameters null | string

Custom DotNet kernel startup parameters

GoSettings object | null
2 nested properties
UsePublicAnalysisMethod null | boolean
CustomParameters null | string

Custom Go kernel startup parameters

JavaSettings object | null
8 nested properties
Parameters null | string
UnpackUserPackages boolean
UserPackagePrefixes null | string
Version string
Values: "8" "11" "17"
UsePublicAnalysisMethod null | boolean
DownloadDependencies null | boolean
DependenciesPath null | string

Path that the Java kernel will use as a classPath

CustomParameters null | string

Custom Java kernel startup parameters

JavaScriptSettings object | null
5 nested properties
UsePublicAnalysisMethod null | boolean
UseTaintAnalysis null | boolean
UseJsaAnalysis null | boolean
DownloadDependencies null | boolean
CustomParameters null | string

Custom JavaScript kernel startup parameters

PhpSettings object | null
3 nested properties
UsePublicAnalysisMethod null | boolean
DownloadDependencies null | boolean
CustomParameters null | string

Custom Php kernel startup parameters

PmTaintSettings object | null
2 nested properties
UsePublicAnalysisMethod null | boolean
CustomParameters null | string

Custom PmTaint kernel startup parameters

PygrepSettings object | null
2 nested properties
CustomParameters null | string

Custom Pygrep kernel startup parameters

RulesDirPath null | string

Path to the custom rules directory

PythonSettings object | null
4 nested properties
UsePublicAnalysisMethod null | boolean
DownloadDependencies null | boolean
DependenciesPath null | string

Path to venv or path to directory with dependencies if venv was not used to restore them

CustomParameters null | string

Custom Python kernel startup parameters

MailingProjectSettings object | null

Report mailing options

One of: object object, object object
3 nested properties
Enabled boolean
MailProfileName null | string
EmailRecipients string[]
RubySettings object | null
2 nested properties
UsePublicAnalysisMethod null | boolean
CustomParameters null | string

Custom Ruby kernel startup parameters

ScaSettings object | null
2 nested properties
CustomParameters null | string

Custom SCA kernel startup parameters

BuildDependenciesGraph null | boolean
Tags array | null
uniqueItems=true
SkipGitIgnoreFiles boolean

Exclude from scanning the files from the .gitignore file

UseSastRules boolean

Enable SAST Analysis rules

UseCustomPmRules boolean

Enable custom PM rules

UseSecurityPolicies boolean

Check for compliance with the security policy