Update a data view

Base URL: https://{kibana_url}

POST /api/data_views/data_view/{viewId}
POST /s/{space_id}/api/data_views/data_view/{viewId}

Refer to Spaces for more information.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

data_view object required: The data view properties you want to update. Only the specified properties are updated in the data view. Unspecified fields stay as they are persisted.
refresh_fields boolean · default: false: Reloads the data view fields after the data view is updated.

Responses

Indicates a successful call.

application/json

data_view object

Bad request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/data_views/data_view/ff959d40-b880-11e8-a6d9-e546fe2bba5f
{
  "data_view": {
    "allowNoIndex": false,
    "name": "Kibana Sample Data eCommerce",
    "timeFieldName": "order_date",
    "title": "kibana_sample_data_ecommerce"
  },
  "refresh_fields": true
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/data_views/data_view/ff959d40-b880-11e8-a6d9-e546fe2bba5f" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "data_view": {
      "allowNoIndex": false,
      "name": "Kibana Sample Data eCommerce",
      "timeFieldName": "order_date",
      "title": "kibana_sample_data_ecommerce"
    },
    "refresh_fields": true
  }'

Generated from the API spec

Response

No example

Authentication

Path parameters

Header parameters

Request body { }

Responses

Request body