Upsert a data view

Base URL
https://{kibana_url}
Auth

Creates the data view with the ID in the path, or replaces its definition if it already exists. Returns 201 when the request creates a data view and 200 when it replaces one. A replacement removes any optional property you omit, such as time_field.

Required authorization

Privileges indexPatterns:manage

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

id string · min length: 1 · max length: 1000 required

The ID of the data view to create or update.

Header parameters

kbn-xsrf string required

A required header to protect against CSRF attacks

Request body

allow_hidden_indices boolean

When true, allows the data view to match hidden indices.

field_filters string[] · max items: 10000

Field filters can be used to exclude one or more fields when fetching a document. They may contain wildcards, such as user* which filters fields starting with 'user'.

field_settings map string to anyOf

Settings for individual fields, keyed by field name. To change how Kibana displays a field from the backing indices, set its label, description, format, or popularity. To define a runtime field, use the runtime field name and set type.

index_pattern string · min length: 1 required

The index pattern (Elasticsearch index expression) to use as the data source. Example: "my-index-*".

name string · min length: 1 · max length: 256

The name of the data view. Example: "Sample data view".

time_field string

The name of the time field in the index. Used for time-based filtering. Example: "@timestamp".

Responses

updated

application/json
data object required

Defines an stored data source with a mandatory index pattern and optional settings like id, name, show hidden indices and field settings.

allow_hidden_indices boolean

When true, allows the data view to match hidden indices.

field_filters string[] · max items: 10000

Field filters can be used to exclude one or more fields when fetching a document. They may contain wildcards, such as user* which filters fields starting with 'user'.

field_settings map string to anyOf

Settings for individual fields, keyed by field name. To change how Kibana displays a field from the backing indices, set its label, description, format, or popularity. To define a runtime field, use the runtime field name and set type.

id string · min length: 1 · max length: 256

Kibana provides a unique identifier for each data view, or you can create your own.

index_pattern string · min length: 1 required

The index pattern (Elasticsearch index expression) to use as the data source. Example: "my-index-*".

name string · min length: 1 · max length: 256

The name of the data view. Example: "Sample data view".

time_field string

The name of the time field in the index. Used for time-based filtering. Example: "@timestamp".

id string · max length: 1000 required

The ID of the data view.

meta object required

Metadata about the data view.

created_at string

Timestamp when the object was created (ISO 8601).

created_by string

User profile ID of the user who created the object.

managed boolean

When true, the object is managed by Kibana and cannot be edited by users.

owner string

Identifier of the plugin or team that owns this object.

spaces string[] · max items: 100

The IDs of the spaces where the data view is available.

updated_at string

Timestamp when the object was last updated (ISO 8601).

updated_by string

User profile ID of the user who last updated the object.

version string

Internal version identifier for optimistic concurrency control.

created

application/json
data object required

Defines an stored data source with a mandatory index pattern and optional settings like id, name, show hidden indices and field settings.

allow_hidden_indices boolean

When true, allows the data view to match hidden indices.

field_filters string[] · max items: 10000

Field filters can be used to exclude one or more fields when fetching a document. They may contain wildcards, such as user* which filters fields starting with 'user'.

field_settings map string to anyOf

Settings for individual fields, keyed by field name. To change how Kibana displays a field from the backing indices, set its label, description, format, or popularity. To define a runtime field, use the runtime field name and set type.

id string · min length: 1 · max length: 256

Kibana provides a unique identifier for each data view, or you can create your own.

index_pattern string · min length: 1 required

The index pattern (Elasticsearch index expression) to use as the data source. Example: "my-index-*".

name string · min length: 1 · max length: 256

The name of the data view. Example: "Sample data view".

time_field string

The name of the time field in the index. Used for time-based filtering. Example: "@timestamp".

id string · max length: 1000 required

The ID of the data view.

meta object required

Metadata about the data view.

created_at string

Timestamp when the object was created (ISO 8601).

created_by string

User profile ID of the user who created the object.

managed boolean

When true, the object is managed by Kibana and cannot be edited by users.

owner string

Identifier of the plugin or team that owns this object.

spaces string[] · max items: 100

The IDs of the spaces where the data view is available.

updated_at string

Timestamp when the object was last updated (ISO 8601).

updated_by string

User profile ID of the user who last updated the object.

version string

Internal version identifier for optimistic concurrency control.

400

invalid request

403

forbidden

409

conflict

Base URL
https://{kibana_url}