mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
Backport API template changes to 7.4 (#45201)
This commit is contained in:
Kaarina Tungseth
GitHub
parent
872c953f5d
commit
e904d6d414
43 changed files with 1071 additions and 962 deletions
|
|
@ -3,28 +3,27 @@
|
|||
|
||||
[partintro]
|
||||
--
|
||||
Some of the features of Kibana are provided via a REST API, which is ideal for
|
||||
people that want to create an integration with Kibana or that want to automate
|
||||
certain aspects of configuring and deploying Kibana.
|
||||
Some {kib} features are provided via a REST API, which is ideal for creating an integration with {kib}, or automating
|
||||
certain aspects of configuring and deploying {kib}.
|
||||
|
||||
Each API in this documentation should be clearly marked as either `stable`,
|
||||
`beta`, or `experimental`. If an API is not marked, it should be considered
|
||||
`experimental`.
|
||||
|
||||
What do these labels mean?
|
||||
Each API has one of the following labels:
|
||||
|
||||
* *Stable* APIs should be safe to use extensively in production. Any breaking
|
||||
changes to these APIs should only occur in major versions and will be
|
||||
clearly documented in the breaking changes documentation for that release.
|
||||
* *Beta* APIs are on track to become stable, permanent features of Kibana.
|
||||
|
||||
* *Beta* APIs are on track to become stable, permanent features of {kib}.
|
||||
Caution should be exercised in their use since it is possible we'd have to make
|
||||
a breaking change to these APIs in a minor version, but we'll avoid this
|
||||
wherever possible.
|
||||
|
||||
* *Experimental* APIs are just that - an experiment. An experimental API might
|
||||
have breaking changes in any version of Kibana, or it might even be removed
|
||||
have breaking changes in any version of {kib}, or it might even be removed
|
||||
entirely.
|
||||
|
||||
NOTE: You cannot access these APIs via the Console in Kibana.
|
||||
If a label is missing from an API, it is considered `experimental`.
|
||||
|
||||
NOTE: You cannot access the APIs via the Console in {kib}.
|
||||
|
||||
[float]
|
||||
== APIs
|
||||
|
|
|
|||
|
|
@ -1,19 +1,14 @@
|
|||
[[dashboard-import-api]]
|
||||
== Dashboard Import API
|
||||
== Dashboard import and export APIs
|
||||
|
||||
The dashboard import/export APIs allow people to import dashboards along with
|
||||
all of their corresponding saved objects such as visualizations, saved
|
||||
Import and export dashboards with the corresponding saved objects, such as visualizations, saved
|
||||
searches, and index patterns.
|
||||
|
||||
Traditionally, developers would perform this level of integration by writing
|
||||
documents directly to the `.kibana` index. *Do not do this!* Writing directly
|
||||
to the `.kibana` index is not safe and it _will_ result in corrupted data that
|
||||
permanently breaks Kibana in a future version.
|
||||
WARNING: Do not write documents directly to the `.kibana` index. When you write directly
|
||||
to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<dashboard-import-api-import>>
|
||||
* <<dashboard-import-api-export>>
|
||||
* <<dashboard-import-api-import, Import dashboard API>>
|
||||
* <<dashboard-api-export, Export dashboard API>>
|
||||
|
||||
include::dashboard-import/import.asciidoc[]
|
||||
include::dashboard-import/export.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,40 +1,44 @@
|
|||
[[dashboard-import-api-export]]
|
||||
=== Export Dashboard
|
||||
[[dashboard-api-export]]
|
||||
=== Export dashboard API
|
||||
++++
|
||||
<titleabbrev>Dashboard export</titleabbrev>
|
||||
++++
|
||||
|
||||
Export dashboards and corresponding saved objects.
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
The dashboard export API allows people to export dashboards along with all of
|
||||
their corresponding saved objects such as visualizations, saved searches, and
|
||||
index patterns.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[[dashboard-api-export-request]]
|
||||
==== Request
|
||||
|
||||
`GET /api/kibana/dashboards/export`
|
||||
|
||||
==== Query Parameters
|
||||
[[dashboard-api-export-params]]
|
||||
==== Query parameters
|
||||
|
||||
`dashboard` (required)::
|
||||
(array|string) The id(s) of the dashboard(s) to export
|
||||
`dashboard`::
|
||||
(Required, array|string) The IDs of the dashboards that you want to export.
|
||||
|
||||
[[dashboard-api-export-response-body]]
|
||||
==== Response body
|
||||
|
||||
The response body will have a top level `objects` property that contains an
|
||||
array of saved objects. The order of these objects is not guaranteed. You
|
||||
should use this exact response body as the request body for the corresponding
|
||||
<<dashboard-import-api-import, Import Dashboard API>>.
|
||||
`objects`::
|
||||
(array) A top level property that includes the saved objects. The order of the objects is not guaranteed. Use the exact response body as the request body for the corresponding <<dashboard-import-api-import, Import dashboard API>>.
|
||||
|
||||
[[dashboard-api-export-codes]]
|
||||
==== Response code
|
||||
|
||||
==== Examples
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
The following example exports all saved objects associated with and including
|
||||
the dashboard with id `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c`.
|
||||
[float]
|
||||
[[dashboard-api-export-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c
|
||||
GET api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c <1>
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` along with the exported
|
||||
objects as the response body.
|
||||
<1> In this example, `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c` is the dashboard ID.
|
||||
|
|
|
|||
|
|
@ -1,41 +1,46 @@
|
|||
[[dashboard-import-api-import]]
|
||||
=== Import Dashboard
|
||||
=== Import dashboard API
|
||||
++++
|
||||
<titleabbrev>Import dashboard</titleabbrev>
|
||||
++++
|
||||
|
||||
Import dashboards and corresponding saved objects.
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
The dashboard import API allows people to import dashboards along with all of
|
||||
their corresponding saved objects such as visualizations, saved searches, and
|
||||
index patterns.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[[dashboard-api-import-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/kibana/dashboards/import`
|
||||
|
||||
==== Query Parameters
|
||||
[[dashboard-api-import-params]]
|
||||
==== Query parameters
|
||||
|
||||
`force` (optional)::
|
||||
(boolean) Overwrite any existing objects on id conflict
|
||||
`exclude` (optional)::
|
||||
(array) Saved object types that should not be imported
|
||||
`force`::
|
||||
(Optional, boolean) Overwrite any existing objects on ID conflict.
|
||||
|
||||
`exclude`::
|
||||
(Optional, array) Saved object types that you want to exclude from the import.
|
||||
|
||||
==== Request Body
|
||||
[[dashboard-api-import-request-body]]
|
||||
==== Request body
|
||||
|
||||
The request body is JSON, but you should not manually construct a payload to
|
||||
this endpoint. Instead, use the complete response body from the
|
||||
<<dashboard-import-api-export, Export Dashboard API>> as the request body to
|
||||
this import API.
|
||||
Use the complete response body from the <<dashboard-api-export, Export dashboard API>> as the request body. Do not manually construct a payload to the endpoint.
|
||||
|
||||
[[dashboard-api-import-response-body]]
|
||||
==== Response body
|
||||
|
||||
The response body will have a top level `objects` property that contains an
|
||||
array of the saved objects that were created.
|
||||
`objects`::
|
||||
(array) A top level property that includes the saved objects.
|
||||
|
||||
==== Examples
|
||||
[[dashboard-api-import-codes]]
|
||||
==== Response code
|
||||
|
||||
The following example imports saved objects associated with and including the
|
||||
dashboard with id `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c`.
|
||||
`200`::
|
||||
Indicates a successful call, even if there are errors importing individual saved objects. If there ar errors, the error information is returned in the response body on an object-by-object basis.
|
||||
|
||||
[[dashboard-api-import-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -92,7 +97,3 @@ POST api/kibana/dashboards/import?exclude=index-pattern
|
|||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A response code of `200` will be returned even if there are errors importing
|
||||
individual saved objects. In that case, error information will be returned in
|
||||
the response body on an object-by-object basis.
|
||||
|
|
|
|||
|
|
@ -2,12 +2,8 @@
|
|||
[[features-api]]
|
||||
== Features API
|
||||
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release.]
|
||||
View information about the available features in {kib}. Features are used by spaces and security to refine and secure access to {kib}.
|
||||
|
||||
The features API allows you to view information about available features in {kib}. Features are used by spaces and security to refine and secure access to {kib}.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in {kib}.
|
||||
|
||||
* <<features-api-get>>
|
||||
* <<features-api-get, Get features API>>
|
||||
|
||||
include::features/get.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,29 +1,28 @@
|
|||
[[features-api-get]]
|
||||
=== Get Features
|
||||
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release.]
|
||||
=== Get features API
|
||||
++++
|
||||
<titleabbrev>Get features</titleabbrev>
|
||||
++++
|
||||
|
||||
Retrieves all {kib} features.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in {kib}.
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
==== Get all {kib} features
|
||||
[[features-api-get-request]]
|
||||
==== Request
|
||||
|
||||
===== Request
|
||||
`GET /api/features/v1`
|
||||
|
||||
To retrieve all features, issue a GET request to the
|
||||
/api/features/v1 endpoint.
|
||||
[[features-api-get-codes]]
|
||||
==== Response code
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /api/features/v1
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
===== Response
|
||||
[[features-api-get-example]]
|
||||
==== Example
|
||||
|
||||
A successful call returns a response code of `200` and a response body containing a JSON
|
||||
representation of the features.
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,20 +1,15 @@
|
|||
[role="xpack"]
|
||||
[[logstash-configuration-management-api]]
|
||||
== Logstash Configuration Management API
|
||||
== Logstash configuration management APIs
|
||||
|
||||
The Logstash configuration management API allows users to programmatically integrate with the
|
||||
Logstash configuration management feature.
|
||||
Programmatically integrate with the Logstash configuration management feature.
|
||||
|
||||
Traditionally users would perform this integration by accessing the the `.logstash` index
|
||||
directly. *Do not do this!* The structure of this index is subject to change, which could
|
||||
cause your integration to break. Instead, use the following API.
|
||||
WARNING: Do not directly access the `.logstash` index. The structure of the `.logstash` index is subject to change, which could cause your integration to break. Instead, use the Logstash configuration management APIs.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<logstash-configuration-management-api-create>>
|
||||
* <<logstash-configuration-management-api-retrieve>>
|
||||
* <<logstash-configuration-management-api-delete>>
|
||||
* <<logstash-configuration-management-api-list>>
|
||||
* <<logstash-configuration-management-api-create, Create Logstash pipeline API>>
|
||||
* <<logstash-configuration-management-api-retrieve, Retrieve pipeline API>>
|
||||
* <<logstash-configuration-management-api-delete, Delete Logstash pipeline API>>
|
||||
* <<logstash-configuration-management-api-list, List Logstash pipeline API>>
|
||||
|
||||
include::logstash-configuration-management/create.asciidoc[]
|
||||
include::logstash-configuration-management/retrieve.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,41 +1,46 @@
|
|||
[role="xpack"]
|
||||
[[logstash-configuration-management-api-create]]
|
||||
=== Create Pipeline
|
||||
=== Create Logstash pipeline API
|
||||
++++
|
||||
<titleabbrev>Create pipeline</titleabbrev>
|
||||
++++
|
||||
|
||||
Create a centrally-managed Logstash pipeline, or update an existing pipeline.
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
The Create Pipeline API enables you to create a centrally-managed Logstash pipeline. You can also use
|
||||
it to update an existing pipeline.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[float]
|
||||
[[logstash-configuration-management-api-create-request]]
|
||||
==== Request
|
||||
|
||||
`PUT /api/logstash/pipeline/<id>`
|
||||
|
||||
[float]
|
||||
==== Path Parameters
|
||||
[[logstash-configuration-management-api-create-params]]
|
||||
==== Path parameters
|
||||
|
||||
`id` (required)::
|
||||
(string) ID for pipeline. Only alphanumeric characters, hyphens, and underscores may be used.
|
||||
`id`::
|
||||
(Required, string) The pipeline ID. Only alphanumeric characters, hyphens, and underscores are supported.
|
||||
|
||||
[[logstash-configuration-management-api-create-request-body]]
|
||||
==== Request body
|
||||
|
||||
`description`::
|
||||
(Optional, string) The pipeline description.
|
||||
|
||||
`pipeline`::
|
||||
(Required, string) The pipeline definition.
|
||||
|
||||
`settings`::
|
||||
(Optional, object) The pipeline settings. Supported settings, represented as object keys, are `pipeline.workers`, `pipeline.batch.size`, `pipeline.batch.delay`, `queue.type`, `queue.max_bytes`, and `queue.checkpoint.writes`.
|
||||
|
||||
[[logstash-configuration-management-api-create-codes]]
|
||||
==== Response code
|
||||
|
||||
`204 No Content`::
|
||||
Indicates a successful call.
|
||||
|
||||
[float]
|
||||
==== Request Body
|
||||
|
||||
`description` (optional)::
|
||||
(string) Description for the pipeline
|
||||
|
||||
`pipeline` (required)::
|
||||
(string) Pipeline definition
|
||||
|
||||
`settings` (optional)::
|
||||
(object) Pipeline settings. Supported settings, represented as object keys, are `pipeline.workers`, `pipeline.batch.size`, `pipeline.batch.delay`, `queue.type`, `queue.max_bytes`, and `queue.checkpoint.writes`
|
||||
|
||||
|
||||
[float]
|
||||
==== Examples
|
||||
[[logstash-configuration-management-api-create-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -48,5 +53,3 @@ PUT api/logstash/pipeline/hello-world
|
|||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns an HTTP `204 No Content` response.
|
||||
|
|
|
|||
|
|
@ -1,32 +1,36 @@
|
|||
[role="xpack"]
|
||||
[[logstash-configuration-management-api-delete]]
|
||||
=== Delete Pipeline
|
||||
=== Delete Logstash pipeline API
|
||||
++++
|
||||
<titleabbrev>Delete pipeline</titleabbrev>
|
||||
++++
|
||||
|
||||
Delete a centrally-managed Logstash pipeline.
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
The Delete Pipeline API enables you to delete a centrally-managed Logstash pipeline.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[float]
|
||||
[[logstash-configuration-management-api-delete-request]]
|
||||
==== Request
|
||||
|
||||
`DELETE /api/logstash/pipeline/<id>`
|
||||
|
||||
[float]
|
||||
==== Path Parameters
|
||||
[[logstash-configuration-management-api-delete-params]]
|
||||
==== Path parameters
|
||||
|
||||
`id` (required)::
|
||||
(string) ID for pipeline.
|
||||
`id`::
|
||||
(Required, string) The pipeline ID.
|
||||
|
||||
[[logstash-configuration-management-api-delete-codes]]
|
||||
==== Response code
|
||||
|
||||
[float]
|
||||
==== Examples
|
||||
`204 No Content`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[logstash-configuration-management-api-delete-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
DELETE api/logstash/pipeline/hello-world
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns an HTTP `204 No Content` response.
|
||||
// KIBANA
|
||||
|
|
@ -1,28 +1,23 @@
|
|||
[role="xpack"]
|
||||
[[logstash-configuration-management-api-list]]
|
||||
=== List Pipelines
|
||||
=== List Logstash pipeline API
|
||||
++++
|
||||
<titleabbrev>List pipeline</titleabbrev>
|
||||
++++
|
||||
|
||||
List all centrally-managed Logstash pipelines.
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
The List Pipelines API enables you to list all centrally-managed Logstash pipelines.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[float]
|
||||
[[logstash-configuration-management-api-list-request]]
|
||||
==== Request
|
||||
|
||||
`GET /api/logstash/pipelines`
|
||||
|
||||
[float]
|
||||
==== Examples
|
||||
[[logstash-configuration-management-api-list-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET api/logstash/pipelines
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -43,4 +38,4 @@ A successful call returns a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
<1> The username property may or may not be present, depending on whether Elastic Security was enabled when the pipeline was created or last updated.
|
||||
<1> The `username` property may or may not be present, depending on if security was enabled when the pipeline was created or last updated.
|
||||
|
|
|
|||
|
|
@ -1,34 +1,29 @@
|
|||
[role="xpack"]
|
||||
[[logstash-configuration-management-api-retrieve]]
|
||||
=== Retrieve Pipeline
|
||||
=== Retrieve pipeline API
|
||||
++++
|
||||
<titleabbrev>Retrieve pipeline</titleabbrev>
|
||||
++++
|
||||
|
||||
Retrieves a centrally-managed Logstash pipeline.
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
The Retrieve Pipeline API enables you to retrieve a centrally-managed Logstash pipeline.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[float]
|
||||
[[logstash-configuration-management-api-retrieve-request]]
|
||||
==== Request
|
||||
|
||||
`GET /api/logstash/pipeline/<id>`
|
||||
|
||||
[float]
|
||||
==== Path Parameters
|
||||
[[logstash-configuration-management-api-retrieve-path-params]]
|
||||
==== Path parameters
|
||||
|
||||
`id` (required)::
|
||||
(string) ID for pipeline.
|
||||
`id`::
|
||||
(Required, string) The pipeline ID.
|
||||
|
||||
[[logstash-configuration-management-api-retrieve-example]]
|
||||
==== Example
|
||||
|
||||
[float]
|
||||
==== Examples
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET api/logstash/pipeline/hello-world
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,20 +1,17 @@
|
|||
[role="xpack"]
|
||||
[[role-management-api]]
|
||||
== Kibana Role Management API
|
||||
== Kibana role management APIs
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
|
||||
Manage the roles that grant <<kibana-privileges, Kibana privileges>>.
|
||||
|
||||
The role management API allows people to manage roles that grant <<kibana-privileges>>.
|
||||
It is *not* supported to do so using the
|
||||
{ref}/security-api.html#security-role-apis[{es} role management APIs], and doing
|
||||
so will likely cause {kib}'s authorization to behave unexpectedly.
|
||||
WARNING: Do not use the {ref}/security-api.html#security-role-apis[{es} role management APIs] to manage {kib} roles.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<role-management-api-put>>
|
||||
* <<role-management-api-get>>
|
||||
* <<role-management-api-delete>>
|
||||
* <<role-management-api-put, Create or update role API>>
|
||||
* <<role-management-api-get, Get all {kib} roles API>>
|
||||
* <<role-management-specific-api-get, Get specific role API>>
|
||||
* <<role-management-api-delete, Delete role API>>
|
||||
|
||||
include::role-management/put.asciidoc[]
|
||||
include::role-management/get.asciidoc[]
|
||||
include::role-management/get-all.asciidoc[]
|
||||
include::role-management/delete.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,26 +1,29 @@
|
|||
[[role-management-api-delete]]
|
||||
=== Delete role
|
||||
=== Delete role API
|
||||
++++
|
||||
<titleabbrev>Delete role</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."]
|
||||
Deletes a {kib} role.
|
||||
|
||||
NOTE: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
|
||||
|
||||
==== Authorization
|
||||
[[role-management-api-delete-prereqs]]
|
||||
==== Prerequisite
|
||||
|
||||
To use this API, you must have at least the `manage_security` cluster privilege.
|
||||
To use the delete role API, you must have the `manage_security` cluster privilege.
|
||||
|
||||
[[role-management-api-delete-request-body]]
|
||||
==== Request
|
||||
|
||||
To delete a role, submit a DELETE request to the `/api/security/role/<rolename>`
|
||||
endpoint:
|
||||
`DELETE /api/security/role/my_admin_role`
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
DELETE /api/security/role/my_admin_role
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
[[role-management-api-delete-response-codes]]
|
||||
==== Response codes
|
||||
|
||||
==== Response
|
||||
|
||||
If the role is successfully deleted, the response code is `204`; otherwise, the response
|
||||
code is 404.
|
||||
`204`::
|
||||
Indicates a successful call.
|
||||
|
||||
`404`::
|
||||
Indicates an unsuccessful call.
|
||||
|
||||
80
docs/api/role-management/get-all.asciidoc
Normal file
80
docs/api/role-management/get-all.asciidoc
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
[[role-management-api-get]]
|
||||
=== Get all {kib} roles API
|
||||
++++
|
||||
<titleabbrev>Get all roles</titleabbrev>
|
||||
++++
|
||||
|
||||
Retrieves all {kib} roles.
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
|
||||
|
||||
[[role-management-api-get-prereqs]]
|
||||
==== Prerequisite
|
||||
|
||||
To use the get role API, you must have the `manage_security` cluster privilege.
|
||||
|
||||
[[role-management-api-retrieve-all-request-body]]
|
||||
==== Request
|
||||
|
||||
`GET /api/security/role`
|
||||
|
||||
[[role-management-api-retrieve-all-response-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[role-management-api-retrieve-all-example]]
|
||||
==== Example
|
||||
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
[
|
||||
{
|
||||
"name": "my_kibana_role",
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
},
|
||||
"transient_metadata": {
|
||||
"enabled": true
|
||||
},
|
||||
"elasticsearch": {
|
||||
"indices": [ ],
|
||||
"cluster": [ ],
|
||||
"run_as": [ ]
|
||||
},
|
||||
"kibana": [{
|
||||
"base": [
|
||||
"all"
|
||||
],
|
||||
"feature": {},
|
||||
"spaces": [
|
||||
"*"
|
||||
]
|
||||
}]
|
||||
},
|
||||
{
|
||||
"name": "my_admin_role",
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
},
|
||||
"transient_metadata": {
|
||||
"enabled": true
|
||||
},
|
||||
"elasticsearch": {
|
||||
"cluster" : [ "all" ],
|
||||
"indices" : [ {
|
||||
"names" : [ "index1", "index2" ],
|
||||
"privileges" : [ "all" ],
|
||||
"field_security" : {
|
||||
"grant" : [ "title", "body" ]
|
||||
},
|
||||
"query" : "{\"match\": {\"title\": \"foo\"}}"
|
||||
} ],
|
||||
},
|
||||
"kibana": [ ]
|
||||
}
|
||||
]
|
||||
--------------------------------------------------
|
||||
|
|
@ -1,101 +1,33 @@
|
|||
[[role-management-api-get]]
|
||||
=== Get Role
|
||||
[[role-management-specific-api-get]]
|
||||
=== Get specific role API
|
||||
++++
|
||||
<titleabbrev>Get specific role</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."]
|
||||
Retrieves a specific role.
|
||||
|
||||
Retrieves all {kib} roles, or a specific role.
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
|
||||
|
||||
NOTE: You cannot access this endpoint via the Console in Kibana.
|
||||
[[role-management-specific-api-get-prereqs]]
|
||||
==== Prerequisite
|
||||
|
||||
==== Authorization
|
||||
|
||||
To use this API, you must have at least the `manage_security` cluster privilege.
|
||||
|
||||
==== Get all {kib} roles
|
||||
To use the get specific role API, you must have the `manage_security` cluster privilege.
|
||||
|
||||
[[role-management-specific-api-retrieve-all-request-body]]
|
||||
===== Request
|
||||
|
||||
To retrieve all roles, issue a GET request to the
|
||||
/api/security/role endpoint.
|
||||
`GET /api/security/role/my_restricted_kibana_role`
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /api/security/role
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
[[role-management-specific-api-retrieve-all-response-codes]]
|
||||
==== Response code
|
||||
|
||||
===== Response
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[role-management-specific-api-retrieve-all-example]]
|
||||
===== Example
|
||||
|
||||
A successful call returns a response code of `200` and a response body containing a JSON
|
||||
representation of the roles.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
[
|
||||
{
|
||||
"name": "my_kibana_role",
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
},
|
||||
"transient_metadata": {
|
||||
"enabled": true
|
||||
},
|
||||
"elasticsearch": {
|
||||
"indices": [ ],
|
||||
"cluster": [ ],
|
||||
"run_as": [ ]
|
||||
},
|
||||
"kibana": [{
|
||||
"base": [
|
||||
"all"
|
||||
],
|
||||
"feature": {},
|
||||
"spaces": [
|
||||
"*"
|
||||
]
|
||||
}]
|
||||
},
|
||||
{
|
||||
"name": "my_admin_role",
|
||||
"metadata" : {
|
||||
"version" : 1
|
||||
},
|
||||
"transient_metadata": {
|
||||
"enabled": true
|
||||
},
|
||||
"elasticsearch": {
|
||||
"cluster" : [ "all" ],
|
||||
"indices" : [ {
|
||||
"names" : [ "index1", "index2" ],
|
||||
"privileges" : [ "all" ],
|
||||
"field_security" : {
|
||||
"grant" : [ "title", "body" ]
|
||||
},
|
||||
"query" : "{\"match\": {\"title\": \"foo\"}}"
|
||||
} ],
|
||||
},
|
||||
"kibana": [ ]
|
||||
}
|
||||
]
|
||||
--------------------------------------------------
|
||||
|
||||
==== Get a specific role
|
||||
|
||||
===== Request
|
||||
|
||||
To retrieve a specific role, issue a GET request to
|
||||
the `/api/security/role/<rolename>` endpoint:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /api/security/role/my_restricted_kibana_role
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
===== Response
|
||||
|
||||
A successful call returns a response code of `200` and a response body containing a JSON
|
||||
representation of the role.
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,52 +1,60 @@
|
|||
[[role-management-api-put]]
|
||||
=== Create or Update Role
|
||||
=== Create or update role API
|
||||
++++
|
||||
<titleabbrev>Create or update role</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."]
|
||||
|
||||
Creates a new {kib} role or updates the attributes of an existing role. {kib} roles are stored in the
|
||||
Creates a new {kib} role, or updates the attributes of an existing role. {kib} roles are stored in the
|
||||
{es} native realm.
|
||||
|
||||
NOTE: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
==== Authorization
|
||||
|
||||
To use this API, you must have at least the `manage_security` cluster privilege.
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."]
|
||||
|
||||
[[role-management-api-put-request]]
|
||||
==== Request
|
||||
|
||||
To create or update a role, issue a PUT request to the
|
||||
`/api/security/role/<rolename>` endpoint.
|
||||
`PUT /api/security/role/my_kibana_role`
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
PUT /api/security/role/my_kibana_role
|
||||
--------------------------------------------------
|
||||
[[role-management-api-put-prereqs]]
|
||||
==== Prerequisite
|
||||
|
||||
==== Request Body
|
||||
To use the create or update role API, you must have the `manage_security` cluster privilege.
|
||||
|
||||
The following parameters can be specified in the body of a PUT request to add or update a role:
|
||||
[[role-management-api-response-body]]
|
||||
==== Request body
|
||||
|
||||
`metadata`:: (object) Optional meta-data. Within the `metadata` object, keys
|
||||
that begin with `_` are reserved for system usage.
|
||||
`metadata`::
|
||||
(Optional, object) In the `metadata` object, keys that begin with `_` are reserved for system usage.
|
||||
|
||||
`elasticsearch`:: (object) Optional {es} cluster and index privileges, valid keys are
|
||||
`cluster`, `indices` and `run_as`. For more information, see {xpack-ref}/defining-roles.html[Defining Roles].
|
||||
`elasticsearch`::
|
||||
(Optional, object) {es} cluster and index privileges. Valid keys include `cluster`, `indices`, and `run_as`. For more information, see {xpack-ref}/defining-roles.html[Defining Roles].
|
||||
|
||||
`kibana`:: (list) A list of objects that specifies the <<kibana-privileges>> for this role:
|
||||
`base` ::: (list) An optional base privilege. If specified, must either be `["all"]` or `["read"]`.
|
||||
The `feature` section cannot be used if a base privilege is specified here. You must use one or the other.
|
||||
"all" grants read/write access to all Kibana features for the specified spaces.
|
||||
"read" grants read-only access to all Kibana features for the specified spaces.
|
||||
`kibana`::
|
||||
(list) Objects that specify the <<kibana-privileges, Kibana privileges>> for the role:
|
||||
|
||||
`feature` ::: (object) Object containing privileges for specific features.
|
||||
The `base` section cannot be used if feature privileges are specified here. You must use one or the other.
|
||||
Use the <<features-api, Features API>> to retrieve a list of available features.
|
||||
`base` :::
|
||||
(Optional, list) A base privilege. When specified, the base must be `["all"]` or `["read"]`.
|
||||
When the `base` privilege is specified, you are unable to use the `feature` section.
|
||||
"all" grants read/write access to all {kib} features for the specified spaces.
|
||||
"read" grants read-only access to all {kib} features for the specified spaces.
|
||||
|
||||
`spaces` ::: (list) The spaces these privileges should be applied to.
|
||||
To grant access to all spaces, set this to `["*"]`, or omit the value.
|
||||
`feature` :::
|
||||
(object) Contains privileges for specific features.
|
||||
When the `feature` privileges are specified, you are unable to use the `base` section.
|
||||
To retrieve a list of available features, use the <<features-api, features API>>.
|
||||
|
||||
===== Example 1
|
||||
Granting access to various features in all spaces.
|
||||
`spaces` :::
|
||||
(list) The spaces to apply the privileges to.
|
||||
To grant access to all spaces, set to `["*"]`, or omit the value.
|
||||
|
||||
[[role-management-api-put-response-codes]]
|
||||
==== Response code
|
||||
|
||||
`204`::
|
||||
Indicates a successful call.
|
||||
|
||||
===== Examples
|
||||
|
||||
Grant access to various features in all spaces:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -115,8 +123,7 @@ PUT /api/security/role/my_kibana_role
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
===== Example 2
|
||||
Granting "dashboard only" access to only the Marketing space.
|
||||
Grant dashboard-only access to only the Marketing space:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -142,9 +149,9 @@ PUT /api/security/role/my_kibana_role
|
|||
]
|
||||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
===== Example 3
|
||||
Granting full access to all features in the Default space.
|
||||
Grant full access to all features in the Default space:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -169,9 +176,9 @@ PUT /api/security/role/my_kibana_role
|
|||
]
|
||||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
===== Example 4
|
||||
Granting different access to different spaces.
|
||||
Grant different access to different spaces:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -205,10 +212,9 @@ PUT /api/security/role/my_kibana_role
|
|||
]
|
||||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
|
||||
===== Example 5
|
||||
Granting access to both Kibana and Elasticsearch.
|
||||
Grant access to {kib} and Elasticsearch:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -240,7 +246,4 @@ PUT /api/security/role/my_kibana_role
|
|||
]
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
==== Response
|
||||
|
||||
A successful call returns a response code of `204` and no response body.
|
||||
// KIBANA
|
||||
|
|
|
|||
|
|
@ -1,26 +1,21 @@
|
|||
[[saved-objects-api]]
|
||||
== Saved Objects API
|
||||
== Saved objects APIs
|
||||
|
||||
The saved objects API allows people to manage Kibana saved objects, including
|
||||
but not limited to dashboards, visualizations, and index patterns.
|
||||
Manage {kib} saved objects, including dashboards, visualizations, index patterns, and more.
|
||||
|
||||
Traditionally, developers would perform this level of integration by writing
|
||||
documents directly to the `.kibana` index. *Do not do this!* Writing directly
|
||||
to the `.kibana` index is not safe and it _will_ result in corrupted data that
|
||||
permanently breaks Kibana in a future version.
|
||||
WARNING: Do not write documents directly to the `.kibana` index. When you write directly
|
||||
to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<saved-objects-api-get>>
|
||||
* <<saved-objects-api-bulk-get>>
|
||||
* <<saved-objects-api-find>>
|
||||
* <<saved-objects-api-create>>
|
||||
* <<saved-objects-api-bulk-create>>
|
||||
* <<saved-objects-api-update>>
|
||||
* <<saved-objects-api-delete>>
|
||||
* <<saved-objects-api-export>>
|
||||
* <<saved-objects-api-import>>
|
||||
* <<saved-objects-api-resolve-import-errors>>
|
||||
* <<saved-objects-api-get, Get object API>>
|
||||
* <<saved-objects-api-bulk-get, Bulk get objects API>>
|
||||
* <<saved-objects-api-find, Find objects API>>
|
||||
* <<saved-objects-api-create, Create saved object API>>
|
||||
* <<saved-objects-api-bulk-create, Bulk create saved objects API>>
|
||||
* <<saved-objects-api-update, Update object API>>
|
||||
* <<saved-objects-api-delete, Delete object API>>
|
||||
* <<saved-objects-api-export, Export objects API>>
|
||||
* <<saved-objects-api-import, Import objects API>>
|
||||
* <<saved-objects-api-resolve-import-errors, Resolve import errors API>>
|
||||
|
||||
include::saved-objects/get.asciidoc[]
|
||||
include::saved-objects/bulk_get.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,61 +1,60 @@
|
|||
[[saved-objects-api-bulk-create]]
|
||||
=== Bulk Create Objects
|
||||
=== Bulk create saved objects API
|
||||
++++
|
||||
<titleabbrev>Bulk create objects</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Create multiple {kib} saved objects.
|
||||
|
||||
The bulk-create saved object API enables you to persist multiple Kibana saved
|
||||
objects.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-bulk-create-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/_bulk_create`
|
||||
|
||||
[[saved-objects-api-bulk-create-query-params]]
|
||||
==== Query parameters
|
||||
|
||||
==== Query Parameters
|
||||
`overwrite`::
|
||||
(Optional, boolean) When `true`, overwrites the document with the same ID.
|
||||
|
||||
`overwrite` (optional)::
|
||||
(boolean) If true, will overwrite the document with the same ID.
|
||||
[[saved-objects-api-bulk-create-request-body]]
|
||||
==== Request body
|
||||
|
||||
`type`::
|
||||
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.
|
||||
|
||||
==== Request Body
|
||||
`id`::
|
||||
(Optional, string) Specifies an ID instead of using a randomly generated ID.
|
||||
|
||||
The request body must be a JSON array containing objects, each of which
|
||||
contains the following properties:
|
||||
`attributes`::
|
||||
(Required, object) The data that you want to create.
|
||||
|
||||
`type` (required)::
|
||||
(string) Valid options, include: `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`
|
||||
|
||||
`id` (optional)::
|
||||
(string) Enables specifying an ID to use, as opposed to one being randomly generated
|
||||
|
||||
`attributes` (required)::
|
||||
(object) The data to persist
|
||||
|
||||
`references` (optional)::
|
||||
(array) An array of objects with `name`, `id`, and `type` properties that describe the other saved objects this object references. The `name` can be used in the attributes to refer to the other saved object, but never the `id`, which may be updated automatically in the future during migrations or import/export.
|
||||
|
||||
`version` (optional)::
|
||||
(number) Enables specifying a version
|
||||
`references`::
|
||||
(Optional, array) Objects with `name`, `id`, and `type` properties that describe the other saved objects in the referenced object. To refer to the other saved object, use `name` in the attributes. Never use `id` to refer to the other saved object. `id` can be automatically updated during migrations, import, or export.
|
||||
|
||||
`version`::
|
||||
(Optional, number) Specifies the version.
|
||||
|
||||
[[saved-objects-api-bulk-create-response-body]]
|
||||
==== Response body
|
||||
|
||||
The response body will have a top level `saved_objects` property that contains
|
||||
an array of objects, which represent the response for each of the requested
|
||||
objects. The order of the objects in the response is identical to the order of
|
||||
the objects in the request.
|
||||
`saved_objects`::
|
||||
(array) Top-level property the contains objects that represent the response for each of the requested objects. The order of the objects in the response is identical to the order of the objects in the request.
|
||||
|
||||
For any saved object that could not be persisted, an error object will exist in its
|
||||
place.
|
||||
Saved objects that are unable to persist are replaced with an error object.
|
||||
|
||||
[[saved-objects-api-bulk-create-codes]]
|
||||
==== Response code
|
||||
|
||||
==== Examples
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
The following example attempts to persist an index pattern with id
|
||||
`my-pattern` and a dashboard with id `my-dashboard`, but only the index pattern
|
||||
could be persisted because there was an id collision with `my-dashboard` as a saved object with that id alread exists.
|
||||
[[saved-objects-api-bulk-create-example]]
|
||||
==== Example
|
||||
|
||||
Create an index pattern with the `my-pattern` ID, and a dashboard with the `my-dashboard` ID:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -79,8 +78,7 @@ POST api/saved_objects/_bulk_create
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -105,3 +103,5 @@ containing a JSON structure similar to the following example:
|
|||
]
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
There is already a saved object with the `my-dashboard` ID, so only the index pattern is created.
|
||||
|
|
|
|||
|
|
@ -1,46 +1,48 @@
|
|||
[[saved-objects-api-bulk-get]]
|
||||
=== Bulk Get Objects
|
||||
=== Bulk get objects API
|
||||
++++
|
||||
<titleabbrev>Bulk get objects</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Retrieves multiple {kib} saved objects by ID.
|
||||
|
||||
The bulk-get saved object API enables you to retrieve multiple Kibana saved
|
||||
objects by id.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-bulk-get-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/_bulk_get`
|
||||
|
||||
[[saved-objects-api-bulk-get-request-body]]
|
||||
==== Request Body
|
||||
|
||||
The request body must be a JSON array containing objects, each of which
|
||||
contains the following properties:
|
||||
`type`::
|
||||
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.
|
||||
|
||||
`type` (required)::
|
||||
(string) Valid options, include: `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`
|
||||
|
||||
`id` (required)::
|
||||
(string) ID of object to retrieve
|
||||
|
||||
`fields` (optional)::
|
||||
(array) The fields to return in the object's response
|
||||
`id`::
|
||||
(Required, string) ID of the retrieved object.
|
||||
|
||||
`fields`::
|
||||
(Optional, array) The fields returned in the object response.
|
||||
|
||||
[[saved-objects-api-bulk-get-response-body]]
|
||||
==== Response body
|
||||
|
||||
The response body will have a top level `saved_objects` property that contains
|
||||
an array of objects, which represent the response for each of the requested
|
||||
objects. The order of the objects in the response is identical to the order of
|
||||
the objects in the request.
|
||||
`saved_objects`::
|
||||
(array) Top-level property the contains objects that represent the response for each of the requested objects. The order of the objects in the response is identical to the order of the objects in the request.
|
||||
|
||||
For any saved object that could not be found, an error object will exist in its
|
||||
place.
|
||||
Saved objects that are unable to persist are replaced with an error object.
|
||||
|
||||
==== Examples
|
||||
[[saved-objects-api-bulk-get-body-codes]]
|
||||
==== Response code
|
||||
|
||||
The following example attempts to retrieve an index pattern with id
|
||||
`my-pattern` and a dashboard with id `my-dashboard`, but only the index pattern
|
||||
exists.
|
||||
`200`::
|
||||
Indicates a successfully call.
|
||||
|
||||
[[saved-objects-api-bulk-get-body-example]]
|
||||
==== Example
|
||||
|
||||
Retrieve an index pattern with the `my-pattern` ID, and a dashboard with the `my-dashboard` ID:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -58,8 +60,7 @@ POST api/saved_objects/_bulk_get
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -84,3 +85,5 @@ containing a JSON structure similar to the following example:
|
|||
]
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
Only the index pattern exists.
|
||||
|
|
|
|||
|
|
@ -1,45 +1,56 @@
|
|||
[[saved-objects-api-create]]
|
||||
=== Create Object
|
||||
=== Create saved object API
|
||||
++++
|
||||
<titleabbrev>Create object</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Create a {kib} saved object.
|
||||
|
||||
The create saved object API enables you to persist a Kibana saved object.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-create-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/<type>` +
|
||||
|
||||
`POST /api/saved_objects/<type>/<id>`
|
||||
|
||||
==== Path Parameters
|
||||
[[saved-objects-api-create-path-params]]
|
||||
==== Path parameters
|
||||
|
||||
`type` (required)::
|
||||
(string) Valid options, include: `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`
|
||||
`<type>`::
|
||||
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.
|
||||
|
||||
`id` (optional)::
|
||||
(string) Enables specifying an ID to use, as opposed to one being randomly generated
|
||||
`<id>`::
|
||||
(Optional, string) Specifies an ID instead of using a randomly generated ID.
|
||||
|
||||
[[saved-objects-api-create-query-params]]
|
||||
==== Query parameters
|
||||
|
||||
==== Query Parameters
|
||||
`overwrite`::
|
||||
(Optional, boolean) When true, overwrites the document with the same ID.
|
||||
|
||||
`overwrite` (optional)::
|
||||
(boolean) If true, will overwrite the document with the same ID.
|
||||
[[saved-objects-api-create-request-body]]
|
||||
==== Request body
|
||||
|
||||
`attributes`::
|
||||
(Required, object) The data that you want to create.
|
||||
+
|
||||
WARNING: When you create saved objects, attributes are not validated, which allows you to pass
|
||||
arbitrary and ill-formed data into the API that can break {kib}. Make sure
|
||||
any data that you send to the API is properly formed.
|
||||
|
||||
==== Request Body
|
||||
`references`::
|
||||
(Optional, array) Objects with `name`, `id`, and `type` properties that describe the other saved objects that this object references. Use `name` in attributes to refer to the other saved object, but never the `id`, which can update automatically during migrations or import/export.
|
||||
|
||||
`attributes` (required)::
|
||||
(object) The data to persist
|
||||
[[saved-objects-api-create-request-codes]]
|
||||
==== Response code
|
||||
|
||||
`references` (optional)::
|
||||
(array) An array of objects with `name`, `id`, and `type` properties that describe the other saved objects this object references. The `name` can be used in the attributes to refer to the other saved object, but never the `id`, which may be updated automatically in the future during migrations or import/export.
|
||||
|
||||
==== Examples
|
||||
|
||||
The following example creates an index pattern object with a pattern of
|
||||
`my-pattern-*`.
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[saved-objects-api-create-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -52,8 +63,7 @@ POST api/saved_objects/index-pattern/my-pattern
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -67,11 +77,4 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
<1> If `my-pattern` was not specified in the path, a unique ID would have been
|
||||
generated.
|
||||
|
||||
==== Known issues
|
||||
|
||||
1. *Attributes are not validated at creation time*. This means you can pass
|
||||
arbitrary and ill-formed data into this API that can break Kibana. Make sure
|
||||
any data you send to this API is properly formed.
|
||||
<1> When `my-pattern` is unspecified in the path, a unique ID is automatically generated.
|
||||
|
|
|
|||
|
|
@ -1,34 +1,41 @@
|
|||
[[saved-objects-api-delete]]
|
||||
=== Delete Object
|
||||
=== Delete object API
|
||||
++++
|
||||
<titleabbrev>Delete object</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Remove a {kib} saved object.
|
||||
|
||||
The delete saved object API permanently removes a Kibana saved object. Once a
|
||||
saved object has been deleted, _it cannot be recovered_.
|
||||
WARNING: Once you delete a saved object, _it cannot be recovered_.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-delete-request]]
|
||||
==== Request
|
||||
|
||||
`DELETE /api/saved_objects/<type>/<id>`
|
||||
|
||||
==== Path Parameters
|
||||
[[saved-objects-api-delete-path-params]]
|
||||
==== Path parameters
|
||||
|
||||
`type` (required)::
|
||||
(string) Valid options, include: `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`
|
||||
`type`::
|
||||
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.
|
||||
|
||||
`id` (required)::
|
||||
(string) Object ID being removed
|
||||
`id`::
|
||||
(Required, string) The object ID that you want to remove.
|
||||
|
||||
[[saved-objects-api-delete-response-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
==== Examples
|
||||
|
||||
The following example deletes an index pattern object with an ID of `my-pattern`
|
||||
Delete an index pattern object with the `my-pattern` ID:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
DELETE api/saved_objects/index-pattern/my-pattern
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200`.
|
||||
|
|
|
|||
|
|
@ -1,33 +1,47 @@
|
|||
[[saved-objects-api-export]]
|
||||
=== Export Objects
|
||||
=== Export objects API
|
||||
++++
|
||||
<titleabbrev>Export objects</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Retrieve a set of saved objects that you want to import into {kib}.
|
||||
|
||||
The export saved objects API enables you to retrieve a set of saved objects that can later be imported into Kibana.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-export-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/_export`
|
||||
|
||||
==== Request Body
|
||||
`type` (optional)::
|
||||
(array|string) The saved object type(s) that the export should be limited to
|
||||
`objects` (optional)::
|
||||
(array) A list of objects to export
|
||||
`includeReferencesDeep` (optional)::
|
||||
(boolean) This will make the exported objects include all the referenced objects needed
|
||||
[[saved-objects-api-export-request-request-body]]
|
||||
==== Request body
|
||||
|
||||
Note: At least `type` or `objects` must be passed in.
|
||||
`type`::
|
||||
(Optional, array|string) The saved object types to include in the export.
|
||||
|
||||
`objects`::
|
||||
(Optional, array) A list of objects to export.
|
||||
|
||||
`includeReferencesDeep`::
|
||||
(Optional, boolean) Includes all of the referenced objects in the exported objects.
|
||||
|
||||
TIP: You must include `type` or `objects` in the request body.
|
||||
|
||||
[[saved-objects-api-export-request-response-body]]
|
||||
==== Response body
|
||||
|
||||
The response body will have a format of newline delimited JSON.
|
||||
The format of the response body includes newline delimited JSON.
|
||||
|
||||
[[export-objects-api-create-request-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[ssaved-objects-api-create-example]]
|
||||
==== Examples
|
||||
|
||||
The following example exports all index pattern saved objects.
|
||||
Export all index pattern saved objects:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -38,9 +52,7 @@ POST api/saved_objects/_export
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` along with the exported objects as the response body.
|
||||
|
||||
The following example exports specific saved objects.
|
||||
Export a specific saved object:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -54,4 +66,4 @@ POST api/saved_objects/_export
|
|||
]
|
||||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
// KIBANA
|
||||
|
|
|
|||
|
|
@ -1,51 +1,60 @@
|
|||
[[saved-objects-api-find]]
|
||||
=== Find Objects
|
||||
=== Find objects API
|
||||
++++
|
||||
<titleabbrev>Find objects</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Retrieve a paginated set of {kib} saved objects by various conditions.
|
||||
|
||||
The find saved object API enables you to retrieve a paginated set of Kibana
|
||||
saved objects by various conditions.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-find-request]]
|
||||
==== Request
|
||||
|
||||
`GET /api/saved_objects/_find`
|
||||
|
||||
[[saved-objects-api-find-query-params]]
|
||||
==== Query Parameters
|
||||
`type` (required)::
|
||||
(array|string) The saved object type(s) that the response should be limited to
|
||||
`per_page` (optional)::
|
||||
(number) The number of objects to return per page
|
||||
`page` (optional)::
|
||||
(number) The page of objects to return
|
||||
`search` (optional)::
|
||||
(string) A {ref}/query-dsl-simple-query-string-query.html[simple_query_string] Elasticsearch query to filter the objects in the response
|
||||
`default_search_operator` (optional)::
|
||||
(string) The default operator to use for the `simple_query_string`
|
||||
`search_fields` (optional)::
|
||||
(array|string) The fields to perform the `simple_query_string` parsed query against
|
||||
`fields` (optional)::
|
||||
(array|string) The fields to return in the response
|
||||
`sort_field` (optional)::
|
||||
(string) The field on which the response will be sorted
|
||||
`has_reference` (optional)::
|
||||
(object) Filters to objects having a relationship with the type and id combination
|
||||
|
||||
[NOTE]
|
||||
==============================================
|
||||
`type`::
|
||||
(Required, array|string) The saved object types to include in the export.
|
||||
|
||||
`per_page`::
|
||||
(Optional, number) The number of objects to return per page.
|
||||
|
||||
`page`::
|
||||
(Optional, number) The page of objects to return.
|
||||
|
||||
`search`::
|
||||
(Optional, string) An Elasticsearch {ref}/query-dsl-simple-query-string-query.html[simple_query_string] query that filters the objects in the response.
|
||||
|
||||
`default_search_operator`::
|
||||
(Optional, string) The default operator to use for the `simple_query_string`.
|
||||
|
||||
`search_fields`::
|
||||
(Optional, array|string) The fields to perform the `simple_query_string` parsed query against.
|
||||
|
||||
`fields`::
|
||||
(Optional, array|string) The fields to return in the response.
|
||||
|
||||
`sort_field`::
|
||||
(Optional, string) The field that sorts the response.
|
||||
|
||||
`has_reference`::
|
||||
(Optional, object) Filters to objects that have a relationship with the type and ID combination.
|
||||
|
||||
As objects change in Kibana, the results on each page of this response can
|
||||
change. This makes the `find` API suitable for traditional paginated results
|
||||
but not a reliable way to safely export large amounts of data.
|
||||
NOTE: As objects change in {kib}, the results on each page of the response also
|
||||
change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.
|
||||
|
||||
==============================================
|
||||
[[saved-objects-api-find-request-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
==== Examples
|
||||
|
||||
The following example attempts to find index patterns with titles that start
|
||||
with `my`:
|
||||
Find index patterns with titles that start with `my`:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -53,8 +62,7 @@ GET api/saved_objects/_find?type=index-pattern&search_fields=title&search=my*
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -73,11 +81,7 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
[NOTE]
|
||||
.Multiple values for a parameter
|
||||
==============================================
|
||||
|
||||
For parameters that can accept multiple values (e.g. `fields`), repeat the
|
||||
For parameters that accept multiple values (e.g. `fields`), repeat the
|
||||
query parameter for each value:
|
||||
|
||||
[source,js]
|
||||
|
|
@ -86,4 +90,3 @@ GET api/saved_objects/_find?fields=id&fields=title
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
==============================================
|
||||
|
|
|
|||
|
|
@ -1,30 +1,37 @@
|
|||
[[saved-objects-api-get]]
|
||||
=== Get Object
|
||||
=== Get object API
|
||||
++++
|
||||
<titleabbrev>Get object</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Retrieve a single {kib} saved object by ID.
|
||||
|
||||
The get saved object API enables you to retrieve a single Kibana saved object
|
||||
by id.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-get-request]]
|
||||
==== Request
|
||||
|
||||
`GET /api/saved_objects/<type>/<id>`
|
||||
|
||||
==== Path Parameters
|
||||
[[saved-objects-api-get-params]]
|
||||
==== Path parameters
|
||||
|
||||
`type` (required)::
|
||||
(string) Valid options, include: `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`
|
||||
`type`::
|
||||
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.
|
||||
|
||||
`id` (required)::
|
||||
(string) ID of object to retrieve
|
||||
`id`::
|
||||
(Required, string) The ID of the object to retrieve.
|
||||
|
||||
[[saved-objects-api-get-codes]]
|
||||
==== Response code
|
||||
|
||||
==== Examples
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
The following example retrieves the index pattern object with an id of
|
||||
`my-pattern`.
|
||||
[[saved-objects-api-get-example]]
|
||||
==== Example
|
||||
|
||||
Retrieve the index pattern object with the `my-pattern` ID:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -32,8 +39,7 @@ GET api/saved_objects/index-pattern/my-pattern
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,44 +1,60 @@
|
|||
[[saved-objects-api-import]]
|
||||
=== Import Objects
|
||||
=== Import objects API
|
||||
++++
|
||||
<titleabbrev>Import objects</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Create a set of {kib} saved objects from a file created by the export API.
|
||||
|
||||
The import saved objects API enables you to create a set of Kibana saved objects from a file created by the export API.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-import-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/_import`
|
||||
|
||||
==== Query Parameters
|
||||
[[saved-objects-api-import-query-params]]
|
||||
==== Query parameter
|
||||
|
||||
`overwrite` (optional)::
|
||||
(boolean) Overwrite saved objects if they exist already
|
||||
`overwrite`::
|
||||
(Optional, boolean) Overwrites saved objects.
|
||||
|
||||
[[saved-objects-api-import-request-body]]
|
||||
==== Request body
|
||||
|
||||
The request body must be of type multipart/form-data.
|
||||
The request body must include the multipart/form-data type.
|
||||
|
||||
`file`::
|
||||
A file exported using the export API.
|
||||
|
||||
[[saved-objects-api-import-response-body]]
|
||||
==== Response body
|
||||
|
||||
The response body will have a top level `success` property that indicates
|
||||
if the import was successful or not as well as a `successCount` indicating how many records are successfully imported.
|
||||
In the scenario the import wasn't successful a top level `errors` array will contain the objects that failed to import.
|
||||
`success`::
|
||||
Top-level property that indicates if the import was successful.
|
||||
|
||||
`successCount`::
|
||||
Indicates the number of successfully imported records.
|
||||
|
||||
`errors`::
|
||||
(array) Indicates the import was unsuccessful and specifies the objects that failed to import.
|
||||
|
||||
[[saved-objects-api-import-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
==== Examples
|
||||
|
||||
The following example imports an index pattern and dashboard.
|
||||
Import an index pattern and dashboard:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
$ curl -X POST "localhost:5601/api/saved_objects/_import" -H "kbn-xsrf: true" --form file=@file.ndjson
|
||||
$ curl -X POST "localhost:5601/api/saved_objects/_import" -H "kbn-xsrf: true" --form file=@file.ndjson <1>
|
||||
--------------------------------------------------
|
||||
|
||||
The `file.ndjson` file would contain the following.
|
||||
The `file.ndjson` file contains the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -46,8 +62,7 @@ The `file.ndjson` file would contain the following.
|
|||
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
|
||||
--------------------------------------------------
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -57,14 +72,14 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
The following example imports an index pattern and dashboard but has a conflict on the index pattern.
|
||||
Import an index pattern and dashboard that includes a conflict on the index pattern:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
$ curl -X POST "localhost:5601/api/saved_objects/_import" -H "kbn-xsrf: true" --form file=@file.ndjson
|
||||
--------------------------------------------------
|
||||
|
||||
The `file.ndjson` file would contain the following.
|
||||
The `file.ndjson` file contains the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -72,8 +87,7 @@ The `file.ndjson` file would contain the following.
|
|||
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
|
||||
--------------------------------------------------
|
||||
|
||||
The call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -93,14 +107,14 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
The following example imports a visualization and dashboard but the index pattern for the visualization reference doesn't exist.
|
||||
Import a visualization and dashboard with an index pattern for the visualization reference that doesn't exist:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
$ curl -X POST "localhost:5601/api/saved_objects/_import" -H "kbn-xsrf: true" --form file=@file.ndjson
|
||||
--------------------------------------------------
|
||||
|
||||
The `file.ndjson` file would contain the following.
|
||||
The `file.ndjson` file contains the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -108,8 +122,7 @@ The `file.ndjson` file would contain the following.
|
|||
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"},"references":[{"name":"ref_0","type":"visualization","id":"my-vis"}]}
|
||||
--------------------------------------------------
|
||||
|
||||
The call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,50 +1,73 @@
|
|||
[[saved-objects-api-resolve-import-errors]]
|
||||
=== Resolve Import Errors
|
||||
=== Resolve import errors API
|
||||
++++
|
||||
<titleabbrev>Resolve import errors</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Resolve errors from the import API.
|
||||
|
||||
The resolve import errors API enables you to resolve errors given by the import API by either retrying certain saved objects, overwriting specific saved objects or changing references to different saved objects.
|
||||
To resolve errors, you can:
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
* Retry certain saved objects
|
||||
|
||||
* Overwrite specific saved objects
|
||||
|
||||
* Change references to different saved objects
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[saved-objects-api-resolve-import-errors-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/_resolve_import_errors`
|
||||
|
||||
[[saved-objects-api-resolve-import-errors-request-body]]
|
||||
==== Request body
|
||||
|
||||
The request body must be of type multipart/form-data.
|
||||
The request body must include the multipart/form-data type.
|
||||
|
||||
`file`::
|
||||
The same file given to the import API.
|
||||
|
||||
`retries`::
|
||||
(array) A list of `type`, `id`, `replaceReferences` and `overwrite` objects to retry importing. The property `replaceReferences` is a list of `type`, `from` and `to` used to change the object's references.
|
||||
(array) A list of `type`, `id`, `replaceReferences`, and `overwrite` objects to retry. The property `replaceReferences` is a list of `type`, `from`, and `to` used to change the object references.
|
||||
|
||||
[[saved-objects-api-resolve-import-errors-response-body]]
|
||||
==== Response body
|
||||
|
||||
The response body will have a top level `success` property that indicates
|
||||
if resolving errors was successful or not as well as a `successCount` indicating how many records are successfully resolved.
|
||||
In the scenario resolving errors wasn't successful, a top level `errors` array will contain the objects that failed to be resolved.
|
||||
`success`::
|
||||
Top-level property that indicates if the errors successfully resolved.
|
||||
|
||||
`successCount`::
|
||||
Indicates the number of successfully resolved records.
|
||||
|
||||
`errors`::
|
||||
(array) Specifies the objects that failed to resolve.
|
||||
|
||||
[[saved-objects-api-resolve-import-errors-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[saved-objects-api-resolve-import-errors-example]]
|
||||
==== Examples
|
||||
|
||||
The following example retries importing a dashboard.
|
||||
Retry a dashboard import:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"dashboard","id":"my-dashboard"}]'
|
||||
--------------------------------------------------
|
||||
|
||||
The `file.ndjson` file would contain the following.
|
||||
The `file.ndjson` file contains the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
|
||||
--------------------------------------------------
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -54,14 +77,14 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
The following example resolves errors for a dashboard. This will cause the dashboard to overwrite the existing saved object.
|
||||
Resolve errors for a dashboard and overwrite the existing saved object:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"dashboard","id":"my-dashboard","overwrite":true}]'
|
||||
--------------------------------------------------
|
||||
|
||||
The `file.ndjson` file would contain the following.
|
||||
The `file.ndjson` file contains the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -69,8 +92,7 @@ The `file.ndjson` file would contain the following.
|
|||
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
|
||||
--------------------------------------------------
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -80,22 +102,21 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
The following example resolves errors for a visualization by replacing the index pattern to another.
|
||||
Resolve errors for a visualization by replacing the index pattern with another:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"visualization","id":"my-vis","replaceReferences":[{"type":"index-pattern","from":"missing","to":"existing"}]}]'
|
||||
--------------------------------------------------
|
||||
|
||||
The `file.ndjson` file would contain the following.
|
||||
The `file.ndjson` file contains the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{"type":"visualization","id":"my-vis","attributes":{"title":"Look at my visualization"},"references":[{"name":"ref_0","type":"index-pattern","id":"missing"}]}
|
||||
--------------------------------------------------
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,38 +1,48 @@
|
|||
[[saved-objects-api-update]]
|
||||
=== Update Object
|
||||
=== Update object API
|
||||
++++
|
||||
<titleabbrev>Update object</titleabbrev>
|
||||
++++
|
||||
|
||||
beta[This functionality is *beta*. It's on track to become a stable, permanent feature of {kib}. Caution should be exercised because it is possible a breaking change to these APIs will occur in a minor version, but we’ll avoid this wherever possible. ]
|
||||
Update the attributes for an existing {kib} saved object.
|
||||
|
||||
The update saved object API enables you to update the attributes for an
|
||||
existing Kibana saved object.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.
|
||||
|
||||
[[saved-objects-api-update-request]]
|
||||
==== Request
|
||||
|
||||
`PUT /api/saved_objects/<type>/<id>`
|
||||
|
||||
[[saved-objects-api-update-path-params]]
|
||||
==== Path Parameters
|
||||
|
||||
`type` (required)::
|
||||
(string) Valid options, include: `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`
|
||||
|
||||
`id` (required)::
|
||||
(string) ID of object to update
|
||||
`type`::
|
||||
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.
|
||||
|
||||
`id`::
|
||||
(Required, string) The object ID to update.
|
||||
|
||||
[[saved-objects-api-update-request-body]]
|
||||
==== Request Body
|
||||
|
||||
`attributes` (required)::
|
||||
(object) The data to persist
|
||||
`attributes`::
|
||||
(Required, object) The data to persist.
|
||||
+
|
||||
WARNING: When you update, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API and break {kib}. Make sure any data that you send to the API is properly formed.
|
||||
|
||||
`references` (optional)::
|
||||
(array) An array of objects with `name`, `id`, and `type` properties that describe the other saved objects this object references. The `name` can be used in the attributes to refer to the other saved object, but never the `id`, which may be updated automatically in the future during migrations or import/export.
|
||||
`references`::
|
||||
(Optional, array) Objects with `name`, `id`, and `type` properties that describe the other saved objects this object references. To refer to the other saved object, use `name` in the attributes, but never the `id`, which automatically updates during migrations or import/export.
|
||||
|
||||
[[saved-objects-api-update-errors-codes]]
|
||||
==== Response code
|
||||
|
||||
==== Examples
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
The following example updates an existing index pattern object identified as
|
||||
`my-pattern` with a different index pattern title.
|
||||
[[saved-objects-api-update-example]]
|
||||
==== Example
|
||||
|
||||
Update an existing index pattern object,`my-pattern`, with a different title:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -45,8 +55,7 @@ PUT api/saved_objects/index-pattern/my-pattern
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -59,9 +68,3 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
==== Known issues
|
||||
|
||||
1. *Attributes are not validated at update time*. This means you can pass
|
||||
arbitrary and ill-formed data into this API that can break Kibana. Make sure
|
||||
any data you send to this API is properly formed.
|
||||
|
|
|
|||
|
|
@ -1,23 +1,21 @@
|
|||
[role="xpack"]
|
||||
[[spaces-api]]
|
||||
== Kibana Spaces API
|
||||
== Kibana Spaces APIs
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
|
||||
Manage your {kib} spaces.
|
||||
|
||||
The spaces API allows people to manage their spaces within {kib}.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<spaces-api-post>>
|
||||
* <<spaces-api-put>>
|
||||
* <<spaces-api-get>>
|
||||
* <<spaces-api-delete>>
|
||||
* <<spaces-api-copy-saved-objects>>
|
||||
* <<spaces-api-resolve-copy-saved-objects-conflicts>>
|
||||
* <<spaces-api-post, Create space API>>
|
||||
* <<spaces-api-put, Update space API>>
|
||||
* <<spaces-api-get, Get a space API>>
|
||||
* <<spaces-api-get-all, Get all {kib} spaces API>>
|
||||
* <<spaces-api-delete, Delete space API>>
|
||||
* <<spaces-api-copy-saved-objects, Copy saved objects to space API>>
|
||||
* <<spaces-api-resolve-copy-saved-objects-conflicts , Resolve copy saved objects to space conflicts API>>
|
||||
|
||||
include::spaces-management/post.asciidoc[]
|
||||
include::spaces-management/put.asciidoc[]
|
||||
include::spaces-management/get.asciidoc[]
|
||||
include::spaces-management/get_all.asciidoc[]
|
||||
include::spaces-management/delete.asciidoc[]
|
||||
include::spaces-management/copy_saved_objects.asciidoc[]
|
||||
include::spaces-management/resolve_copy_saved_objects_conflicts.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
[role="xpack"]
|
||||
[[spaces-api-copy-saved-objects]]
|
||||
=== Copy Saved Objects to Space
|
||||
=== Copy saved objects to space API
|
||||
++++
|
||||
<titleabbrev>Copy Saved Objects to Space</titleabbrev>
|
||||
<titleabbrev>Copy saved objects to space</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
Copies saved objects from one space to other spaces.
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
////
|
||||
Use the appropriate heading levels for your book.
|
||||
Add anchors for each section.
|
||||
|
|
|
|||
|
|
@ -1,27 +1,25 @@
|
|||
[[spaces-api-delete]]
|
||||
=== Delete space
|
||||
=== Delete space API
|
||||
++++
|
||||
<titleabbrev>Delete space</titleabbrev>
|
||||
++++
|
||||
|
||||
Deletes a {kib} space.
|
||||
|
||||
WARNING: When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone.
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
|
||||
|
||||
[WARNING]
|
||||
==================================================
|
||||
Deleting a space will automatically delete all saved objects that belong to that space. This operation cannot be undone!
|
||||
==================================================
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[[spaces-api-delete-request]]
|
||||
==== Request
|
||||
|
||||
To delete a space, submit a DELETE request to the `/api/spaces/space/<space_id>`
|
||||
endpoint:
|
||||
`DELETE /api/spaces/space/marketing`
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
DELETE /api/spaces/space/marketing
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
[[spaces-api-delete-errors-codes]]
|
||||
==== Response codes
|
||||
|
||||
==== Response
|
||||
|
||||
If the space is successfully deleted, the response code is `204`; otherwise, the response
|
||||
code is 404.
|
||||
`204`::
|
||||
Indicates a successful call.
|
||||
|
||||
`404`::
|
||||
Indicates that the request failed.
|
||||
|
|
|
|||
|
|
@ -1,83 +1,28 @@
|
|||
[[spaces-api-get]]
|
||||
=== Get Space
|
||||
=== Get a space API
|
||||
++++
|
||||
<titleabbrev>Get space</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
|
||||
Retrieves a specified {kib} space.
|
||||
|
||||
Retrieves all {kib} spaces, or a specific space.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
[[spaces-api-get-request]]
|
||||
==== Request
|
||||
|
||||
==== Get all {kib} spaces
|
||||
`GET /api/spaces/space/marketing`
|
||||
|
||||
===== Request
|
||||
[[spaces-api-get-response-codes]]
|
||||
==== Response code
|
||||
|
||||
To retrieve all spaces, issue a GET request to the
|
||||
/api/spaces/space endpoint.
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /api/spaces/space
|
||||
GET /api/spaces/space?purpose= copySavedObjectsIntoSpace
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
[[spaces-api-get-example]]
|
||||
==== Example
|
||||
|
||||
===== Request Query Parameters
|
||||
purpose (optional) :: Retrieve the available spaces for a specific purpose. This parameter only has an effect when security is enabled.
|
||||
`any` (default) ::: Retrieves all spaces the user is authorized to access.
|
||||
`copySavedObjectsIntoSpace` ::: Retrieves all spaces the user is authorized to copy saved objects into via Saved Objects Management.
|
||||
|
||||
|
||||
===== Response
|
||||
|
||||
A successful call returns a response code of `200` and a response body containing a JSON
|
||||
representation of the spaces.
|
||||
|
||||
If you are not authorized for any spaces for the provided `purpose`, then a response code of `403` will be returned.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
[
|
||||
{
|
||||
"id": "default",
|
||||
"name": "Default",
|
||||
"description" : "This is the Default Space",
|
||||
"disabledFeatures": [],
|
||||
"_reserved": true
|
||||
},
|
||||
{
|
||||
"id": "marketing",
|
||||
"name": "Marketing",
|
||||
"description" : "This is the Marketing Space",
|
||||
"color": "#aabbcc",
|
||||
"disabledFeatures": ["apm"],
|
||||
"initials": "MK"
|
||||
},
|
||||
{
|
||||
"id": "sales",
|
||||
"name": "Sales",
|
||||
"initials": "MK",
|
||||
"disabledFeatures": ["discover", "timelion"],
|
||||
},
|
||||
]
|
||||
--------------------------------------------------
|
||||
|
||||
==== Get a specific space
|
||||
|
||||
===== Request
|
||||
|
||||
To retrieve a specific space, issue a GET request to
|
||||
the `/api/spaces/space/<space_id>` endpoint:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /api/spaces/space/marketing
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
===== Response
|
||||
|
||||
A successful call returns a response code of `200` and a response body containing a JSON
|
||||
representation of the space.
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -89,4 +34,4 @@ representation of the space.
|
|||
"initials": "MK",
|
||||
"disabledFeatures": []
|
||||
}
|
||||
--------------------------------------------------
|
||||
--------------------------------------------------
|
||||
52
docs/api/spaces-management/get_all.asciidoc
Normal file
52
docs/api/spaces-management/get_all.asciidoc
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
[[spaces-api-get-all]]
|
||||
=== Get all {kib} spaces API
|
||||
++++
|
||||
<titleabbrev>Get all spaces</titleabbrev>
|
||||
++++
|
||||
|
||||
Retrieves all {kib} spaces.
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
|
||||
|
||||
[[spaces-api-get-all-request]]
|
||||
==== Request
|
||||
|
||||
`GET /api/spaces/space`
|
||||
|
||||
[[spaces-api-get-all-response-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[spaces-api-get-all-example]]
|
||||
==== Example
|
||||
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
[
|
||||
{
|
||||
"id": "default",
|
||||
"name": "Default",
|
||||
"description" : "This is the Default Space",
|
||||
"disabledFeatures": [],
|
||||
"_reserved": true
|
||||
},
|
||||
{
|
||||
"id": "marketing",
|
||||
"name": "Marketing",
|
||||
"description" : "This is the Marketing Space",
|
||||
"color": "#aabbcc",
|
||||
"disabledFeatures": ["apm"],
|
||||
"initials": "MK"
|
||||
},
|
||||
{
|
||||
"id": "sales",
|
||||
"name": "Sales",
|
||||
"initials": "MK",
|
||||
"disabledFeatures": ["discover", "timelion"],
|
||||
},
|
||||
]
|
||||
--------------------------------------------------
|
||||
|
|
@ -1,40 +1,47 @@
|
|||
[[spaces-api-post]]
|
||||
=== Create Space
|
||||
=== Create space API
|
||||
++++
|
||||
<titleabbrev>Create space</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
|
||||
Creates a {kib} space.
|
||||
|
||||
Creates a new {kib} space. To update an existing space, use the PUT command.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[spaces-api-post-request]]
|
||||
==== Request
|
||||
|
||||
To create a space, issue a POST request to the
|
||||
`/api/spaces/space` endpoint.
|
||||
`POST /api/spaces/space`
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
POST /api/spaces/space
|
||||
--------------------------------------------------
|
||||
[[spaces-api-post-request-body]]
|
||||
==== Request body
|
||||
|
||||
==== Request Body
|
||||
`id`::
|
||||
(Required, string) The space ID that is part of the Kibana URL when inside the space. You are unable to change the ID with the update operation.
|
||||
|
||||
The following parameters can be specified in the body of a POST request to create a space:
|
||||
`name`::
|
||||
(Required, string) The display name for the space.
|
||||
|
||||
`id`:: (string) Required identifier for the space. This identifier becomes part of Kibana's URL when inside the space. This cannot be changed by the update operation.
|
||||
`description`::
|
||||
(Optional, string) The description for the space.
|
||||
|
||||
`name`:: (string) Required display name for the space.
|
||||
`disabledFeatures`::
|
||||
(Optional, string array) The list of disabled features for the space. To get a list of available feature IDs, use the <<features-api-get, Features API>>.
|
||||
|
||||
`description`:: (string) Optional description for the space.
|
||||
`initials`::
|
||||
(Optional, string) Specifies the initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
|
||||
|
||||
`disabledFeatures`:: (string array) Optional list of features that are disabled for the space. Use the <<features-api-get, Features API>> to get a list of available features IDs.
|
||||
`color`::
|
||||
(Optional, string) Specifies the hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
|
||||
|
||||
[[spaces-api-post-response-codes]]
|
||||
==== Response codes
|
||||
|
||||
`initials`:: (string) Optionally specify the initials shown in the Space Avatar for this space. By default, the initials will be automatically generated from the space name.
|
||||
If specified, initials should be either 1 or 2 characters.
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
`color`:: (string) Optionally specify the hex color code used in the Space Avatar for this space. By default, the color will be automatically generated from the space name.
|
||||
|
||||
===== Example
|
||||
[[spaces-api-post-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -49,7 +56,3 @@ POST /api/spaces/space
|
|||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
==== Response
|
||||
|
||||
A successful call returns a response code of `200` with the created Space.
|
||||
|
|
|
|||
|
|
@ -1,40 +1,47 @@
|
|||
[[spaces-api-put]]
|
||||
=== Update Space
|
||||
=== Update space API
|
||||
++++
|
||||
<titleabbrev>Update space</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."]
|
||||
Updates an existing {kib} space.
|
||||
|
||||
Updates an existing {kib} space. To create a new space, use the POST command.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[spaces-api-put-api-request]]
|
||||
==== Request
|
||||
|
||||
To update a space, issue a PUT request to the
|
||||
`/api/spaces/space/<space_id>` endpoint.
|
||||
`PUT /api/spaces/space/<space_id>`
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
PUT /api/spaces/space/<space_id>
|
||||
--------------------------------------------------
|
||||
[[spaces-api-put-request-body]]
|
||||
==== Request body
|
||||
|
||||
==== Request Body
|
||||
`id`::
|
||||
(Required, string) The space ID that is part of the {kib} URL when inside the space. You are unable to change the ID with the update operation.
|
||||
|
||||
The following parameters can be specified in the body of a PUT request to update a space:
|
||||
`name`::
|
||||
(Required, string) The display name for the space.
|
||||
|
||||
`id`:: (string) Required identifier for the space. This identifier becomes part of Kibana's URL when inside the space. This cannot be changed by the update operation.
|
||||
`description`::
|
||||
(Optional, string) The description for the space.
|
||||
|
||||
`name`:: (string) Required display name for the space.
|
||||
`disabledFeatures`::
|
||||
(Optional, string array) The list of disabled features for the space. To get a list of available feature IDs, use the <<features-api-get, Features API>>.
|
||||
|
||||
`description`:: (string) Optional description for the space.
|
||||
`initials`::
|
||||
(Optional, string) Specifies the initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
|
||||
|
||||
`disabledFeatures`:: (string array) Optional list of features that are disabled for the space. Use the <<features-api-get, Features API>> to get a list of available features IDs.
|
||||
`color`::
|
||||
(Optional, string) Specifies the hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
|
||||
|
||||
`initials`:: (string) Optionally specify the initials shown in the Space Avatar for this space. By default, the initials will be automatically generated from the space name.
|
||||
If specified, initials should be either 1 or 2 characters.
|
||||
[[spaces-api-put-response-codes]]
|
||||
==== Response codes
|
||||
|
||||
`color`:: (string) Optioanlly specify the hex color code used in the Space Avatar for this space. By default, the color will be automatically generated from the space name.
|
||||
|
||||
===== Example
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[sample-api-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -49,7 +56,3 @@ PUT /api/spaces/space/marketing
|
|||
}
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
==== Response
|
||||
|
||||
A successful call returns a response code of `200` with the updated Space.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
[role="xpack"]
|
||||
[[spaces-api-resolve-copy-saved-objects-conflicts]]
|
||||
=== Resolve Copy Saved Objects to Space Conflicts
|
||||
=== Resolve copy saved objects to space conflicts API
|
||||
++++
|
||||
<titleabbrev>Resolve copy to space conflicts</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
Overwrites specific saved objects that were returned as errors from the <<spaces-api-copy-saved-objects, Copy Saved Objects to Space API>>.
|
||||
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
////
|
||||
Use the appropriate heading levels for your book.
|
||||
Add anchors for each section.
|
||||
|
|
|
|||
|
|
@ -1,17 +1,15 @@
|
|||
[role="xpack"]
|
||||
[[upgrade-assistant-api]]
|
||||
== Upgrade Assistant API
|
||||
== Upgrade assistant APIs
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental."]
|
||||
Check the upgrade status of your Elasticsearch cluster and reindex indices that were created in the previous major version. The assistant helps you prepare for the next major version of Elasticsearch.
|
||||
|
||||
The Upgrade Assistant API allows you to check the upgrade status of your Elasticsearch cluster
|
||||
and reindex indices that were created in the previous major version. The assistant helps you prepare
|
||||
for the next major version of Elasticsearch.
|
||||
|
||||
* <<upgrade-assistant-api-status>>
|
||||
* <<upgrade-assistant-api-reindexing>>
|
||||
* <<upgrade-assistant-api-default-field>>
|
||||
* <<upgrade-assistant-api-status, Upgrade readiness status API>>
|
||||
* <<start-resume-reindex, Start or resume reindex API>>
|
||||
* <<check-reindex-status, Check reindex status API>>
|
||||
* <<cancel-reindex, Cancel reindex API>>
|
||||
|
||||
include::upgrade-assistant/status.asciidoc[]
|
||||
include::upgrade-assistant/reindexing.asciidoc[]
|
||||
include::upgrade-assistant/default-field.asciidoc[]
|
||||
include::upgrade-assistant/check_reindex_status.asciidoc[]
|
||||
include::upgrade-assistant/cancel_reindex.asciidoc[]
|
||||
|
|
|
|||
32
docs/api/upgrade-assistant/cancel_reindex.asciidoc
Normal file
32
docs/api/upgrade-assistant/cancel_reindex.asciidoc
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
[[cancel-reindex]]
|
||||
=== Cancel reindex API
|
||||
++++
|
||||
<titleabbrev>Cancel reindex</titleabbrev>
|
||||
++++
|
||||
|
||||
Cancel reindexes that are waiting for the Elasticsearch reindex task to complete. For example, `lastCompletedStep` set to `40`.
|
||||
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.]
|
||||
|
||||
[[cancel-reindex-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/upgrade_assistant/reindex/myIndex/cancel`
|
||||
|
||||
[[cancel-reindex-response-codes]]
|
||||
==== Response codes
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[cancel-reindex-status-example]]
|
||||
==== Example
|
||||
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"acknowledged": true
|
||||
}
|
||||
--------------------------------------------------
|
||||
111
docs/api/upgrade-assistant/check_reindex_status.asciidoc
Normal file
111
docs/api/upgrade-assistant/check_reindex_status.asciidoc
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
[[check-reindex-status]]
|
||||
=== Check reindex status API
|
||||
++++
|
||||
<titleabbrev>Check reindex status</titleabbrev>
|
||||
++++
|
||||
|
||||
Check the status of the reindex operation.
|
||||
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.]
|
||||
|
||||
[[check-reindex-status-request]]
|
||||
==== Request
|
||||
|
||||
`GET /api/upgrade_assistant/reindex/myIndex`
|
||||
|
||||
[[check-reindex-status-response-codes]]
|
||||
==== Response codes
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[check-reindex-status-example]]
|
||||
==== Example
|
||||
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"reindexOp": {
|
||||
"indexName": ".ml-state",
|
||||
"newIndexName": ".reindexed-v7-ml-state", <1>
|
||||
"status": 0, <2>
|
||||
"lastCompletedStep": 40, <3>
|
||||
"reindexTaskId": "QprwvTMzRQ2MLWOW22oQ4Q:11819", <4>
|
||||
"reindexTaskPercComplete": 0.3, <5>
|
||||
"errorMessage": null <6>
|
||||
},
|
||||
"warnings": [], <7>
|
||||
"hasRequiredPrivileges": true <8>
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
<1> Name of the new index that is being created.
|
||||
<2> Current status of the reindex. For details, see <<status-code,Status codes>>.
|
||||
<3> Last successfully completed step of the reindex. For details, see <<step-code,Step codes>> table.
|
||||
<4> Task ID of the reindex task in Elasticsearch. Only present if reindexing has started.
|
||||
<5> Percentage of how far the reindexing task in Elasticsearch has progressed, in decimal from from 0 to 1.
|
||||
<6> Error that caused the reindex to fail, if it failed.
|
||||
<7> An array of any warning codes explaining what changes are required for this reindex. For details, see <<warning-code,Warning codes>>.
|
||||
<8> Specifies if the user has sufficient privileges to reindex this index. When security is unavailable or disables, returns `true`.
|
||||
|
||||
[[status-code]]
|
||||
==== Status codes
|
||||
|
||||
`0`::
|
||||
In progress
|
||||
|
||||
`1`::
|
||||
Completed
|
||||
|
||||
`2`::
|
||||
Failed
|
||||
|
||||
`3`::
|
||||
Paused
|
||||
NOTE: If the {kib} node that started the reindex is shutdown or restarted, the reindex goes into a paused state after some time.
|
||||
To resume the reindex, you must submit a new POST request to the `/api/upgrade_assistant/reindex/<indexName>` endpoint.
|
||||
|
||||
`4`::
|
||||
Cancelled
|
||||
|
||||
[[step-code]]
|
||||
==== Step codes
|
||||
|
||||
`0`::
|
||||
The reindex operation has been created in Kibana.
|
||||
|
||||
`10`::
|
||||
The index group services stopped. Only applies to some system indices.
|
||||
|
||||
`20`::
|
||||
The index is set to `readonly`.
|
||||
|
||||
`30`::
|
||||
The new destination index has been created.
|
||||
|
||||
`40`::
|
||||
The reindex task in Elasticsearch has started.
|
||||
|
||||
`50`::
|
||||
The reindex task in Elasticsearch has completed.
|
||||
|
||||
`60`::
|
||||
Aliases were created to point to the new index, and the old index has been deleted.
|
||||
|
||||
`70`::
|
||||
The index group services have resumed. Only applies to some system indices.
|
||||
|
||||
[[warning-code]]
|
||||
==== Warning codes
|
||||
|
||||
`0`::
|
||||
Specifies to remove the `_all` meta field.
|
||||
|
||||
`1`::
|
||||
Specifies to convert any coerced boolean values in the source document. For example, `yes`, `1`, and `off`.
|
||||
|
||||
`2`::
|
||||
Specifies to convert documents to support Elastic Common Schema. Only applies to APM indices created in 6.x.
|
||||
|
||||
|
|
@ -1,154 +1,45 @@
|
|||
[[upgrade-assistant-api-reindexing]]
|
||||
=== Reindex API
|
||||
[[start-resume-reindex]]
|
||||
=== Start or resume reindex API
|
||||
++++
|
||||
<titleabbrev>Start or resume reindex</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental."]
|
||||
Start a new reindex or resume a paused reindex.
|
||||
|
||||
When checking the upgrade status, some indices will have the `reindex` paramaeter set to `true`. You can use this Reindexing API to reindex these indices.
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.]
|
||||
|
||||
==== Start or resume a reindex
|
||||
[[start-resume-reindex-request]]
|
||||
==== Request
|
||||
|
||||
===== Request
|
||||
`POST /api/upgrade_assistant/reindex/myIndex`
|
||||
|
||||
To start a new reindex or resume a paused reindex, submit a POST request to the `/api/upgrade_assistant/reindex/<indexName>` endpoint:
|
||||
[[start-resume-reindex-codes]]
|
||||
==== Response code
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
POST /api/upgrade_assistant/reindex/myIndex
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
[[start-resume-reindex-example]]
|
||||
==== Example
|
||||
|
||||
===== Response
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"indexName": ".ml-state",
|
||||
"newIndexName": ".reindexed-v7-ml-state",
|
||||
"status": 0,
|
||||
"lastCompletedStep": 0,
|
||||
"reindexTaskId": null,
|
||||
"reindexTaskPercComplete": null,
|
||||
"errorMessage": null
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
See the next section for an explanation of each field.
|
||||
|
||||
==== Check the status of a reindex
|
||||
|
||||
===== Request
|
||||
|
||||
Once a reindex is started, you can check the status of the reindex operation by submitting a GET request to the `/api/upgrade_assistant/reindex/<indexName>` endpoint:
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /api/upgrade_assistant/reindex/myIndex
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
===== Response
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"reindexOp": {
|
||||
"indexName": ".ml-state",
|
||||
"newIndexName": ".reindexed-v7-ml-state", <1>
|
||||
"status": 0, <2>
|
||||
"lastCompletedStep": 40, <3>
|
||||
"reindexTaskId": "QprwvTMzRQ2MLWOW22oQ4Q:11819", <4>
|
||||
"reindexTaskPercComplete": 0.3, <5>
|
||||
"errorMessage": null <6>
|
||||
},
|
||||
"warnings": [], <7>
|
||||
"hasRequiredPrivileges": true <8>
|
||||
"newIndexName": ".reindexed-v7-ml-state", <1>
|
||||
"status": 0, <2>
|
||||
"lastCompletedStep": 0, <3>
|
||||
"reindexTaskId": null, <4>
|
||||
"reindexTaskPercComplete": null, <5>
|
||||
"errorMessage": null <6>
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
||||
<1> Name of the new index that is being created.
|
||||
<2> Current status of the reindex. See the <<status-code,status code table>> for details.
|
||||
<3> Last successfully completed step of the reindex. See the <<step-code,step code table>> table for details.
|
||||
<2> Current status of the reindex. For details, see <<status-code,Status codes>>.
|
||||
<3> Last successfully completed step of the reindex. For details, see <<step-code,Step codes>> table.
|
||||
<4> Task ID of the reindex task in Elasticsearch. Only present if reindexing has started.
|
||||
<5> Percentage of how far the reindexing task in Elasticsearch has progressed, in decimal from from 0 to 1.
|
||||
<6> Error that caused the reindex to fail, if it failed.
|
||||
<7> An array of any warning codes explaining what changes are required for this reindex. See the <<warning-code,warning code table>> for details.
|
||||
<8> Whether or not the current user has required privileges to reindex this index. Returns `true` if Security is not available or disabled.
|
||||
|
||||
[[status-code]]
|
||||
===== Status code
|
||||
|
||||
The `status` field corresponds to these statuses:
|
||||
|
||||
[horizontal]
|
||||
0:: in progress
|
||||
1:: completed
|
||||
2:: failed
|
||||
3:: paused
|
||||
4:: cancelled
|
||||
|
||||
[[step-code]]
|
||||
===== Step code
|
||||
|
||||
The `lastCompletedStep` field corresponds to these steps:
|
||||
|
||||
[horizontal]
|
||||
0:: The reindex operation has been created in Kibana.
|
||||
10:: Index group services stopped. Only applies to some system indices.
|
||||
20:: index set to readonly
|
||||
30:: The new destination index has been created.
|
||||
40:: The reindex task in Elasticsearch has started.
|
||||
50:: The reindex task in Elasticsearch has completed.
|
||||
60:: Aliases have been created to point to the new index, and the old index has been deleted.
|
||||
70:: Index group services have been resumed. Only applies to some system indices.
|
||||
|
||||
[[warning-code]]
|
||||
===== Warning code
|
||||
|
||||
The `warnings` field corresponds to an array of integers for these warnings:
|
||||
|
||||
[horizontal]
|
||||
0:: The `_all` meta field will be removed.
|
||||
1:: Any coerced boolean values will be converted in the source document (example: `yes`, `1`, `off`).
|
||||
2:: Documents will be converted to support Elastic Common Schema. Only applies to APM indices created in 6.x.
|
||||
|
||||
===== Paused reindexes
|
||||
|
||||
If the Kibana node that started the reindex is shutdown or restarted, the reindex will go into a paused state after some time.
|
||||
To resume the reindex, you must submit a new POST request to the `/api/upgrade_assistant/reindex/<indexName>` endpoint.
|
||||
|
||||
==== Cancel a reindex
|
||||
|
||||
===== Request
|
||||
|
||||
You can cancel reindexes that are waiting for the Elasticsearch reindex task to complete (`lastCompletedStep` set to `40`).
|
||||
To cancel a reindex, submit a POST request to the `/api/upgrade_assistant/reindex/<indexName>/cancel` endpoint:
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
POST /api/upgrade_assistant/reindex/myIndex/cancel
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
===== Response
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"acknowledged": true
|
||||
}
|
||||
--------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,24 +1,28 @@
|
|||
[[upgrade-assistant-api-status]]
|
||||
=== Upgrade Readiness Status
|
||||
=== Upgrade readiness status API
|
||||
++++
|
||||
<titleabbrev>Upgrade readiness status</titleabbrev>
|
||||
++++
|
||||
|
||||
experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental."]
|
||||
Check the status of your cluster.
|
||||
|
||||
experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.]
|
||||
|
||||
[[upgrade-assistant-api-status-request]]
|
||||
==== Request
|
||||
|
||||
To check the status of your cluster, submit a GET request to the `/api/upgrade_assistant/status` endpoint:
|
||||
`GET /api/upgrade_assistant/status`
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
[[upgrade-assistant-api-status-response-codes]]
|
||||
==== Response codes
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /api/upgrade_assistant/status
|
||||
--------------------------------------------------
|
||||
// KIBANA
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
==== Response
|
||||
[[upgrade-assistant-api-status-example]]
|
||||
==== Example
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -45,4 +49,4 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
<1> You can fix indices with the `reindex` attribute set to `true` using the <<upgrade-assistant-api-reindexing>>.
|
||||
<1> To fix indices with the `reindex` attribute, set to `true` using the <<start-resume-reindex, Start or resume reindex API>>.
|
||||
|
|
|
|||
|
|
@ -1,13 +1,11 @@
|
|||
[[url-shortening-api]]
|
||||
== URL Shortening API
|
||||
== URL shortening API
|
||||
|
||||
Kibana URLs contain the state of the application making them very long and cumbersome.
|
||||
Internet Explorer has URL length restrictions, and some wiki and markup parsers don't do well with the full-length version of the Kibana URL.
|
||||
{kib} URLs contain the state of the application, which makes them long and cumbersome.
|
||||
Internet Explorer has URL length restrictions, and some wiki and markup parsers don't do well with the full-length version of the {kib} URL.
|
||||
|
||||
The short URLs enabled by this API are designed to make sharing Kibana URLs easier.
|
||||
Short URLs are designed to make sharing {kib} URLs easier.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<url-shortening-api-api-shorten-url>>
|
||||
* <<shorten-url-api, Shorten URL API>>
|
||||
|
||||
include::url_shortening/shorten_url.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -1,28 +1,37 @@
|
|||
[[url-shortening-api-api-shorten-url]]
|
||||
=== Shorten URL
|
||||
[[shorten-url-api]]
|
||||
=== Shorten URL API
|
||||
++++
|
||||
<titleabbrev>Shorten URL</titleabbrev>
|
||||
++++
|
||||
|
||||
The Shorten URL API allows for converting a Kibana URL into a token.
|
||||
Convert a {kib} URL into a token.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
||||
|
||||
[[url-shortening-api-request]]
|
||||
==== Request
|
||||
|
||||
`POST /api/shorten_url`
|
||||
|
||||
==== Request Body
|
||||
[[url-shortening-api-request-body]]
|
||||
==== Request body
|
||||
|
||||
The request body must be a JSON object containing the following properties:
|
||||
|
||||
`url` (required)::
|
||||
(string) Kibana URL, relative to `/app/kibana`, to be shortened.
|
||||
`url`::
|
||||
(Required, string) The {kib} URL that you want to shorten, Relative to `/app/kibana`.
|
||||
|
||||
[[url-shortening-api-response-body]]
|
||||
==== Response body
|
||||
|
||||
The response body will have a top level `urlId` property that contains
|
||||
the shortened URL token for the provided request body.
|
||||
urlId:: A top level property that contains the shortened URL token for the provided request body.
|
||||
|
||||
==== Examples
|
||||
[[url-shortening-api-codes]]
|
||||
==== Response code
|
||||
|
||||
`200`::
|
||||
Indicates a successful call.
|
||||
|
||||
[[url-shortening-api-example]]
|
||||
==== Example
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -33,8 +42,7 @@ POST api/shorten_url
|
|||
--------------------------------------------------
|
||||
// KIBANA
|
||||
|
||||
A successful call returns a response code of `200` and a response body
|
||||
containing a JSON structure similar to the following example:
|
||||
The API returns the following result:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
|
|
@ -43,6 +51,7 @@ containing a JSON structure similar to the following example:
|
|||
}
|
||||
--------------------------------------------------
|
||||
|
||||
A shortened Kibana URL can then be constructed for easier sharing.
|
||||
For easy sharing, construct the shortened {kib} URL:
|
||||
|
||||
`http://localhost:5601/goto/f73b295ff92718b26bc94edac766d8e3`
|
||||
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ interface to copy objects from one space to another.
|
|||
. (Optional) Delete objects in the export space that you no longer need.
|
||||
|
||||
{kib} also has experimental <<dashboard-import-api-import, import>> and
|
||||
<<dashboard-import-api-export, export>> dashboard APIs if you want
|
||||
<<dashboard-api-export, export>> dashboard APIs if you want
|
||||
a dashboard-centric way to automate this process.
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue