Update data view fields metadata

Base URL: https://{kibana_url}

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

Auth

Update fields presentation metadata such as count, customLabel, customDescription, and format.

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

fields object required: The field object.

Responses

Indicates a successful call.

application/json

acknowledged boolean

Bad request

application/json

error string required
message string required
statusCode number required

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/fields
{
  "fields": {
    "field1": {
      "count": 123,
      "customLabel": "Field 1 label"
    },
    "field2": {
      "customDescription": "Field 2 description",
      "customLabel": "Field 2 label"
    }
  }
}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "acknowledged": false
}

Generated from the API spec

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

Generated from the API spec

Path parameters

Header parameters

Request body { }

Responses

Request body