Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion explore-analyze/dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Once you understand the basics, explore these common tasks:
- [Manage dashboards](dashboards/managing.md): Browse, search, organize, and track usage of your dashboards.
- [Share and export dashboards](dashboards/sharing.md): Share with your team using links or embeds, and export as PDF, PNG, or CSV.
- [Duplicate a dashboard](dashboards/duplicate-dashboards.md): Create customizable copies of existing dashboards.
- [Import a dashboard](dashboards/import-dashboards.md): Bring dashboards from other environments.
- [Import a dashboard](dashboards/import-dashboards.md): Bring a dashboard from another space, instance, or deployment into your own.

## About managed dashboards [managed-dashboards]

Expand Down
54 changes: 42 additions & 12 deletions explore-analyze/dashboards/import-dashboards.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/kibana/current/_import_dashboards.html
description: Import dashboards and their related objects into Kibana from NDJSON files using the Saved Objects interface.
description: Import a Kibana dashboard exported from another space, instance, deployment, or project, using the Dashboards API or the Saved Objects API.
type: how-to
applies_to:
stack: ga
serverless: ga
Expand All @@ -11,23 +12,52 @@ products:

# Import a dashboard [_import_dashboards]

Import dashboards into {{product.kibana}} from NDJSON files exported from other {{product.kibana}} instances or spaces. When you import a dashboard, you also import its related objects such as data views and visualizations, making it easy to migrate dashboards between environments or share them with other teams.
Import a dashboard that was exported from another {{product.kibana}} space, instance, deployment, or project. How you import it depends on the format it was exported in. Refer to [Share and export dashboards](sharing.md#export-dashboards) for the export options, then use the matching import method:

## Requirements [import-dashboard-requirements]
- {applies_to}`stack: preview 9.4` {applies_to}`serverless: preview` **JSON**: import it with the [Dashboards API](create-dashboards-programmatically.md). This is the recommended method.
- **NDJSON**: import it with the [Saved Objects API]({{kib-apis}}group/endpoint-saved-objects), or from the **Saved Objects** page.

To import dashboards, you need:
::::::{tab-set}

* **All** privilege for the **Dashboard** and **Saved Objects Management** features in {{product.kibana}}
* An NDJSON file containing the dashboard and its related objects
* Access to **Stack Management** in {{product.kibana}}
:::::{tab-item} JSON (Dashboards API)

## Import a dashboard [import-dashboard-steps]
{applies_to}`stack: preview 9.4` {applies_to}`serverless: preview` Recreate the dashboard by sending its JSON definition to the [Dashboards API](create-dashboards-programmatically.md). This is the recommended import method.

You can import dashboards from the [Saved Objects](../find-and-organize/saved-objects.md) page under **Stack Management**.
**Prerequisites**

When importing dashboards, you also import their related objects, such as data views and visualizations. Import options allow you to define how the import should behave with these related objects:
- The dashboard's API-compatible JSON. Refer to [Share and export dashboards](sharing.md#export-dashboard-json) to produce it.
- **All** privilege for the **Dashboard** feature in {{product.kibana}}.
- A way to call the API, such as {{kib}} Dev Tools Console or an API key.

* **Check for existing objects**: When selected, objects are not imported when another object with the same ID already exists in this space or cluster. For example, if you import a dashboard that uses a data view which already exists, the data view is not imported and the dashboard uses the existing data view instead. You can also chose to select manually which of the imported or the existing objects are kept by selecting **Request action on conflict**.
* **Create new objects with random IDs**: All related objects are imported and are assigned a new ID to avoid conflicts.
Send the JSON to the Dashboards API in the target space, instance, deployment, or project. The [JSON export flow](sharing.md#export-dashboard-json) can open a pre-populated request in {{kib}} Dev Tools Console, where you set the target space before sending it. The API creates the dashboard, or updates it in place when you send it with an existing ID.

For the imported dashboard to work, the objects it references, such as data views and library visualizations, must also exist in the target environment. To version-control dashboards and keep their references portable across environments, refer to [Manage dashboards as code](manage-dashboards-as-code.md).

:::::

:::::{tab-item} NDJSON (Saved Objects)

Import the dashboard and its related objects from an NDJSON file on the **Saved Objects** page.

**Prerequisites**

- An NDJSON file containing the dashboard and its related objects. Refer to [Share and export dashboards](sharing.md#export-dashboards) to produce it.
- **All** privilege for the **Dashboard** and **Saved Objects Management** features in {{product.kibana}}.
- Access to **Stack Management** in {{product.kibana}}.

Import the dashboard from the [Saved Objects](../find-and-organize/saved-objects.md) page under **Stack Management**. When you import a dashboard, you also import its related objects, such as data views and visualizations. Import options control how the import handles these related objects:

- **Check for existing objects**: When selected, objects are not imported when another object with the same ID already exists in this space or cluster. For example, if you import a dashboard that uses a data view which already exists, the data view is not imported and the dashboard uses the existing data view instead. You can also choose which of the imported or existing objects to keep by selecting **Request action on conflict**.
- **Create new objects with random IDs**: All related objects are imported and are assigned a new ID to avoid conflicts.

![Import panel](/explore-analyze/images/kibana-dashboard-import-saved-object.png "")

To automate the import, use the [import saved objects API]({{kib-apis}}operation/operation-post-saved-objects-import) instead.

:::::

::::::

:::{note}
To move a dashboard to another space within the same deployment, you don't need to export and import it. Instead, [copy it to the target space](../find-and-organize/saved-objects.md#saved-objects-copy-to-other-spaces) from the **Saved Objects** page, together with its related objects. To automate this, use the [copy saved objects to space API]({{kib-apis}}operation/operation-post-spaces-copy-saved-objects).
:::
13 changes: 13 additions & 0 deletions explore-analyze/dashboards/managing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,19 @@ products:

Manage your collection of dashboards in {{product.kibana}} using search, filtering, and organization features that help you quickly find and track the dashboards you need. Whether you're working with a few dashboards or hundreds, these management tools help you stay organized and monitor dashboard usage across your team.

On this page, find and organize your dashboards:

- [Browse dashboards](#find-dashboards): Search, filter, and sort to quickly find the dashboards you need in a large collection.
- [Browse saved visualizations and annotation groups](#find-visualizations-annotation-groups): Manage the visualizations saved in the library that you can reuse across multiple dashboards.
- [Keep track of your favorite dashboards](#_keep_track_of_your_favorite_dashboards): Flag the dashboards you use often so you can access them faster.
- [View dashboard usage](#_view_dashboard_usage): Check how much a dashboard is viewed.

To move dashboards between environments or manage them as code, refer to:

- [Share and export dashboards](sharing.md): Share with your team using links or embeds, and export as PDF, PNG, CSV, or JSON.
- [Import a dashboard](import-dashboards.md): Bring a dashboard from another space, instance, deployment, or project into your own.
- [Manage dashboards as code](manage-dashboards-as-code.md): Version-control dashboards and deploy them across spaces, clusters, and stages.


## Browse dashboards [find-dashboards]

Expand Down
4 changes: 2 additions & 2 deletions explore-analyze/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -287,11 +287,11 @@ toc:
- file: dashboards/drilldowns.md
- file: dashboards/arrange-panels.md
- file: dashboards/duplicate-dashboards.md
- file: dashboards/import-dashboards.md
- file: dashboards/managing.md
children:
- file: dashboards/sharing.md
- file: dashboards/import-dashboards.md
- file: dashboards/manage-dashboards-as-code.md
- file: dashboards/sharing.md
- file: dashboards/tutorials.md
children:
- file: dashboards/create-dashboard-of-panels-with-web-server-data.md
Expand Down
Loading