Skip to main content

Detection file

File nameResource
*.detection.yamlDetection

GitOps file for a single space.

Queries​

The query lives in a Hamelin sidecar file next to this one, named <name>.detection.hmln.

Identity​

  • originKey: GitOps identity of the resource this file owns. The same value as the API's originKey.
  • id: Server-assigned id. Absent until the resource exists.

Fields​

FieldTypeRequiredDescription
accumulationKeyarray of stringOptionalMay be null.
archivedbooleanOptionalDefaults to false.
createCasebooleanOptionalDefaults to false.
deploybooleanRequiredWhether to deploy the detection.
descriptionstringOptionalMay be null. Defaults to null.
folderstringOptionalA Folder by its originKey (managed in this repo) or its server id (FLD_…).
idstringOptionalServer-assigned id. Absent until the resource exists. Pattern: ^DET_[A-Z0-9]{1,7}$.
levelenumRequiredOne of INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL.
maturityenumRequiredOne of EXPERIMENTAL, TEST, STABLE, DEPRECATED.
maximumLatencyenumRequiredOne of MAX_1H, MAX_1D, MAX_15M.
minimumPriorityintegerOptionalMay be null. Minimum 1. Maximum 10.
namestringRequired
originKeystringRequiredGitOps identity of the resource this file owns. The same value as the API's originKey. Pattern: ^(?!perpetual:)[a-z][a-z0-9-]{0,31}:[A-Za-z0-9._~\-/:@]{1,256}$.
playbookstringOptionalMay be null. Defaults to null.
retentionDaysintegerOptionalMay be null. Greater than 0.
spaceIdstringRequiredSpace the resource belongs to. Pattern: ^SPC_[A-Z0-9]{1,7}$.
startsAtstringOptionalThe start time for the detection. Signals will only be generated for data after this time. Defaults to the detection creation time. May be null. Format: date-time.
typeenumRequiredOne of QUERY, SCENARIO.

In a content pack​

A content pack's source directory uses the same file, with these differences:

  • Not used in a pack: deploy, originKey, spaceId, startsAt.
  • These fields are new in a pack, or have a different type, requirement or meaning there:
FieldTypeRequiredDescription
folderstringOptionalid of a Folder file in the same pack. Omit to place the item at the pack root. Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
idstringRequiredFormat: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.

Perpetual CLI 0.5.0