ESescape
SecurityTests
Beta

Update a security test

Update the organization configuration of a security test: enable or disable it, and/or override the severity assigned to its issues. At least one of enabled or customSeverity is required. Omitted fields are left unchanged. Pass customSeverity: null to reset the override to the scanner default.

put/security-tests/{securityTestUid}

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

securityTestUidstring required

The security test ID (UID)

Example:ISSUE_AGENTIC_SQL_INJECTION

Request body

enabledboolean

Whether the security test is enabled for your organization

customSeverity'CRITICAL' | 'HIGH' | 'INFO' | 'LOW' | 'MEDIUM' | 'null' nullable

The severity override for this security test. Pass null to reset to the scanner default. Omit to leave the current override unchanged.

Response

OK

idstring required

The uid of the security test

namestring required

The human readable name of the security test

category'ACCESS_CONTROL' | 'CONFIGURATION' | 'CUSTOM' | 'INFORMATION_DISCLOSURE' | 'INJECTION' | 'PROTOCOL' | 'REQUEST_FORGERY' | 'RESOURCE_LIMITATION' | 'SCHEMA' | 'SENSITIVE_DATA' required

The issue category this test belongs to

descriptionstring required

The description of the security test

documentationPathstring required

Relative path to the security test documentation

scannersstring[] required

Scanner kinds that can run this security test

assetTypesstring[] required

Asset types this security test applies to

enabledboolean required

Whether the test is enabled for the organization (defaults to true)

defaultSeverity'CRITICAL' | 'HIGH' | 'INFO' | 'LOW' | 'MEDIUM' | 'null' nullable required

The default severity of the test

customSeverity'CRITICAL' | 'HIGH' | 'INFO' | 'LOW' | 'MEDIUM' | 'null' nullable required

The organization override of the severity, null when not overridden

severity'CRITICAL' | 'HIGH' | 'INFO' | 'LOW' | 'MEDIUM' | 'null' nullable required

The effective severity: customSeverity when set, otherwise defaultSeverity

cvssScorenumber nullable required

The CVSS score of the test, when available

cvssVectorstring nullable required

The CVSS vector of the test, when available

Changes

No recorded changes to this operation across all 1 revision of this API.