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}

Auth

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.
viewId string required: An identifier for the data view.; Example: ff959d40-b880-11e8-a6d9-e546fe2bba5f

Header parameters

kbn-xsrf string required: Cross-site request forgery protection

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

View as Markdown

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

{
  "data_view": {
    "allowNoIndex": false,
    "fieldAttrs": {
      "key": {
        "count": 0,
        "customDescription": "string",
        "customLabel": "string"
      }
    },
    "fieldFormats": {},
    "fields": {},
    "id": "ff959d40-b880-11e8-a6d9-e546fe2bba5f",
    "name": "string",
    "namespaces": [
      "default"
    ],
    "runtimeFieldMap": {
      "key": {
        "script": {
          "source": "string"
        },
        "type": "string"
      }
    },
    "sourceFilters": [
      {
        "value": "string"
      }
    ],
    "timeFieldName": "string",
    "title": "string",
    "typeMeta": {
      "aggs": {},
      "params": {}
    },
    "version": "WzQ2LDJd"
  }
}

Generated from the API spec

{
  "error": "Bad Request",
  "message": "string",
  "statusCode": 400
}

Generated from the API spec