Update field metadata

Server: https://{kibana_url}

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

Refer to Spaces for more information.

Update field metadata for a data view. Use this endpoint to set custom labels, custom descriptions, and format overrides for individual fields.

Path Parameters

viewId string required: An identifier for the data view.

Request

fields object required: The field object.

Responses

Indicates a successful call.

application/json

Bad request

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/data_views/data_view/{viewId}/fields
{"fields":{"field_name":{"customLabel":"My custom label"}}}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/data_views/data_view/${DATA_VIEW_ID}/fields" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{"fields":{"field_name":{"customLabel":"My custom label"}}}'

Response

{
  "error": "Bad Request",
  "message": "[request body.data_view.title]: expected value of type [string] but got [undefined]",
  "statusCode": 400
}

Update the popularity count, custom label, and custom description for specific fields in a data view.

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/data_views/data_view/{viewId}/fields
{
  "fields": {
    "field1": {
      "count": 123,
      "customLabel": "Field 1 label"
    },
    "field2": {
      "customDescription": "Field 2 description",
      "customLabel": "Field 2 label"
    }
  }
}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/data_views/data_view/{viewId}/fields" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "fields": {
    "field1": {
      "count": 123,
      "customLabel": "Field 1 label"
    },
    "field2": {
      "customDescription": "Field 2 description",
      "customLabel": "Field 2 label"
    }
  }
}'

Response

{
  "acknowledged": true
}

{
  "error": "Bad Request",
  "message": "[request body.data_view.title]: expected value of type [string] but got [undefined]",
  "statusCode": 400
}