New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create index pattern API Delete index pattern API »
Elastic Docs ›Kibana Guide [7.13] ›REST API ›Index patterns APIs

Update index pattern API

edit

Update index pattern API

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Update part of an index pattern. Only the specified fields are updated in the index pattern. Unspecified fields stay as they are persisted.

Request

edit

POST <kibana host>:<port>/api/index_patterns/index_pattern/<id>

POST <kibana host>:<port>/s/<space_id>/api/index_patterns/index_pattern/<id>

Path parameters

edit
space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.
id
(Required, string) The ID of the index pattern you want to update.

Request body

edit
refresh_fields
(Optional, boolean) Reloads the index pattern fields after the index pattern is updated. The default is false.
index_pattern

(Required, object) The index patterns fields you want to update.

You can partially update the following fields:

  • title
  • timeFieldName
  • fields
  • sourceFilters
  • fieldFormatMap
  • type
  • typeMeta

Response code

edit
200
Indicates a successful call.

Examples

edit

Update a title of the <my-pattern> index pattern:

$ curl -X POST api/index_patterns/index-pattern/my-pattern
{
  "index_pattern": {
    "title": "some-other-pattern-*"
  }
}
Copy as curl 

Customize the update behavior:

$ curl -X POST api/index_patterns/index-pattern/my-pattern
{
  "refresh_fields": true,
  "index_pattern": {
    "fields": {}
  }
}
Copy as curl 

All update fields are optional, but you can specify the following fields:

$ curl -X POST api/index_patterns/index-pattern/my-pattern
{
  "index_pattern": {
    "title": "...",
    "timeFieldName": "...",
    "sourceFilters": [],
    "fieldFormats": {},
    "type": "...",
    "typeMeta": {},
    "fields": {}
  }
}
Copy as curl 

The API returns the updated index pattern object:

{
    "index_pattern": {

    }
}
« Create index pattern API Delete index pattern API »

On this page

Was this helpful?
Feedback