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

OptionRequirementDescriptionDefault
--request-stdinRequired optionread the authoring action JSON from stdin—
--idempotency-key <key>Optional optionstable 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

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

OptionRequirementDescriptionDefault
--body-stdinRequired optionread bounded backfill request JSON—
--confirm <detection-id>Required optionconfirm the exact detection whose historical results will be written—
--idempotency-key <key>Optional optionreuse a stable UUID for retries—

neatlogs detections backfills cancel <detection-id> <job-id>

Usage: neatlogs detections backfills cancel [options] <detection-id> <job-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——
job-idRequired argument——

Options

OptionRequirementDescriptionDefault
--confirm <job-id>Required optionconfirm the exact backfill job UUID—
--idempotency-key <key>Optional optionreuse a stable UUID for retries—

neatlogs detections backfills get <detection-id> <job-id>

Usage: neatlogs detections backfills get [options] <detection-id> <job-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——
job-idRequired argument——

Options

None.

neatlogs detections create

Usage: neatlogs detections create [options]

Arguments

None.

Options

OptionRequirementDescriptionDefault
--group <uuid>Required optiondetection group UUID—
--name <name>Required optiondisplay name—
--type <type>Required optionclassifier, regex, conditional, or pii—
--config <json>Required optiontype-specific JSON configuration—
--description <text>Optional optiondescription—
--threshold <number>Optional optionflag threshold from 0 through 1—
--run-on <json>Optional optionbounded run-on JSON configuration—
--batch-fields <json>Optional optionJSON array of span element fields—
--inactiveOptional optioncreate disabled—
--idempotency-key <key>Optional optionstable UUID for retrying this mutation—

neatlogs detections delete <detection-id>

Usage: neatlogs detections delete [options] <detection-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

OptionRequirementDescriptionDefault
--confirm <detection-id>Optional optionrepeat the exact detection ID—
--idempotency-key <key>Optional optionstable UUID for retrying this mutation—

neatlogs detections disable <detection-id>

Usage: neatlogs detections disable [options] <detection-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

OptionRequirementDescriptionDefault
--idempotency-key <key>Optional optionstable 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

ArgumentRequirementDescriptionDefault
draft-idRequired argument——

Options

None.

neatlogs detections enable <detection-id>

Usage: neatlogs detections enable [options] <detection-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

OptionRequirementDescriptionDefault
--idempotency-key <key>Optional optionstable UUID for retrying this mutation—

neatlogs detections generate

Usage: neatlogs detections generate [options]

Arguments

None.

Options

OptionRequirementDescriptionDefault
--request-stdinRequired optionread the bounded detection generation request JSON from stdin—

neatlogs detections get <detection-id>

Usage: neatlogs detections get [options] <detection-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

None.

neatlogs detections history <detection-id>

Usage: neatlogs detections history [options] <detection-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

OptionRequirementDescriptionDefault
--cursor <cursor>Optional optionopaque cursor returned by the previous page—
--limit <number>Optional optionpage size (1-100)—
--allOptional optionfollow cursors for this list command (requires --max-items)—
--max-items <number>Optional optionmaximum items to collect with --all (1-1000)—

neatlogs detections hits <detection-id>

Usage: neatlogs detections hits [options] <detection-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

OptionRequirementDescriptionDefault
--cursor <cursor>Optional optionopaque cursor returned by the previous page—
--limit <number>Optional optionpage size (1-100)—
--allOptional optionfollow cursors for this list command (requires --max-items)—
--max-items <number>Optional optionmaximum items to collect with --all (1-1000)—

neatlogs detections list

Usage: neatlogs detections list [options]

Arguments

None.

Options

OptionRequirementDescriptionDefault
--cursor <cursor>Optional optionopaque cursor returned by the previous page—
--group <uuid>Optional optionfilter by detection group UUID—
--limit <number>Optional optionpage size (1-100)—
--status <status>Optional optionactive, paused, disabled, inactive, or all—
--allOptional optionfollow cursors for this list command (requires --max-items)—
--max-items <number>Optional optionmaximum items to collect with --all (1-1000)—

neatlogs detections preview

Usage: neatlogs detections preview [options]

Arguments

None.

Options

OptionRequirementDescriptionDefault
--request-stdinRequired optionread the bounded detection preview request JSON from stdin—

neatlogs detections suggestion-accept <suggestion-id>

Usage: neatlogs detections suggestion-accept [options] <suggestion-id>

Arguments

ArgumentRequirementDescriptionDefault
suggestion-idRequired argument——

Options

OptionRequirementDescriptionDefault
--confirm <suggestion-id>Required optionconfirm the exact suggestion id—
--idempotency-key <key>Optional optionstable UUID for retrying transition—

neatlogs detections suggestion-dismiss <suggestion-id>

Usage: neatlogs detections suggestion-dismiss [options] <suggestion-id>

Arguments

ArgumentRequirementDescriptionDefault
suggestion-idRequired argument——

Options

OptionRequirementDescriptionDefault
--confirm <suggestion-id>Required optionconfirm the exact suggestion id—
--idempotency-key <key>Optional optionstable UUID for retrying transition—

neatlogs detections suggestions-list

Usage: neatlogs detections suggestions-list [options]

Arguments

None.

Options

OptionRequirementDescriptionDefault
--cursor <cursor>Optional optionopaque cursor returned by the previous page—
--limit <number>Optional optionpage size (1-50)—
--allOptional optionfollow cursors for this list command (requires --max-items)—
--max-items <number>Optional optionmaximum items to collect with --all (1-1000)—

neatlogs detections suggestions-run

Usage: neatlogs detections suggestions-run [options]

Arguments

None.

Options

OptionRequirementDescriptionDefault
--request-stdinRequired optionread the bounded suggestion run request JSON from stdin—
--idempotency-key <key>Optional optionstable UUID for retrying this run—

neatlogs detections suggestions-run-cancel <run-id>

Usage: neatlogs detections suggestions-run-cancel [options] <run-id>

Arguments

ArgumentRequirementDescriptionDefault
run-idRequired argument——

Options

OptionRequirementDescriptionDefault
--confirm <run-id>Required optionconfirm the exact run id—
--idempotency-key <key>Optional optionstable UUID for retrying cancellation—

neatlogs detections suggestions-run-status <run-id>

Usage: neatlogs detections suggestions-run-status [options] <run-id>

Arguments

ArgumentRequirementDescriptionDefault
run-idRequired argument——

Options

None.

Usage: neatlogs detections trends [options] <detection-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

OptionRequirementDescriptionDefault
--from <timestamp>Required optioninclusive UTC start timestamp—
--to <timestamp>Required optionexclusive UTC end timestamp—
--granularity <value>Optional optionhour, day, or weekday

neatlogs detections update <detection-id>

Usage: neatlogs detections update [options] <detection-id>

Arguments

ArgumentRequirementDescriptionDefault
detection-idRequired argument——

Options

OptionRequirementDescriptionDefault
--group <uuid>Optional optionnew detection group UUID—
--name <name>Optional optionnew display name—
--description <text>Optional optionnew description—
--clear-descriptionOptional optionset description to null—
--threshold <number>Optional optionflag threshold from 0 through 1—
--config <json>Optional optiontype-specific JSON configuration—
--run-on <json>Optional optionbounded run-on JSON configuration—
--batch-fields <json>Optional optionJSON array of span element fields—
--clear-batch-fieldsOptional optionset batch fields to null—
--idempotency-key <key>Optional optionstable UUID for retrying this mutation—

On this page

Ask Neatlogs AI

Answers from the docs

How can I help?

Ask anything about instrumenting, tracing, or the Neatlogs dashboard.