Skip to content

Commit 24ea40c

Browse files
Merge branch 'master' into scaling_panel_on_create_wizard
2 parents cd762f7 + 7eec879 commit 24ea40c

File tree

315 files changed

+7562
-4254
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

315 files changed

+7562
-4254
lines changed

docs/api/dashboard/export-dashboard.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ experimental[] Export dashboards and corresponding saved objects.
99
[[dashboard-api-export-request]]
1010
==== Request
1111

12-
`GET /api/kibana/dashboards/export`
12+
`GET <kibana host>:<port>/api/kibana/dashboards/export`
1313

1414
[[dashboard-api-export-params]]
1515
==== Query parameters
@@ -20,9 +20,9 @@ experimental[] Export dashboards and corresponding saved objects.
2020
[[dashboard-api-export-response-body]]
2121
==== Response body
2222

23-
`objects`::
23+
`objects`::
2424
(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 dashboard API>>.
25-
25+
2626
[[dashboard-api-export-codes]]
2727
==== Response code
2828

@@ -33,10 +33,10 @@ experimental[] Export dashboards and corresponding saved objects.
3333
[[dashboard-api-export-example]]
3434
==== Example
3535

36-
[source,js]
36+
[source,sh]
3737
--------------------------------------------------
38-
GET api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c <1>
38+
$ curl -X GET "localhost:5601/api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c" <1>
3939
--------------------------------------------------
4040
// KIBANA
4141

42-
<1> The dashboard ID is `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c`.
42+
<1> The dashboard ID is `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c`.

docs/api/dashboard/import-dashboard.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ experimental[] Import dashboards and corresponding saved objects.
99
[[dashboard-api-import-request]]
1010
==== Request
1111

12-
`POST /api/kibana/dashboards/import`
12+
`POST <kibana host>:<port>/api/kibana/dashboards/import`
1313

1414
[[dashboard-api-import-params]]
1515
==== Query parameters
@@ -40,9 +40,9 @@ Use the complete response body from the <<dashboard-api-export, Export dashboard
4040
[[dashboard-api-import-example]]
4141
==== Example
4242

43-
[source,js]
43+
[source,sh]
4444
--------------------------------------------------
45-
POST api/kibana/dashboards/import?exclude=index-pattern
45+
$ curl -X POST "localhost:5601/api/kibana/dashboards/import?exclude=index-pattern"
4646
{
4747
"objects": [
4848
{

docs/api/features.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ experimental[] Retrieves all {kib} features. Features are used by spaces and sec
88
[[features-api-get-request]]
99
=== Request
1010

11-
`GET /api/features`
11+
`GET <kibana host>:<port>/api/features`
1212

1313
[float]
1414
[[features-api-get-codes]]
@@ -23,7 +23,7 @@ experimental[] Retrieves all {kib} features. Features are used by spaces and sec
2323

2424
The API returns the following:
2525

26-
[source,js]
26+
[source,sh]
2727
--------------------------------------------------
2828
{
2929
"id": "discover",

docs/api/logstash-configuration-management.asciidoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
[[logstash-configuration-management-api]]
33
== Logstash configuration management APIs
44

5-
Programmatically integrate with the Logstash configuration management feature.
5+
Programmatically integrate with Logstash configuration management.
66

7-
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.
7+
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.
88

99
The following Logstash configuration management APIs are available:
1010

@@ -20,5 +20,3 @@ include::logstash-configuration-management/delete-pipeline.asciidoc[]
2020
include::logstash-configuration-management/list-pipeline.asciidoc[]
2121
include::logstash-configuration-management/create-logstash.asciidoc[]
2222
include::logstash-configuration-management/retrieve-pipeline.asciidoc[]
23-
24-

docs/api/logstash-configuration-management/create-logstash.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ experimental[] Create a centrally-managed Logstash pipeline, or update an existi
99
[[logstash-configuration-management-api-create-request]]
1010
==== Request
1111

12-
`PUT /api/logstash/pipeline/<id>`
12+
`PUT <kibana host>:<port>/api/logstash/pipeline/<id>`
1313

1414
[[logstash-configuration-management-api-create-params]]
1515
==== Path parameters
@@ -39,9 +39,9 @@ experimental[] Create a centrally-managed Logstash pipeline, or update an existi
3939
[[logstash-configuration-management-api-create-example]]
4040
==== Example
4141

42-
[source,js]
42+
[source,sh]
4343
--------------------------------------------------
44-
PUT api/logstash/pipeline/hello-world
44+
$ curl -X PUT "localhost:5601/api/logstash/pipeline/hello-world"
4545
{
4646
"pipeline": "input { stdin {} } output { stdout {} }",
4747
"settings": {

docs/api/logstash-configuration-management/delete-pipeline.asciidoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ experimental[] Delete a centrally-managed Logstash pipeline.
99
[[logstash-configuration-management-api-delete-request]]
1010
==== Request
1111

12-
`DELETE /api/logstash/pipeline/<id>`
12+
`DELETE <kibana host>:<port>/api/logstash/pipeline/<id>`
1313

1414
[[logstash-configuration-management-api-delete-params]]
1515
==== Path parameters
@@ -26,9 +26,8 @@ experimental[] Delete a centrally-managed Logstash pipeline.
2626
[[logstash-configuration-management-api-delete-example]]
2727
==== Example
2828

29-
[source,js]
29+
[source,sh]
3030
--------------------------------------------------
31-
DELETE api/logstash/pipeline/hello-world
31+
$ curl -X DELETE "localhost:5601/api/logstash/pipeline/hello-world"
3232
--------------------------------------------------
3333
// KIBANA
34-

docs/api/logstash-configuration-management/list-pipeline.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ experimental[] List all centrally-managed Logstash pipelines.
99
[[logstash-configuration-management-api-list-request]]
1010
==== Request
1111

12-
`GET /api/logstash/pipelines`
12+
`GET <kibana host>:<port>/api/logstash/pipelines`
1313

1414
[[logstash-configuration-management-api-list-example]]
1515
==== Example
1616

1717
The API returns the following:
1818

19-
[source,js]
19+
[source,sh]
2020
--------------------------------------------------
2121
{
2222
"pipelines": [
@@ -35,4 +35,4 @@ The API returns the following:
3535
}
3636
--------------------------------------------------
3737

38-
<1> The `username` property appears when security is enabled, and depends on when the pipeline was created or last updated.
38+
<1> The `username` property appears when security is enabled, and depends on when the pipeline was created or last updated.

docs/api/logstash-configuration-management/retrieve-pipeline.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ experimental[] Retrieve a centrally-managed Logstash pipeline.
99
[[logstash-configuration-management-api-retrieve-request]]
1010
==== Request
1111

12-
`GET /api/logstash/pipeline/<id>`
12+
`GET <kibana host>:<port>/api/logstash/pipeline/<id>`
1313

1414
[[logstash-configuration-management-api-retrieve-path-params]]
1515
==== Path parameters
1616

1717
`id`::
1818
(Required, string) The pipeline ID.
19-
19+
2020
[[logstash-configuration-management-api-retrieve-example]]
2121
==== Example
2222

2323
The API returns the following:
2424

25-
[source,js]
25+
[source,sh]
2626
--------------------------------------------------
2727
{
2828
"id": "hello-world",
@@ -33,4 +33,4 @@ The API returns the following:
3333
"queue.type": "persistent"
3434
}
3535
}
36-
--------------------------------------------------
36+
--------------------------------------------------

docs/api/role-management.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
[[role-management-api]]
33
== {kib} role management APIs
44

5-
Manage the roles that grant <<kibana-privileges, Kibana privileges>>.
5+
Manage the roles that grant <<kibana-privileges, {kib} privileges>>.
66

7-
WARNING: Do not use the {ref}/security-api.html#security-role-apis[{es} role management APIs] to manage {kib} roles.
7+
WARNING: Do not use the {ref}/security-api.html#security-role-apis[{es} role management APIs] to manage {kib} roles.
88

99
The following {kib} role management APIs are available:
1010

docs/api/role-management/delete.asciidoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,23 @@
44
<titleabbrev>Delete role</titleabbrev>
55
++++
66

7-
Delete a {kib} role.
8-
9-
experimental["The underlying mechanism of enforcing role-based access control is stable, but the APIs for managing the roles are experimental."]
7+
experimental[] Delete a {kib} role.
108

119
[[role-management-api-delete-prereqs]]
12-
==== Prerequisite
10+
==== Prerequisite
1311

1412
To use the delete role API, you must have the `manage_security` cluster privilege.
1513

1614
[[role-management-api-delete-request-body]]
1715
==== Request
1816

19-
`DELETE /api/security/role/my_admin_role`
17+
`DELETE <kibana host>:<port>/api/security/role/my_admin_role`
2018

2119
[[role-management-api-delete-response-codes]]
2220
==== Response codes
2321

2422
`204`::
2523
Indicates a successful call.
26-
24+
2725
`404`::
28-
Indicates an unsuccessful call.
29-
26+
Indicates an unsuccessful call.

0 commit comments

Comments
 (0)