Skip to content

Commit

Permalink
[DOCS] Adds prerequisites for create, delete, get connector APIs (#13…
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored May 12, 2022
1 parent 784fd55 commit c4ed812
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 33 deletions.
8 changes: 4 additions & 4 deletions docs/api/actions-and-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ For deprecated APIs, refer to <<actions-and-connectors-legacy-apis>>.

For information about the actions and connectors that {kib} supports, refer to <<action-types,Action and connector types>>.

include::actions-and-connectors/get.asciidoc[]
include::actions-and-connectors/get_all.asciidoc[]
include::actions-and-connectors/create.asciidoc[leveloffset=+1]
include::actions-and-connectors/delete.asciidoc[leveloffset=+1]
include::actions-and-connectors/get.asciidoc[leveloffset=+1]
include::actions-and-connectors/get_all.asciidoc[leveloffset=+1]
include::actions-and-connectors/list.asciidoc[]
include::actions-and-connectors/create.asciidoc[]
include::actions-and-connectors/update.asciidoc[]
include::actions-and-connectors/execute.asciidoc[]
include::actions-and-connectors/delete.asciidoc[]
include::actions-and-connectors/legacy/index.asciidoc[]
include::actions-and-connectors/legacy/get.asciidoc[]
include::actions-and-connectors/legacy/get_all.asciidoc[]
Expand Down
31 changes: 22 additions & 9 deletions docs/api/actions-and-connectors/create.asciidoc
Original file line number Diff line number Diff line change
@@ -1,26 +1,37 @@
[[create-connector-api]]
=== Create connector API
== Create connector API
++++
<titleabbrev>Create connector</titleabbrev>
++++

Creates a connector.

[discrete]
[[create-connector-api-request]]
==== Request
=== {api-request-title}

`POST <kibana host>:<port>/api/actions/connector`

`POST <kibana host>:<port>/s/<space_id>/api/actions/connector`

[discrete]
=== {api-prereq-title}

You must have `all` privileges for the *Actions and Connectors* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

[discrete]
[[create-connector-api-path-params]]
==== Path parameters
=== {api-path-parms-title}

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
(Optional, string) An identifier for the space. If `space_id` is not provided
in the URL, the default space is used.

[discrete]
[[create-connector-api-request-body]]
==== Request body
=== {api-request-body-title}

`name`::
(Required, string) The display name for the connector.
Expand All @@ -38,25 +49,27 @@ Creates a connector.
+
WARNING: Remember these values. You must provide them each time you call the <<update-connector-api, update>> API.

[discrete]
[[create-connector-api-request-codes]]
==== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

[discrete]
[[create-connector-api-example]]
==== Example
=== {api-examples-title}

[source,sh]
--------------------------------------------------
$ curl -X POST api/actions/connector -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
POST api/actions/connector
{
"name": "my-connector",
"connector_type_id": ".index",
"config": {
"index": "test-index"
}
}'
}
--------------------------------------------------
// KIBANA

Expand Down
23 changes: 17 additions & 6 deletions docs/api/actions-and-connectors/delete.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[delete-connector-api]]
=== Delete connector API
== Delete connector API
++++
<titleabbrev>Delete connector</titleabbrev>
++++
Expand All @@ -8,32 +8,43 @@ Deletes an connector by ID.

WARNING: When you delete a connector, _it cannot be recovered_.

[discrete]
[[delete-connector-api-request]]
==== Request
=== {api-request-title}

`DELETE <kibana host>:<port>/api/actions/connector/<id>`

`DELETE <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>`

[discrete]
=== {api-prereq-title}

You must have `all` privileges for the *Actions and Connectors* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

[discrete]
[[delete-connector-api-path-params]]
==== Path parameters
=== {api-path-parms-title}

`id`::
(Required, string) The ID of the connector.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[discrete]
[[delete-connector-api-response-codes]]
==== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

==== Example
[discrete]
=== {api-examples-title}

[source,sh]
--------------------------------------------------
$ curl -X DELETE api/actions/connector/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
DELETE api/actions/connector/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
--------------------------------------------------
// KIBANA
25 changes: 18 additions & 7 deletions docs/api/actions-and-connectors/get.asciidoc
Original file line number Diff line number Diff line change
@@ -1,39 +1,50 @@
[[get-connector-api]]
=== Get connector API
== Get connector API
++++
<titleabbrev>Get connector</titleabbrev>
++++

Retrieves a connector by ID.

[discrete]
[[get-connector-api-request]]
==== Request
=== {api-request-title}

`GET <kibana host>:<port>/api/actions/connector/<id>`

`GET <kibana host>:<port>/s/<space_id>/api/actions/connector/<id>`

[discrete]
=== {api-prereq-title}

You must have `read` privileges for the *Actions and Connectors* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

[discrete]
[[get-connector-api-params]]
==== Path parameters
=== {api-path-parms-title}

`id`::
(Required, string) The ID of the connector.

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[discrete]
[[get-connector-api-codes]]
==== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

[discrete]
[[get-connector-api-example]]
==== Example
=== {api-examples-title}

[source,sh]
--------------------------------------------------
$ curl -X GET api/actions/connector/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
GET api/actions/connector/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
--------------------------------------------------
// KIBANA

Expand All @@ -54,4 +65,4 @@ The API returns the following:
"is_deprecated": false,
"is_missing_secrets": false
}
--------------------------------------------------
--------------------------------------------------
25 changes: 18 additions & 7 deletions docs/api/actions-and-connectors/get_all.asciidoc
Original file line number Diff line number Diff line change
@@ -1,36 +1,47 @@
[[get-all-connectors-api]]
=== Get all connectors API
== Get all connectors API
++++
<titleabbrev>Get all connectors</titleabbrev>
++++

Retrieves all connectors.

[discrete]
[[get-all-connectors-api-request]]
==== Request
=== {api-request-title}

`GET <kibana host>:<port>/api/actions/connectors`

`GET <kibana host>:<port>/s/<space_id>/api/actions/connectors`

[discrete]
=== {api-prereq-title}

You must have `read` privileges for the *Actions and Connectors* feature in the
*Management* section of the
<<kibana-feature-privileges,{kib} feature privileges>>.

[discrete]
[[get-all-connectors-api-path-params]]
==== Path parameters
=== {api-path-parms-title}

`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.

[discrete]
[[get-all-connectors-api-codes]]
==== Response code
=== {api-response-codes-title}

`200`::
Indicates a successful call.

[discrete]
[[get-all-connectors-api-example]]
==== Example
=== {api-examples-title}

[source,sh]
--------------------------------------------------
$ curl -X GET api/actions/connectors
GET api/actions/connectors
--------------------------------------------------
// KIBANA

Expand Down Expand Up @@ -64,4 +75,4 @@ The API returns the following:
]
--------------------------------------------------

<1> `referenced_by_count` - The number of saved-objects referencing this connector. This value is not calculated if `is_preconfigured: true`.
<1> `referenced_by_count` indicates the number of saved objects that reference the connector. This value is not calculated if `is_preconfigured` is `true`.

0 comments on commit c4ed812

Please sign in to comment.