mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[DOCS] Kibana APIs not accessible via Console (#26221)
This commit is contained in:
parent
8b304217b5
commit
5c1615dd96
29 changed files with 58 additions and 0 deletions
|
@ -24,6 +24,8 @@ wherever possible.
|
|||
have breaking changes in any version of Kibana, or it might even be removed
|
||||
entirely.
|
||||
|
||||
NOTE: You cannot access these APIs via the Console in Kibana.
|
||||
|
||||
[float]
|
||||
== APIs
|
||||
* <<spaces-api>>
|
||||
|
|
|
@ -10,6 +10,8 @@ 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.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<dashboard-import-api-import>>
|
||||
* <<dashboard-import-api-export>>
|
||||
|
||||
|
|
|
@ -7,6 +7,8 @@ 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.
|
||||
|
||||
==== Request
|
||||
|
||||
`GET /api/kibana/dashboards/export`
|
||||
|
|
|
@ -7,6 +7,8 @@ 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.
|
||||
|
||||
==== Request
|
||||
|
||||
`POST /api/kibana/dashboards/import`
|
||||
|
|
|
@ -9,6 +9,8 @@ Traditionally users would perform this integration by accessing the the `.logsta
|
|||
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.
|
||||
|
||||
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>>
|
||||
|
|
|
@ -7,6 +7,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
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]
|
||||
==== Request
|
||||
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
|
||||
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]
|
||||
==== Request
|
||||
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
|
||||
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]
|
||||
==== Request
|
||||
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
|
||||
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]
|
||||
==== Request
|
||||
|
||||
|
|
|
@ -9,6 +9,8 @@ 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.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<role-management-api-put>>
|
||||
* <<role-management-api-get>>
|
||||
* <<role-management-api-delete>>
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
|
||||
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.]
|
||||
|
||||
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.
|
||||
|
|
|
@ -5,6 +5,8 @@ experimental[This API is experimental and may be changed or removed completely i
|
|||
|
||||
Retrieves all {kib} roles, or a specific role.
|
||||
|
||||
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.
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This API is experimental and may be changed or removed completely i
|
|||
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.
|
||||
|
|
|
@ -9,6 +9,8 @@ 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.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<saved-objects-api-get>>
|
||||
* <<saved-objects-api-bulk-get>>
|
||||
* <<saved-objects-api-find>>
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
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.
|
||||
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/_bulk_create`
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
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.
|
||||
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/_bulk_get`
|
||||
|
|
|
@ -5,6 +5,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
|
||||
The create saved object API enables you to persist a Kibana saved object.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
==== Request
|
||||
|
||||
`POST /api/saved_objects/<type>` +
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
The delete saved object API permanently removes a Kibana saved object. Once a
|
||||
saved object has been deleted, _it cannot be recovered_.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
==== Request
|
||||
|
||||
`DELETE /api/saved_objects/<type>/<id>`
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
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.
|
||||
|
||||
==== Request
|
||||
|
||||
`GET /api/saved_objects/_find`
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
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.
|
||||
|
||||
==== Request
|
||||
|
||||
`GET /api/saved_objects/<type>/<id>`
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This functionality is *experimental* and may be changed or removed
|
|||
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.
|
||||
|
||||
==== Request
|
||||
|
||||
`PUT /api/saved_objects/<type>/<id>`
|
||||
|
|
|
@ -6,6 +6,8 @@ experimental[This API is *experimental* and may be changed or removed completely
|
|||
|
||||
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>>
|
||||
|
|
|
@ -8,6 +8,8 @@ experimental[This API is *experimental* and may be changed or removed completely
|
|||
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.
|
||||
|
||||
==== Request
|
||||
|
||||
To delete a space, submit a DELETE request to the `/api/spaces/space/<space_id>`
|
||||
|
|
|
@ -5,6 +5,8 @@ experimental[This API is *experimental* and may be changed or removed completely
|
|||
|
||||
Retrieves all {kib} spaces, or a specific space.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
==== Get all {kib} spaces
|
||||
|
||||
===== Request
|
||||
|
|
|
@ -5,6 +5,8 @@ experimental[This API is *experimental* and may be changed or removed completely
|
|||
|
||||
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.
|
||||
|
||||
==== Request
|
||||
|
||||
To create a space, issue a POST request to the
|
||||
|
|
|
@ -5,6 +5,8 @@ experimental[This API is *experimental* and may be changed or removed completely
|
|||
|
||||
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.
|
||||
|
||||
==== Request
|
||||
|
||||
To update a space, issue a PUT request to the
|
||||
|
|
|
@ -6,6 +6,8 @@ Internet Explorer has URL length restrictions, and some wiki and markup parsers
|
|||
|
||||
The short URLs enabled by this API are designed to make sharing Kibana URLs easier.
|
||||
|
||||
NOTE: You cannot access these endpoints via the Console in Kibana.
|
||||
|
||||
* <<url-shortening-api-api-shorten-url>>
|
||||
|
||||
include::url_shortening/shorten_url.asciidoc[]
|
||||
|
|
|
@ -3,6 +3,8 @@
|
|||
|
||||
The Shorten URL API allows for converting a Kibana URL into a token.
|
||||
|
||||
Note: You cannot access this endpoint via the Console in Kibana.
|
||||
|
||||
==== Request
|
||||
|
||||
`POST /api/shorten_url`
|
||||
|
|
|
@ -4,6 +4,8 @@
|
|||
The Console plugin provides a UI to interact with the REST API of Elasticsearch. Console has two main areas: the *editor*,
|
||||
where you compose requests to Elasticsearch, and the *response* pane, which displays the responses to the request.
|
||||
|
||||
NOTE: You cannot interact with Kibana API endpoints via the Console.
|
||||
|
||||
.The Console UI
|
||||
image::dev-tools/console/images/introduction_screen.png[Screenshot]
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue