-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* [DOCS] API intro * Logstash configuration management * Reformatting * Comments from Josh * Commets from Gail * Fixed broken things
- Loading branch information
1 parent
47fef4e
commit 1e3f143
Showing
37 changed files
with
433 additions
and
377 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
[[dashboard-api]] | ||
== Import and export dashboard APIs | ||
|
||
Import and export dashboards with the corresponding saved objects, such as visualizations, saved | ||
searches, and index patterns. | ||
|
||
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. | ||
|
||
The following import and export dashboard APIs are available: | ||
|
||
* <<dashboard-import-api, Import dashboard API>> to import dashboards and corresponding saved objects | ||
|
||
* <<dashboard-api-export, Export dashboard API>> to export dashboards and corresponding saved objects | ||
|
||
include::dashboard/import-dashboard.asciidoc[] | ||
include::dashboard/export-dashboard.asciidoc[] |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/api/dashboard-import/import.asciidoc → docs/api/dashboard/import-dashboard.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,217 @@ | ||
[role="xpack"] | ||
[[features-api]] | ||
== Features API | ||
[[features-api-get]] | ||
== Get features API | ||
|
||
View information about the available features in {kib}. Features are used by spaces and security to refine and secure access to {kib}. | ||
experimental[] Retrieves all {kib} features. Features are used by spaces and security to refine and secure access to {kib}. | ||
|
||
* <<features-api-get, Get features API>> | ||
[float] | ||
[[features-api-get-request]] | ||
=== Request | ||
|
||
include::features/get.asciidoc[] | ||
`GET /api/features` | ||
|
||
[float] | ||
[[features-api-get-codes]] | ||
=== Response code | ||
|
||
`200`:: | ||
Indicates a successful call. | ||
|
||
[float] | ||
[[features-api-get-example]] | ||
=== Example | ||
|
||
The API returns the following: | ||
|
||
[source,js] | ||
-------------------------------------------------- | ||
{ | ||
"id": "discover", | ||
"name": "Discover", | ||
"icon": "discoverApp", | ||
"navLinkId": "kibana:discover", | ||
"app": [ | ||
"kibana" | ||
], | ||
"catalogue": [ | ||
"discover" | ||
], | ||
"privileges": { | ||
"all": { | ||
"savedObject": { | ||
"all": [ | ||
"search", | ||
"url" | ||
], | ||
"read": [ | ||
"config", | ||
"index-pattern" | ||
] | ||
}, | ||
"ui": [ | ||
"show", | ||
"createShortUrl", | ||
"save" | ||
] | ||
}, | ||
"read": { | ||
"savedObject": { | ||
"all": [], | ||
"read": [ | ||
"config", | ||
"index-pattern", | ||
"search", | ||
"url" | ||
] | ||
}, | ||
"ui": [ | ||
"show" | ||
] | ||
} | ||
} | ||
}, | ||
{ | ||
"id": "visualize", | ||
"name": "Visualize", | ||
"icon": "visualizeApp", | ||
"navLinkId": "kibana:visualize", | ||
"app": [ | ||
"kibana" | ||
], | ||
"catalogue": [ | ||
"visualize" | ||
], | ||
"privileges": { | ||
"all": { | ||
"savedObject": { | ||
"all": [ | ||
"visualization", | ||
"url" | ||
], | ||
"read": [ | ||
"config", | ||
"index-pattern", | ||
"search" | ||
] | ||
}, | ||
"ui": [ | ||
"show", | ||
"createShortUrl", | ||
"delete", | ||
"save" | ||
] | ||
}, | ||
"read": { | ||
"savedObject": { | ||
"all": [], | ||
"read": [ | ||
"config", | ||
"index-pattern", | ||
"search", | ||
"visualization" | ||
] | ||
}, | ||
"ui": [ | ||
"show" | ||
] | ||
} | ||
} | ||
}, | ||
{ | ||
"id": "dashboard", | ||
"name": "Dashboard", | ||
"icon": "dashboardApp", | ||
"navLinkId": "kibana:dashboard", | ||
"app": [ | ||
"kibana" | ||
], | ||
"catalogue": [ | ||
"dashboard" | ||
], | ||
"privileges": { | ||
"all": { | ||
"savedObject": { | ||
"all": [ | ||
"dashboard", | ||
"url" | ||
], | ||
"read": [ | ||
"config", | ||
"index-pattern", | ||
"search", | ||
"visualization", | ||
"timelion-sheet", | ||
"canvas-workpad" | ||
] | ||
}, | ||
"ui": [ | ||
"createNew", | ||
"show", | ||
"showWriteControls" | ||
] | ||
}, | ||
"read": { | ||
"savedObject": { | ||
"all": [], | ||
"read": [ | ||
"config", | ||
"index-pattern", | ||
"search", | ||
"visualization", | ||
"timelion-sheet", | ||
"canvas-workpad", | ||
"dashboard" | ||
] | ||
}, | ||
"ui": [ | ||
"show" | ||
] | ||
} | ||
} | ||
}, | ||
{ | ||
"id": "dev_tools", | ||
"name": "Dev Tools", | ||
"icon": "devToolsApp", | ||
"navLinkId": "kibana:dev_tools", | ||
"app": [ | ||
"kibana" | ||
], | ||
"catalogue": [ | ||
"console", | ||
"searchprofiler", | ||
"grokdebugger" | ||
], | ||
"privileges": { | ||
"all": { | ||
"api": [ | ||
"console" | ||
], | ||
"savedObject": { | ||
"all": [], | ||
"read": [ | ||
"config" | ||
] | ||
}, | ||
"ui": [ | ||
"show" | ||
] | ||
}, | ||
"read": { | ||
"api": [ | ||
"console" | ||
], | ||
"savedObject": { | ||
"all": [], | ||
"read": [ | ||
"config" | ||
] | ||
}, | ||
"ui": [ | ||
"show" | ||
] | ||
} | ||
}, | ||
"privilegesTooltip": "User should also be granted the appropriate Elasticsearch cluster and index privileges" | ||
}, | ||
-------------------------------------------------- |
Oops, something went wrong.