ESescape
SecurityTests

Get a security test

Get a security test from the organization catalog by uid, with its organization configuration (enabled state and custom severity) and open issue counts.

get/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 uid of the security test

Example:ISSUE_SQL_INJECTION

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.