Type to search.

stack kb security-detections-api cli namespace

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Shell
elastic stack kb security-detections-api --help

Kibana security-detections-api API commands

set-attacks-assignees

Assign and unassign users from attack discovery alerts

search-attacks

Find and/or aggregate attack discovery alerts

set-attacks-status

Set attack discovery alerts workflow status

set-attacks-tags

Add and remove attack discovery alert tags

delete-alerts-index

Delete an alerts index

read-alerts-index

Reads the alert index name if it exists

create-alerts-index

Create an alerts index

read-privileges

Returns user privileges for the Kibana space

delete-rule

Delete a detection rule

read-rule

Retrieve a detection rule

patch-rule

Patch a detection rule

create-rule

Create a detection rule

update-rule

Update a detection rule

perform-rules-bulk-action

Apply a bulk action to detection rules

export-rules

Export detection rules

find-rules

List all detection rules

import-rules

Import detection rules

install-prebuilt-rules-and-timelines

Install prebuilt detection rules and Timelines

read-prebuilt-rules-and-timelines-status

Retrieve the status of prebuilt detection rules and Timelines

rule-preview

Preview rule alerts generated on specified time range

set-alert-assignees

Assign and unassign users from detection alerts

finalize-alerts-migration

Finalize detection alert migrations

alerts-migration-cleanup

Clean up detection alert migrations

create-alerts-migration

Initiate a detection alert migration

read-alerts-migration-status

Retrieve the status of detection alert migrations

search-alerts

Find and/or aggregate detection alerts

set-alerts-status

Set a detection alert status

set-alert-tags

Add and remove detection alert tags

read-tags

List all detection rule tags