Rules

Create custom rule

Create a new natural language security rule that will be applied during scans

post/api/v2/rules/create

Request

  • Base URL
    https://zeropath.com
  • Auth
    API key in header X-ZeroPath-API-Token-Id and API key in header X-ZeroPath-API-Token-Secret

Request body

organizationIdstring
namestring required

Name for the custom rule

rulestring required

Natural language description of the security rule

globPatternstring

Glob pattern for files this rule applies to

sourceTypesstring[]

Source types this rule applies to

repositoryIdsstring[]

Specific repository IDs to apply this rule to (if not specified, applies to all)

Response

Rule created successfully

idstring required
namestring required
rulestring required

Natural language description of the security rule

globPatternstring required
sourceTypesstring[] required
repositoryIdsstring[] required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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