Rules

Get custom rule

Get details of a specific custom rule including associated repositories

post/api/v2/rules/get

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
ruleIdstring required

Response

Successful response

idstring required
namestring required
rulestring required

Natural language description of the security rule

globPatternstring required
sourceTypesstring[] required
source'USER' | 'SECURITY_COMPASS'
scope'allRepositories' | 'repositories' | 'tags' required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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