Detection file
| File name | Resource |
|---|---|
*.detection.yaml | Detection |
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
| Field | Type | Required | Description |
|---|---|---|---|
accumulationKey | array of string | Optional | May be null. |
archived | boolean | Optional | Defaults to false. |
createCase | boolean | Optional | Defaults to false. |
deploy | boolean | Required | Whether to deploy the detection. |
description | string | Optional | May be null. Defaults to null. |
folder | string | Optional | A Folder by its originKey (managed in this repo) or its server id (FLD_…). |
id | string | Optional | Server-assigned id. Absent until the resource exists. Pattern: ^DET_[A-Z0-9]{1,7}$. |
level | enum | Required | One of INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL. |
maturity | enum | Required | One of EXPERIMENTAL, TEST, STABLE, DEPRECATED. |
maximumLatency | enum | Required | One of MAX_1H, MAX_1D, MAX_15M. |
minimumPriority | integer | Optional | May be null. Minimum 1. Maximum 10. |
name | string | Required | |
originKey | string | Required | GitOps 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}$. |
playbook | string | Optional | May be null. Defaults to null. |
retentionDays | integer | Optional | May be null. Greater than 0. |
spaceId | string | Required | Space the resource belongs to. Pattern: ^SPC_[A-Z0-9]{1,7}$. |
startsAt | string | Optional | The 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. |
type | enum | Required | One 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:
| Field | Type | Required | Description |
|---|---|---|---|
folder | string | Optional | id 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)$. |
id | string | Required | 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)$. |
Related
Perpetual CLI 0.5.0