Type to search.

stack kb dashboards upsert-dashboard cli command

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.

Auth required Idempotent Scope: global
Shell
elastic stack kb dashboards upsert-dashboard --id <id> --title <title> [options]

Upsert a dashboard

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--id string required
The unique ID of the dashboard to be created or updated
--title string required
A human-readable title for the dashboard.
--access-control string
--description string
A short description of the dashboard.
--esql-approximation
When true, ES|QL visualizations that use STATS run with approximate execution for faster, estimated results.
--filters string[]

Filters applied across all panels, including pinned panels.

Repeatable: pass --filters multiple times to supply more than one value

--options string
--panels string[]

Panels and sections in the dashboard. Each entry is either a panel (with a type and config) or a collapsible section (with a title, collapsed state, and nested panels).

Repeatable: pass --panels multiple times to supply more than one value

--pinned-panels string[]

An array of control panels and their state in the control group.

Repeatable: pass --pinned-panels multiple times to supply more than one value

--project-routing string
Controls cross-project search behavior for this dashboard (Serverless only). Set to _alias:_origin to scope data to the current project, or _alias:* to search across all projects. When omitted, the space default applies.
--query string
--refresh-interval string
--tags string[]

Tag IDs to associate with this dashboard.

Repeatable: pass --tags multiple times to supply more than one value

--time-range string
--input-file string
path to a JSON file to use as command input
--dry-run
validate all inputs and exit without performing any action (preview changes without applying them)
--no-validate
skip input validation and send the request as-is
--output-fields string
comma-separated list of fields to include in output (dot-notation supported)
--output-template string
Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--json

output as JSON