|
@@ -3,15 +3,17 @@
|
|
|
[[info-api]]
|
|
|
== Info API
|
|
|
|
|
|
-The info API provides general information about the installed {xpack} features.
|
|
|
+Provides general information about the installed {xpack} features.
|
|
|
|
|
|
-[float]
|
|
|
-=== Request
|
|
|
+[discrete]
|
|
|
+[[info-api-request]]
|
|
|
+=== {api-request-title}
|
|
|
|
|
|
`GET /_xpack`
|
|
|
|
|
|
-[float]
|
|
|
-=== Description
|
|
|
+[discrete]
|
|
|
+[[info-api-desc]]
|
|
|
+=== {api-description-title}
|
|
|
|
|
|
The information provided by this API includes:
|
|
|
|
|
@@ -20,24 +22,22 @@ The information provided by this API includes:
|
|
|
* Features Information - The features that are currently enabled and available
|
|
|
under the current license.
|
|
|
|
|
|
-[float]
|
|
|
-=== Path Parameters
|
|
|
+[discrete]
|
|
|
+[[info-api-path-params]]
|
|
|
+=== {api-path-parms-title}
|
|
|
|
|
|
`categories`::
|
|
|
- (list) A comma-separated list of the information categories to include in the
|
|
|
- response. For example, `build,license,features`.
|
|
|
+ (Optional, list) A comma-separated list of the information categories to
|
|
|
+ include in the response. For example, `build,license,features`.
|
|
|
|
|
|
`human`::
|
|
|
- (boolean) Defines whether additional human-readable information is included in
|
|
|
- the response. In particular, it adds descriptions and a tag line. The
|
|
|
- default value is `true`.
|
|
|
+ (Optional, boolean) Defines whether additional human-readable information is
|
|
|
+ included in the response. In particular, it adds descriptions and a tag line.
|
|
|
+ The default value is `true`.
|
|
|
|
|
|
-//=== Query Parameters
|
|
|
-
|
|
|
-//=== Authorization
|
|
|
-
|
|
|
-[float]
|
|
|
-=== Examples
|
|
|
+[discrete]
|
|
|
+[[info-api--example]]
|
|
|
+=== {api-examples-title}
|
|
|
|
|
|
The following example queries the info API:
|
|
|
|