@@ -34,17 +34,33 @@ If you use an index connector, you must also have `all`, `create`, `index`, or
34
34
=== {api-path-parms-title}
35
35
36
36
`id`::
37
- (Required, string) The ID of the connector.
37
+ (Required, string) The ID of the connector.
38
38
39
39
`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.
41
42
43
+ [role="child_attributes"]
42
44
[[execute-connector-api-request-body]]
43
45
=== {api-request-body-title}
44
46
45
47
`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
+ --
48
64
49
65
[[execute-connector-api-codes]]
50
66
=== {api-response-codes-title}
@@ -105,3 +121,24 @@ The API returns the following:
105
121
"connector_id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad"
106
122
}
107
123
--------------------------------------------------
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