neatlogs detections
Commands and options for neatlogs detections.
Generated from the CLI command tree. Release status, global options, output behavior, and authentication are covered in the CLI guide. Use neatlogs detections --help to check your installed version.
neatlogs detections author
prepare, revise, retest or commit a service account's detector draft
Usage: neatlogs detections author [options]
Arguments
None.
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--request-stdin | Required option | read the authoring action JSON from stdin | — |
--idempotency-key <key> | Optional option | stable UUID for retrying this action | — |
neatlogs detections backfill <detection-id>
explicitly rescore a bounded historical trace set
Usage: neatlogs detections backfill [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--body-stdin | Required option | read bounded backfill request JSON | — |
--confirm <detection-id> | Required option | confirm the exact detection whose historical results will be written | — |
--idempotency-key <key> | Optional option | reuse a stable UUID for retries | — |
neatlogs detections backfills cancel <detection-id> <job-id>
Usage: neatlogs detections backfills cancel [options] <detection-id> <job-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
job-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--confirm <job-id> | Required option | confirm the exact backfill job UUID | — |
--idempotency-key <key> | Optional option | reuse a stable UUID for retries | — |
neatlogs detections backfills get <detection-id> <job-id>
Usage: neatlogs detections backfills get [options] <detection-id> <job-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
job-id | Required argument | — | — |
Options
None.
neatlogs detections create
Usage: neatlogs detections create [options]
Arguments
None.
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--group <uuid> | Required option | detection group UUID | — |
--name <name> | Required option | display name | — |
--type <type> | Required option | classifier, regex, conditional, or pii | — |
--config <json> | Required option | type-specific JSON configuration | — |
--description <text> | Optional option | description | — |
--threshold <number> | Optional option | flag threshold from 0 through 1 | — |
--run-on <json> | Optional option | bounded run-on JSON configuration | — |
--batch-fields <json> | Optional option | JSON array of span element fields | — |
--inactive | Optional option | create disabled | — |
--idempotency-key <key> | Optional option | stable UUID for retrying this mutation | — |
neatlogs detections delete <detection-id>
Usage: neatlogs detections delete [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--confirm <detection-id> | Optional option | repeat the exact detection ID | — |
--idempotency-key <key> | Optional option | stable UUID for retrying this mutation | — |
neatlogs detections disable <detection-id>
Usage: neatlogs detections disable [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--idempotency-key <key> | Optional option | stable UUID for retrying this mutation | — |
neatlogs detections draft <draft-id>
read this service account's draft, preview and monitoring state
Usage: neatlogs detections draft [options] <draft-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
draft-id | Required argument | — | — |
Options
None.
neatlogs detections enable <detection-id>
Usage: neatlogs detections enable [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--idempotency-key <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 <detection-id>
Usage: neatlogs detections get [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
None.
neatlogs detections history <detection-id>
Usage: neatlogs detections history [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--cursor <cursor> | Optional option | opaque cursor returned by the previous page | — |
--limit <number> | Optional option | page size (1-100) | — |
--all | Optional option | follow cursors for this list command (requires --max-items) | — |
--max-items <number> | Optional option | maximum items to collect with --all (1-1000) | — |
neatlogs detections hits <detection-id>
Usage: neatlogs detections hits [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--cursor <cursor> | Optional option | opaque cursor returned by the previous page | — |
--limit <number> | Optional option | page size (1-100) | — |
--all | Optional option | follow cursors for this list command (requires --max-items) | — |
--max-items <number> | 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 <cursor> | Optional option | opaque cursor returned by the previous page | — |
--group <uuid> | Optional option | filter by detection group UUID | — |
--limit <number> | Optional option | page size (1-100) | — |
--status <status> | Optional option | active, paused, disabled, inactive, or all | — |
--all | Optional option | follow cursors for this list command (requires --max-items) | — |
--max-items <number> | 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 <suggestion-id>
Usage: neatlogs detections suggestion-accept [options] <suggestion-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
suggestion-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--confirm <suggestion-id> | Required option | confirm the exact suggestion id | — |
--idempotency-key <key> | Optional option | stable UUID for retrying transition | — |
neatlogs detections suggestion-dismiss <suggestion-id>
Usage: neatlogs detections suggestion-dismiss [options] <suggestion-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
suggestion-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--confirm <suggestion-id> | Required option | confirm the exact suggestion id | — |
--idempotency-key <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 <cursor> | Optional option | opaque cursor returned by the previous page | — |
--limit <number> | Optional option | page size (1-50) | — |
--all | Optional option | follow cursors for this list command (requires --max-items) | — |
--max-items <number> | 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 <key> | Optional option | stable UUID for retrying this run | — |
neatlogs detections suggestions-run-cancel <run-id>
Usage: neatlogs detections suggestions-run-cancel [options] <run-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
run-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--confirm <run-id> | Required option | confirm the exact run id | — |
--idempotency-key <key> | Optional option | stable UUID for retrying cancellation | — |
neatlogs detections suggestions-run-status <run-id>
Usage: neatlogs detections suggestions-run-status [options] <run-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
run-id | Required argument | — | — |
Options
None.
neatlogs detections trends <detection-id>
Usage: neatlogs detections trends [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--from <timestamp> | Required option | inclusive UTC start timestamp | — |
--to <timestamp> | Required option | exclusive UTC end timestamp | — |
--granularity <value> | Optional option | hour, day, or week | day |
neatlogs detections update <detection-id>
Usage: neatlogs detections update [options] <detection-id>
Arguments
| Argument | Requirement | Description | Default |
|---|---|---|---|
detection-id | Required argument | — | — |
Options
| Option | Requirement | Description | Default |
|---|---|---|---|
--group <uuid> | Optional option | new detection group UUID | — |
--name <name> | Optional option | new display name | — |
--description <text> | Optional option | new description | — |
--clear-description | Optional option | set description to null | — |
--threshold <number> | Optional option | flag threshold from 0 through 1 | — |
--config <json> | Optional option | type-specific JSON configuration | — |
--run-on <json> | Optional option | bounded run-on JSON configuration | — |
--batch-fields <json> | Optional option | JSON array of span element fields | — |
--clear-batch-fields | Optional option | set batch fields to null | — |
--idempotency-key <key> | Optional option | stable UUID for retrying this mutation | — |
