Skip to content

Commit 202efcd

Browse files
kibanamachinelcawl
andauthored
[DOCS] Add server log connector details to connector APIs (#134409) (#134621)
(cherry picked from commit 03fe5d1) Co-authored-by: Lisa Cawley <[email protected]>
1 parent 3f83a62 commit 202efcd

File tree

2 files changed

+48
-6
lines changed

2 files changed

+48
-6
lines changed

docs/api/actions-and-connectors/create.asciidoc

+7-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You must have `all` privileges for the *Actions and Connectors* feature in the
3131
=== {api-request-body-title}
3232

3333
`config`::
34-
(Required, object) The configuration for the connector. Configuration properties
34+
(Required^*^, object) The configuration for the connector. Configuration properties
3535
vary depending on the connector type. For example:
3636
+
3737
--
@@ -68,12 +68,15 @@ For more information, refer to
6868
{kibana-ref}/jira-action-type.html[{jira} connector and action].
6969
====
7070

71+
This object is not required for server log connectors.
72+
7173
For more configuration properties, refer to <<action-types>>.
7274
// end::connector-config[]
7375
--
7476

7577
`connector_type_id`::
76-
(Required, string) The connector type ID for the connector.
78+
(Required, string) The connector type ID for the connector. For example,
79+
`.index`, `.jira`, or `.server-log`.
7780

7881
`name`::
7982
(Required, string) The display name for the connector.
@@ -99,6 +102,8 @@ authentication.
99102
`email`::
100103
(Required, string) The account email for HTTP Basic authentication.
101104
====
105+
106+
This object is not required for index or server log connectors.
102107
// end::connector-secrets[]
103108
--
104109

docs/api/actions-and-connectors/execute.asciidoc

+41-4
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,33 @@ If you use an index connector, you must also have `all`, `create`, `index`, or
3434
=== {api-path-parms-title}
3535

3636
`id`::
37-
(Required, string) The ID of the connector.
37+
(Required, string) The ID of the connector.
3838

3939
`space_id`::
40-
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
40+
(Optional, string) An identifier for the space. If `space_id` is not provided in
41+
the URL, the default space is used.
4142

43+
[role="child_attributes"]
4244
[[execute-connector-api-request-body]]
4345
=== {api-request-body-title}
4446

4547
`params`::
46-
(Required, object) The parameters of the connector. Parameter properties vary depending on
47-
the connector type. For information about the parameter properties, refer to <<action-types,Action and connector types>>.
48+
(Required, object) The parameters of the connector. Parameter properties vary
49+
depending on the connector type. For information about the parameter properties,
50+
refer to <<action-types>>.
51+
+
52+
--
53+
.Server log connectors
54+
[%collapsible%open]
55+
====
56+
`level`::
57+
(Optional, string) The log level of the message: `trace`, `debug`, `info`,
58+
`warn`, `error`, or `fatal`. Defaults to `info`.
59+
60+
`message`::
61+
(Required, string) The message to log.
62+
====
63+
--
4864

4965
[[execute-connector-api-codes]]
5066
=== {api-response-codes-title}
@@ -105,3 +121,24 @@ The API returns the following:
105121
"connector_id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad"
106122
}
107123
--------------------------------------------------
124+
125+
Run a server log connector:
126+
127+
[source,sh]
128+
--------------------------------------------------
129+
POST api/actions/connector/7fc7b9a0-ecc9-11ec-8736-e7d63118c907/_execute
130+
{
131+
"params": {
132+
"level": "warn",
133+
"message": "Test warning message"
134+
}
135+
}
136+
--------------------------------------------------
137+
// KIBANA
138+
139+
The API returns the following:
140+
141+
[source,sh]
142+
--------------------------------------------------
143+
{"status":"ok","connector_id":"7fc7b9a0-ecc9-11ec-8736-e7d63118c907"}
144+
--------------------------------------------------

0 commit comments

Comments
 (0)