1
1
[[search-field-caps]]
2
- === Field Capabilities API
2
+ === Field capabilities API
3
+ ++++
4
+ <titleabbrev>Field capabilities</titleabbrev>
5
+ ++++
6
+
3
7
4
8
Allows you to retrieve the capabilities of fields among multiple indices.
5
9
For data streams, the API returns field capabilities among the stream's backing
@@ -14,13 +18,13 @@ GET /_field_caps?fields=rating
14
18
[[search-field-caps-api-request]]
15
19
==== {api-request-title}
16
20
17
- `GET /_field_caps`
21
+ `GET /_field_caps?fields=<fields> `
18
22
19
- `POST /_field_caps`
23
+ `POST /_field_caps?fields=<fields> `
20
24
21
- `GET /<target>/_field_caps`
25
+ `GET /<target>/_field_caps?fields=<fields> `
22
26
23
- `POST /<target>/_field_caps`
27
+ `POST /<target>/_field_caps?fields=<fields> `
24
28
25
29
26
30
[[search-field-caps-api-desc]]
@@ -46,6 +50,11 @@ To target all data streams and indices in a cluster, omit this parameter or use
46
50
[[search-field-caps-api-query-params]]
47
51
==== {api-query-parms-title}
48
52
53
+ `fields`::
54
+ (Required, string)
55
+ Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`)
56
+ expressions are supported.
57
+
49
58
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
50
59
+
51
60
Defaults to `true`.
@@ -56,8 +65,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
56
65
Defaults to `open`.
57
66
--
58
67
59
- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields]
60
-
61
68
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
62
69
63
70
`include_unmapped`::
0 commit comments