perpetual detection
Manage detections.
perpetual detection create
Create a new detection.
perpetual detection create [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | Required | Detection name (max 256 characters). |
--space-id | string | Required | Space ID the detection belongs to. |
--description | string | Optional | Detection description. |
--query | string | Required | Hamelin query for the detection. |
--maturity | string | Optional | Detection maturity (EXPERIMENTAL, TEST, STABLE, DEPRECATED). |
--level | string | Optional | Detection level (INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL). |
--maximum-latency | string | Optional | Maximum latency (MAX_1H, MAX_1D, MAX_15M). |
--deploy | boolean | Optional | Whether to deploy the detection (default: false). |
--changeset | string | Optional | Changeset (CHG_*) to stage this create into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual detection delete
Delete a detection.
perpetual detection delete <id> [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Detection ID (DET_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--base-version | string | Optional | Expected current version for optimistic concurrency. |
--changeset | string | Optional | Changeset (CHG_*) to stage into; REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual detection export
Write a detection as a GitOps file.
perpetual detection export <id> [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Detection ID (DET_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--dir | string | Optional | Directory for a new file (default .). |
--file | string | Optional | Existing .detection.yaml/.json file to edit in place. |
Also accepts the global flags, including the sign-in flags.
perpetual detection get
Get a detection.
perpetual detection get <id>
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Detection ID (DET_*). |
Also accepts the global flags, including the sign-in flags.
perpetual detection list
List detections.
perpetual detection list [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--space | string, repeatable | Optional | Only these spaces: SPC_* ids, comma-separated or repeated. |
--filter | string | Optional | Raw OData $filter expression, passed to the server as is. |
--sort-by | string | Optional | Field to sort by (name, createdAt, updatedAt, level, maturity). |
--sort-order | string | Optional | Sort direction (asc, desc). |
--name | string | Optional | Filter by name (substring match). |
--level | string | Optional | Filter by severity level (INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL). |
--maturity | string | Optional | Filter by maturity (EXPERIMENTAL, TEST, STABLE, DEPRECATED). |
--deploy | string | Optional | Filter by deployment status (true, false). |
--archived | string | Optional | Filter by archived status (true, false). |
--no-bodies | boolean | Optional | Omit the large query and description fields from each item (CLI-side projection; the server still returns the full bodies — this trims output, not the network transfer). |
--created-by-user-id | string | Optional | Filter by creator user ID (USR_* format). |
--updated-by-user-id | string | Optional | Filter by last updater user ID (USR_* format). |
--top | string | Optional | Items per page (server default 100). |
--skip | string | Optional | Number of items to skip. |
--all | boolean | Optional | Fetch every page (1000 items per request). |
Also accepts the global flags, including the sign-in flags.
perpetual detection update
Update a detection.
perpetual detection update <id> [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Detection ID. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | Optional | New detection name. |
--description | string | Optional | New detection description. |
--query | string | Optional | New Hamelin query for the detection. |
--maturity | string | Optional | New maturity (EXPERIMENTAL, TEST, STABLE, DEPRECATED). |
--level | string | Optional | New level (INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL). |
--maximum-latency | string | Optional | New maximum latency (MAX_1H, MAX_1D, MAX_15M). |
--deploy | boolean | Optional | Whether to deploy the detection. |
--changeset | string | Optional | Changeset (CHG_*) to stage this update into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
Perpetual CLI 0.5.0