--- title: "neatlogs detections" description: "Commands and options for neatlogs detections." --- Generated from the released CLI command tree. Global options, output behavior, and authentication are covered in the [CLI guide](/cli). Use `neatlogs detections --help` to check your installed version. ## `neatlogs detections create` Usage: `neatlogs detections create [options]` ### Arguments None. ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--group ` | Required option | detection group UUID | — | | `--name ` | Required option | display name | — | | `--type ` | Required option | classifier, regex, conditional, or pii | — | | `--config ` | Required option | type-specific JSON configuration | — | | `--description ` | Optional option | description | — | | `--threshold ` | Optional option | flag threshold from 0 through 1 | — | | `--run-on ` | Optional option | bounded run-on JSON configuration | — | | `--batch-fields ` | Optional option | JSON array of span element fields | — | | `--inactive` | Optional option | create disabled | — | | `--idempotency-key ` | Optional option | stable UUID for retrying this mutation | — | ## `neatlogs detections delete ` Usage: `neatlogs detections delete [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `detection-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--confirm ` | Optional option | repeat the exact detection ID | — | | `--idempotency-key ` | Optional option | stable UUID for retrying this mutation | — | ## `neatlogs detections disable ` Usage: `neatlogs detections disable [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `detection-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--idempotency-key ` | Optional option | stable UUID for retrying this mutation | — | ## `neatlogs detections enable ` Usage: `neatlogs detections enable [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `detection-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--idempotency-key ` | Optional option | stable UUID for retrying this mutation | — | ## `neatlogs detections generate` Usage: `neatlogs detections generate [options]` ### Arguments None. ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--request-stdin` | Required option | read the bounded detection generation request JSON from stdin | — | ## `neatlogs detections get ` Usage: `neatlogs detections get [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `detection-id` | Required argument | — | — | ### Options None. ## `neatlogs detections history ` Usage: `neatlogs detections history [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `detection-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--cursor ` | Optional option | opaque cursor returned by the previous page | — | | `--limit ` | Optional option | page size (1-100) | — | | `--all` | Optional option | follow cursors for this list command (requires --max-items) | — | | `--max-items ` | Optional option | maximum items to collect with --all (1-1000) | — | ## `neatlogs detections hits ` Usage: `neatlogs detections hits [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `detection-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--cursor ` | Optional option | opaque cursor returned by the previous page | — | | `--limit ` | Optional option | page size (1-100) | — | | `--all` | Optional option | follow cursors for this list command (requires --max-items) | — | | `--max-items ` | Optional option | maximum items to collect with --all (1-1000) | — | ## `neatlogs detections list` Usage: `neatlogs detections list [options]` ### Arguments None. ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--cursor ` | Optional option | opaque cursor returned by the previous page | — | | `--group ` | Optional option | filter by detection group UUID | — | | `--limit ` | Optional option | page size (1-100) | — | | `--status ` | Optional option | active, paused, disabled, inactive, or all | — | | `--all` | Optional option | follow cursors for this list command (requires --max-items) | — | | `--max-items ` | Optional option | maximum items to collect with --all (1-1000) | — | ## `neatlogs detections preview` Usage: `neatlogs detections preview [options]` ### Arguments None. ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--request-stdin` | Required option | read the bounded detection preview request JSON from stdin | — | ## `neatlogs detections suggestion-accept ` Usage: `neatlogs detections suggestion-accept [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `suggestion-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--confirm ` | Required option | confirm the exact suggestion id | — | | `--idempotency-key ` | Optional option | stable UUID for retrying transition | — | ## `neatlogs detections suggestion-dismiss ` Usage: `neatlogs detections suggestion-dismiss [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `suggestion-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--confirm ` | Required option | confirm the exact suggestion id | — | | `--idempotency-key ` | Optional option | stable UUID for retrying transition | — | ## `neatlogs detections suggestions-list` Usage: `neatlogs detections suggestions-list [options]` ### Arguments None. ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--cursor ` | Optional option | opaque cursor returned by the previous page | — | | `--limit ` | Optional option | page size (1-50) | — | | `--all` | Optional option | follow cursors for this list command (requires --max-items) | — | | `--max-items ` | Optional option | maximum items to collect with --all (1-1000) | — | ## `neatlogs detections suggestions-run` Usage: `neatlogs detections suggestions-run [options]` ### Arguments None. ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--request-stdin` | Required option | read the bounded suggestion run request JSON from stdin | — | | `--idempotency-key ` | Optional option | stable UUID for retrying this run | — | ## `neatlogs detections suggestions-run-cancel ` Usage: `neatlogs detections suggestions-run-cancel [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `run-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--confirm ` | Required option | confirm the exact run id | — | | `--idempotency-key ` | Optional option | stable UUID for retrying cancellation | — | ## `neatlogs detections suggestions-run-status ` Usage: `neatlogs detections suggestions-run-status [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `run-id` | Required argument | — | — | ### Options None. ## `neatlogs detections trends ` Usage: `neatlogs detections trends [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `detection-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--from ` | Required option | inclusive UTC start timestamp | — | | `--to ` | Required option | exclusive UTC end timestamp | — | | `--granularity ` | Optional option | hour, day, or week | day | ## `neatlogs detections update ` Usage: `neatlogs detections update [options] ` ### Arguments | Argument | Requirement | Description | Default | | --- | --- | --- | --- | | `detection-id` | Required argument | — | — | ### Options | Option | Requirement | Description | Default | | --- | --- | --- | --- | | `--group ` | Optional option | new detection group UUID | — | | `--name ` | Optional option | new display name | — | | `--description ` | Optional option | new description | — | | `--clear-description` | Optional option | set description to null | — | | `--threshold ` | Optional option | flag threshold from 0 through 1 | — | | `--config ` | Optional option | type-specific JSON configuration | — | | `--run-on ` | Optional option | bounded run-on JSON configuration | — | | `--batch-fields ` | Optional option | JSON array of span element fields | — | | `--clear-batch-fields` | Optional option | set batch fields to null | — | | `--idempotency-key ` | Optional option | stable UUID for retrying this mutation | — |

neatlogs detections

On this page