github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Add specifications for deprecated connector APIs (#149637)

Browse source
This commit is contained in:
Lisa Cawley 2023-02-02 07:22:32 -08:00 • committed by GitHub
parent 59488afa5d
commit 83c382b088
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 1660 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

520
docs/api-generated/connectors/connector-apis-passthru.asciidoc
View file

@ -23,6 +23,13 @@ Any modifications made to this file will be overwritten.
<li><a href="#getConnector"><code><span class="http-method">get</span> /s/{spaceId}/api/actions/connector/{connectorId}</code></a></li>
<li><a href="#getConnectorTypes"><code><span class="http-method">get</span> /s/{spaceId}/api/actions/connector_types</code></a></li>
<li><a href="#getConnectors"><code><span class="http-method">get</span> /s/{spaceId}/api/actions/connectors</code></a></li>
<li><a href="#legacyCreateConnector"><code><span class="http-method">post</span> /s/{spaceId}/api/actions</code></a></li>
<li><a href="#legacyDeleteConnector"><code><span class="http-method">delete</span> /s/{spaceId}/api/actions/action/{actionId}</code></a></li>
<li><a href="#legacyGetConnector"><code><span class="http-method">get</span> /s/{spaceId}/api/actions/action/{actionId}</code></a></li>
<li><a href="#legacyGetConnectorTypes"><code><span class="http-method">get</span> /s/{spaceId}/api/actions/list_action_types</code></a></li>
<li><a href="#legacyGetConnectors"><code><span class="http-method">get</span> /s/{spaceId}/api/actions</code></a></li>
<li><a href="#legacyRunConnector"><code><span class="http-method">post</span> /s/{spaceId}/api/actions/action/{actionId}/_execute</code></a></li>
<li><a href="#legacyUpdateConnector"><code><span class="http-method">put</span> /s/{spaceId}/api/actions/action/{actionId}</code></a></li>
<li><a href="#runConnector"><code><span class="http-method">post</span> /s/{spaceId}/api/actions/connector/{connectorId}/_execute</code></a></li>
<li><a href="#updateConnector"><code><span class="http-method">put</span> /s/{spaceId}/api/actions/connector/{connectorId}</code></a></li>
</ul>
@ -60,7 +67,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -116,7 +123,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -316,6 +323,441 @@ Any modifications made to this file will be overwritten.
<a href="#401_response">401_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyCreateConnector"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /s/{spaceId}/api/actions</code></pre></div>
<div class="method-summary">Creates a connector. (<span class="nickname">legacyCreateConnector</span>)</div>
<div class="method-notes">Deprecated in 7.13.0. Use the create connector API instead.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">Legacy_create_connector_request_properties <a href="#Legacy_create_connector_request_properties">Legacy_create_connector_request_properties</a> (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
</div> <!-- field-items -->
<h3 class="field-label">Request headers</h3>
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#action_response_properties">action_response_properties</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"isPreconfigured" : true,
"isDeprecated" : true,
"actionTypeId" : "actionTypeId",
"name" : "name",
"id" : "id",
"config" : "{}",
"isMissingSecrets" : true
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#action_response_properties">action_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyDeleteConnector"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /s/{spaceId}/api/actions/action/{actionId}</code></pre></div>
<div class="method-summary">Deletes a connector. (<span class="nickname">legacyDeleteConnector</span>)</div>
<div class="method-notes">Deprecated in 7.13.0. Use the delete connector API instead. WARNING: When you delete a connector, it cannot be recovered.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">actionId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the action. default: null </div><div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Request headers</h3>
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">204</h4>
Indicates a successful call.
<a href="#"></a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyGetConnector"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/actions/action/{actionId}</code></pre></div>
<div class="method-summary">Retrieves a connector by ID. (<span class="nickname">legacyGetConnector</span>)</div>
<div class="method-notes">Deprecated in 7.13.0. Use the get connector API instead.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">actionId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the action. default: null </div><div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#action_response_properties">action_response_properties</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"isPreconfigured" : true,
"isDeprecated" : true,
"actionTypeId" : "actionTypeId",
"name" : "name",
"id" : "id",
"config" : "{}",
"isMissingSecrets" : true
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#action_response_properties">action_response_properties</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyGetConnectorTypes"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/actions/list_action_types</code></pre></div>
<div class="method-summary">Retrieves a list of all connector types. (<span class="nickname">legacyGetConnectorTypes</span>)</div>
<div class="method-notes">Deprecated in 7.13.0. Use the get all connector types API instead.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
array[<a href="#Legacy_get_connector_types_response_body_properties_inner">Legacy_get_connector_types_response_body_properties_inner</a>]
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"enabledInConfig" : true,
"name" : "name",
"enabledInLicense" : true,
"id" : "id",
"minimumLicenseRequired" : "minimumLicenseRequired",
"enabled" : true
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyGetConnectors"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /s/{spaceId}/api/actions</code></pre></div>
<div class="method-summary">Retrieves all connectors. (<span class="nickname">legacyGetConnectors</span>)</div>
<div class="method-notes">Deprecated in 7.13.0. Use the get all connectors API instead.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
array[<a href="#action_response_properties">action_response_properties</a>]
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"isPreconfigured" : true,
"isDeprecated" : true,
"actionTypeId" : "actionTypeId",
"name" : "name",
"id" : "id",
"config" : "{}",
"isMissingSecrets" : true
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Indicates a successful call.
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyRunConnector"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /s/{spaceId}/api/actions/action/{actionId}/_execute</code></pre></div>
<div class="method-summary">Runs a connector. (<span class="nickname">legacyRunConnector</span>)</div>
<div class="method-notes">Deprecated in 7.13.0. Use the run connector API instead.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">actionId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the action. default: null </div><div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">Legacy_run_connector_request_body_properties <a href="#Legacy_run_connector_request_body_properties">Legacy_run_connector_request_body_properties</a> (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
</div> <!-- field-items -->
<h3 class="field-label">Request headers</h3>
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#legacyRunConnector_200_response">legacyRunConnector_200_response</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"actionId" : "actionId",
"status" : "status"
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#legacyRunConnector_200_response">legacyRunConnector_200_response</a>
<h4 class="field-label">401</h4>
Authorization information is missing or invalid.
<a href="#401_response">401_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="legacyUpdateConnector"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="put"><code class="huge"><span class="http-method">put</span> /s/{spaceId}/api/actions/action/{actionId}</code></pre></div>
<div class="method-summary">Updates the attributes for a connector. (<span class="nickname">legacyUpdateConnector</span>)</div>
<div class="method-notes">Deprecated in 7.13.0. Use the update connector API instead.</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">actionId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the action. default: null </div><div class="param">spaceId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; An identifier for the space. If <code>/s/</code> and the identifier are omitted from the path, the default space is used. default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">Legacy_update_connector_request_body_properties <a href="#Legacy_update_connector_request_body_properties">Legacy_update_connector_request_body_properties</a> (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
</div> <!-- field-items -->
<h3 class="field-label">Request headers</h3>
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#action_response_properties">action_response_properties</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"isPreconfigured" : true,
"isDeprecated" : true,
"actionTypeId" : "actionTypeId",
"name" : "name",
"id" : "id",
"config" : "{}",
"isMissingSecrets" : true
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Indicates a successful call.
<a href="#action_response_properties">action_response_properties</a>
<h4 class="field-label">404</h4>
Object is not found.
<a href="#404_response">404_response</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="runConnector"/>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
@ -350,7 +792,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -421,7 +863,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">kbn-xsrf (required)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; Cross-site request forgery protection default: null </div>
</div> <!-- field-items -->
@ -478,12 +920,17 @@ Any modifications made to this file will be overwritten.
<li><a href="#Create_connector_request_body_properties"><code>Create_connector_request_body_properties</code> - Create connector request body properties</a></li>
<li><a href="#Get_connector_types_response_body_properties_inner"><code>Get_connector_types_response_body_properties_inner</code> - </a></li>
<li><a href="#Get_connectors_response_body_properties"><code>Get_connectors_response_body_properties</code> - Get connectors response body properties</a></li>
<li><a href="#Legacy_create_connector_request_properties"><code>Legacy_create_connector_request_properties</code> - Legacy create connector request properties</a></li>
<li><a href="#Legacy_get_connector_types_response_body_properties_inner"><code>Legacy_get_connector_types_response_body_properties_inner</code> - </a></li>
<li><a href="#Legacy_run_connector_request_body_properties"><code>Legacy_run_connector_request_body_properties</code> - Legacy run connector request body properties</a></li>
<li><a href="#Legacy_update_connector_request_body_properties"><code>Legacy_update_connector_request_body_properties</code> - Legacy update connector request body properties</a></li>
<li><a href="#Rule_name_mapping"><code>Rule_name_mapping</code> - Rule name mapping</a></li>
<li><a href="#Run_connector_request_body_properties"><code>Run_connector_request_body_properties</code> - Run connector request body properties</a></li>
<li><a href="#Run_connector_request_body_properties_params"><code>Run_connector_request_body_properties_params</code> - </a></li>
<li><a href="#Severity_mapping"><code>Severity_mapping</code> - Severity mapping</a></li>
<li><a href="#Subaction_parameters"><code>Subaction_parameters</code> - Subaction parameters</a></li>
<li><a href="#Update_connector_request_body_properties"><code>Update_connector_request_body_properties</code> - Update connector request body properties</a></li>
<li><a href="#action_response_properties"><code>action_response_properties</code> - Action response properties</a></li>
<li><a href="#config_properties_cases_webhook"><code>config_properties_cases_webhook</code> - Connector request properties for Webhook - Case Management connector</a></li>
<li><a href="#config_properties_index"><code>config_properties_index</code> - Connector request properties for an index connector</a></li>
<li><a href="#config_properties_jira"><code>config_properties_jira</code> - Connector request properties for a Jira connector</a></li>
@ -530,6 +977,7 @@ Any modifications made to this file will be overwritten.
<li><a href="#create_connector_request_xmatters"><code>create_connector_request_xmatters</code> - Create xMatters connector request</a></li>
<li><a href="#features"><code>features</code> - </a></li>
<li><a href="#getConnector_404_response"><code>getConnector_404_response</code> - </a></li>
<li><a href="#legacyRunConnector_200_response"><code>legacyRunConnector_200_response</code> - </a></li>
<li><a href="#runConnector_200_response"><code>runConnector_200_response</code> - </a></li>
<li><a href="#runConnector_200_response_data"><code>runConnector_200_response_data</code> - </a></li>
<li><a href="#run_connector_params_documents"><code>run_connector_params_documents</code> - Index connector parameters</a></li>
@ -708,6 +1156,44 @@ Any modifications made to this file will be overwritten.
<div class="param">referenced_by_count </div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Indicates the number of saved objects that reference the connector. If <code>is_preconfigured</code> is true, this value is not calculated. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Legacy_create_connector_request_properties"><code>Legacy_create_connector_request_properties</code> - Legacy create connector request properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">actionTypeId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The connector type identifier. </div>
<div class="param">config (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> The configuration for the connector. Configuration properties vary depending on the connector type. </div>
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
<div class="param">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> The secrets configuration for the connector. Secrets configuration properties vary depending on the connector type. NOTE: Remember these values. You must provide them each time you update the connector. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Legacy_get_connector_types_response_body_properties_inner"><code>Legacy_get_connector_types_response_body_properties_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">enabled (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector type is enabled in Kibana. </div>
<div class="param">enabledInConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector type is enabled in the Kibana <code>.yml</code> file. </div>
<div class="param">enabledInLicense (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is enabled in the license. </div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The unique identifier for the connector type. </div>
<div class="param">minimumLicenseRequired (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The license that is required to use the connector type. </div>
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the connector type. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Legacy_run_connector_request_body_properties"><code>Legacy_run_connector_request_body_properties</code> - Legacy run connector request body properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The properties vary depending on the connector type.</div>
<div class="field-items">
<div class="param">params </div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> The parameters of the connector. Parameter properties vary depending on the connector type. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Legacy_update_connector_request_body_properties"><code>Legacy_update_connector_request_body_properties</code> - Legacy update connector request body properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The properties vary depending on the connector type.</div>
<div class="field-items">
<div class="param">config (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> The new connector configuration. Configuration properties vary depending on the connector type. </div>
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The new name for the connector. </div>
<div class="param">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> The updated secrets configuration for the connector. Secrets properties vary depending on the connector type. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Rule_name_mapping"><code>Rule_name_mapping</code> - Rule name mapping</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Mapping for the name of the alert's rule.</div>
@ -769,6 +1255,19 @@ Any modifications made to this file will be overwritten.
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_swimlane">secrets_properties_swimlane</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="action_response_properties"><code>action_response_properties</code> - Action response properties</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>The properties vary depending on the action type.</div>
<div class="field-items">
<div class="param">actionTypeId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">config (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">isDeprecated (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the action type is deprecated. </div>
<div class="param">isMissingSecrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether secrets are missing for the action. </div>
<div class="param">isPreconfigured (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether it is a preconfigured action. </div>
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="config_properties_cases_webhook"><code>config_properties_cases_webhook</code> - Connector request properties for Webhook - Case Management connector</a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Defines properties for connectors when type is <code>.cases-webhook</code>.</div>
@ -834,7 +1333,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The ServiceNow instance URL. </div>
<div class="param">clientId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The client ID assigned to your OAuth application. This property is required when <code>isOAuth</code> is <code>true</code>. </div>
<div class="param">isOAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth). </div>
<div class="param">isOAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth). </div>
<div class="param">jwtKeyId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when <code>isOAuth</code> is <code>true</code>. </div>
<div class="param">userIdentifierValue (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier to use for OAuth authentication. This identifier should be the user field you selected when you created an OAuth JWT API endpoint for external clients in your ServiceNow instance. For example, if the selected user field is <code>Email</code>, the user identifier should be the user's email address. This property is required when <code>isOAuth</code> is <code>true</code>. </div>
<div class="param">usesTableApi (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Determines whether the connector uses the Table API or the Import Set API. This property is supported only for ServiceNow ITSM and ServiceNow SecOps connectors. NOTE: If this property is set to <code>false</code>, the Elastic application should be installed in ServiceNow. </div>
@ -846,7 +1345,7 @@ Any modifications made to this file will be overwritten.
<div class="field-items">
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The ServiceNow instance URL. </div>
<div class="param">clientId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The client ID assigned to your OAuth application. This property is required when <code>isOAuth</code> is <code>true</code>. </div>
<div class="param">isOAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth). </div>
<div class="param">isOAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth). </div>
<div class="param">jwtKeyId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when <code>isOAuth</code> is <code>true</code>. </div>
<div class="param">userIdentifierValue (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier to use for OAuth authentication. This identifier should be the user field you selected when you created an OAuth JWT API endpoint for external clients in your ServiceNow instance. For example, if the selected user field is <code>Email</code>, the user identifier should be the user's email address. This property is required when <code>isOAuth</code> is <code>true</code>. </div>
</div> <!-- field-items -->
@ -1351,6 +1850,15 @@ Any modifications made to this file will be overwritten.
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="legacyRunConnector_200_response"><code>legacyRunConnector_200_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">actionId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">data (optional)</div><div class="param-desc"><span class="param-type"><a href="#runConnector_200_response_data">runConnector_200_response_data</a></span> </div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The status of the action. </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="runConnector_200_response"><code>runConnector_200_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>

514
x-pack/plugins/actions/docs/openapi/bundled.json
View file

@ -816,6 +816,474 @@
"url": "https://localhost:5601"
}
]
},
"/s/{spaceId}/api/actions/action/{actionId}": {
"delete": {
"summary": "Deletes a connector.",
"operationId": "legacyDeleteConnector",
"deprecated": true,
"description": "Deprecated in 7.13.0. Use the delete connector API instead. WARNING: When you delete a connector, it cannot be recovered.\n",
"tags": [
"connectors"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"$ref": "#/components/parameters/action_id"
},
{
"$ref": "#/components/parameters/space_id"
}
],
"responses": {
"204": {
"description": "Indicates a successful call."
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"get": {
"summary": "Retrieves a connector by ID.",
"operationId": "legacyGetConnector",
"description": "Deprecated in 7.13.0. Use the get connector API instead.",
"deprecated": true,
"tags": [
"connectors"
],
"parameters": [
{
"$ref": "#/components/parameters/action_id"
},
{
"$ref": "#/components/parameters/space_id"
}
],
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/action_response_properties"
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"put": {
"summary": "Updates the attributes for a connector.",
"operationId": "legacyUpdateConnector",
"deprecated": true,
"description": "Deprecated in 7.13.0. Use the update connector API instead.",
"tags": [
"connectors"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"$ref": "#/components/parameters/action_id"
},
{
"$ref": "#/components/parameters/space_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"title": "Legacy update connector request body properties",
"description": "The properties vary depending on the connector type.",
"type": "object",
"properties": {
"config": {
"type": "object",
"description": "The new connector configuration. Configuration properties vary depending on the connector type."
},
"name": {
"type": "string",
"description": "The new name for the connector."
},
"secrets": {
"type": "object",
"description": "The updated secrets configuration for the connector. Secrets properties vary depending on the connector type."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/action_response_properties"
}
}
}
},
"404": {
"description": "Object is not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/s/{spaceId}/api/actions": {
"get": {
"summary": "Retrieves all connectors.",
"operationId": "legacyGetConnectors",
"deprecated": true,
"description": "Deprecated in 7.13.0. Use the get all connectors API instead.",
"tags": [
"connectors"
],
"parameters": [
{
"$ref": "#/components/parameters/space_id"
}
],
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/action_response_properties"
}
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"post": {
"summary": "Creates a connector.",
"operationId": "legacyCreateConnector",
"deprecated": true,
"description": "Deprecated in 7.13.0. Use the create connector API instead.",
"tags": [
"connectors"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"$ref": "#/components/parameters/space_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"title": "Legacy create connector request properties",
"type": "object",
"properties": {
"actionTypeId": {
"type": "string",
"description": "The connector type identifier."
},
"config": {
"type": "object",
"description": "The configuration for the connector. Configuration properties vary depending on the connector type."
},
"name": {
"type": "string",
"description": "The display name for the connector."
},
"secrets": {
"type": "object",
"description": "The secrets configuration for the connector. Secrets configuration properties vary depending on the connector type. NOTE: Remember these values. You must provide them each time you update the connector.\n"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/action_response_properties"
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/s/{spaceId}/api/actions/list_action_types": {
"get": {
"summary": "Retrieves a list of all connector types.",
"operationId": "legacyGetConnectorTypes",
"deprecated": true,
"description": "Deprecated in 7.13.0. Use the get all connector types API instead.",
"tags": [
"connectors"
],
"parameters": [
{
"$ref": "#/components/parameters/space_id"
}
],
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"title": "Legacy get connector types response body properties",
"description": "The properties vary for each connector type.",
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the connector type is enabled in Kibana."
},
"enabledInConfig": {
"type": "boolean",
"description": "Indicates whether the connector type is enabled in the Kibana `.yml` file."
},
"enabledInLicense": {
"type": "boolean",
"description": "Indicates whether the connector is enabled in the license.",
"example": true
},
"id": {
"type": "string",
"description": "The unique identifier for the connector type."
},
"minimumLicenseRequired": {
"type": "string",
"description": "The license that is required to use the connector type."
},
"name": {
"type": "string",
"description": "The name of the connector type."
}
}
}
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/s/{spaceId}/api/actions/action/{actionId}/_execute": {
"post": {
"summary": "Runs a connector.",
"operationId": "legacyRunConnector",
"deprecated": true,
"description": "Deprecated in 7.13.0. Use the run connector API instead.",
"tags": [
"connectors"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"$ref": "#/components/parameters/action_id"
},
{
"$ref": "#/components/parameters/space_id"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"title": "Legacy run connector request body properties",
"description": "The properties vary depending on the connector type.",
"type": "object",
"required": [
"params"
],
"properties": {
"params": {
"type": "object",
"description": "The parameters of the connector. Parameter properties vary depending on the connector type."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"actionId": {
"type": "string"
},
"data": {
"oneOf": [
{
"type": "object",
"description": "Information returned from the action.",
"additionalProperties": true
},
{
"type": "array",
"description": "An array of information returned from the action.",
"items": {
"type": "object"
}
}
]
},
"status": {
"type": "string",
"description": "The status of the action."
}
}
}
}
}
},
"401": {
"description": "Authorization information is missing or invalid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"components": {
@ -837,6 +1305,7 @@
},
"in": "header",
"name": "kbn-xsrf",
"description": "Cross-site request forgery protection",
"required": true
},
"space_id": {
@ -858,6 +1327,16 @@
"type": "string",
"example": "df770e30-8b8b-11ed-a780-3b746c987a81"
}
},
"action_id": {
"in": "path",
"name": "actionId",
"description": "An identifier for the action.",
"required": true,
"schema": {
"type": "string",
"example": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad"
}
}
},
"schemas": {
@ -1421,7 +1900,7 @@
"isOAuth": {
"description": "The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).\n",
"default": false,
"type": "string"
"type": "boolean"
},
"jwtKeyId": {
"description": "The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.\n",
@ -1516,7 +1995,7 @@
"isOAuth": {
"description": "The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).\n",
"default": false,
"type": "string"
"type": "boolean"
},
"jwtKeyId": {
"description": "The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.\n",
@ -3779,6 +4258,37 @@
}
}
}
},
"action_response_properties": {
"title": "Action response properties",
"description": "The properties vary depending on the action type.",
"type": "object",
"properties": {
"actionTypeId": {
"type": "string"
},
"config": {
"type": "object"
},
"id": {
"type": "string"
},
"isDeprecated": {
"type": "boolean",
"description": "Indicates whether the action type is deprecated."
},
"isMissingSecrets": {
"type": "boolean",
"description": "Indicates whether secrets are missing for the action."
},
"isPreconfigured": {
"type": "boolean",
"description": "Indicates whether it is a preconfigured action."
},
"name": {
"type": "string"
}
}
}
},
"examples": {

314
x-pack/plugins/actions/docs/openapi/bundled.yaml
View file

@ -472,6 +472,285 @@ paths:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/actions/action/{actionId}:
delete:
summary: Deletes a connector.
operationId: legacyDeleteConnector
deprecated: true
description: |
Deprecated in 7.13.0. Use the delete connector API instead. WARNING: When you delete a connector, it cannot be recovered.
tags:
- connectors
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- $ref: '#/components/parameters/action_id'
- $ref: '#/components/parameters/space_id'
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
get:
summary: Retrieves a connector by ID.
operationId: legacyGetConnector
description: Deprecated in 7.13.0. Use the get connector API instead.
deprecated: true
tags:
- connectors
parameters:
- $ref: '#/components/parameters/action_id'
- $ref: '#/components/parameters/space_id'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '#/components/schemas/action_response_properties'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
put:
summary: Updates the attributes for a connector.
operationId: legacyUpdateConnector
deprecated: true
description: Deprecated in 7.13.0. Use the update connector API instead.
tags:
- connectors
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- $ref: '#/components/parameters/action_id'
- $ref: '#/components/parameters/space_id'
requestBody:
required: true
content:
application/json:
schema:
title: Legacy update connector request body properties
description: The properties vary depending on the connector type.
type: object
properties:
config:
type: object
description: The new connector configuration. Configuration properties vary depending on the connector type.
name:
type: string
description: The new name for the connector.
secrets:
type: object
description: The updated secrets configuration for the connector. Secrets properties vary depending on the connector type.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '#/components/schemas/action_response_properties'
'404':
description: Object is not found.
content:
application/json:
schema:
$ref: '#/components/schemas/404_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/actions:
get:
summary: Retrieves all connectors.
operationId: legacyGetConnectors
deprecated: true
description: Deprecated in 7.13.0. Use the get all connectors API instead.
tags:
- connectors
parameters:
- $ref: '#/components/parameters/space_id'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/action_response_properties'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
post:
summary: Creates a connector.
operationId: legacyCreateConnector
deprecated: true
description: Deprecated in 7.13.0. Use the create connector API instead.
tags:
- connectors
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- $ref: '#/components/parameters/space_id'
requestBody:
required: true
content:
application/json:
schema:
title: Legacy create connector request properties
type: object
properties:
actionTypeId:
type: string
description: The connector type identifier.
config:
type: object
description: The configuration for the connector. Configuration properties vary depending on the connector type.
name:
type: string
description: The display name for the connector.
secrets:
type: object
description: |
The secrets configuration for the connector. Secrets configuration properties vary depending on the connector type. NOTE: Remember these values. You must provide them each time you update the connector.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '#/components/schemas/action_response_properties'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/actions/list_action_types:
get:
summary: Retrieves a list of all connector types.
operationId: legacyGetConnectorTypes
deprecated: true
description: Deprecated in 7.13.0. Use the get all connector types API instead.
tags:
- connectors
parameters:
- $ref: '#/components/parameters/space_id'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
title: Legacy get connector types response body properties
description: The properties vary for each connector type.
type: array
items:
type: object
properties:
enabled:
type: boolean
description: Indicates whether the connector type is enabled in Kibana.
enabledInConfig:
type: boolean
description: Indicates whether the connector type is enabled in the Kibana `.yml` file.
enabledInLicense:
type: boolean
description: Indicates whether the connector is enabled in the license.
example: true
id:
type: string
description: The unique identifier for the connector type.
minimumLicenseRequired:
type: string
description: The license that is required to use the connector type.
name:
type: string
description: The name of the connector type.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/actions/action/{actionId}/_execute:
post:
summary: Runs a connector.
operationId: legacyRunConnector
deprecated: true
description: Deprecated in 7.13.0. Use the run connector API instead.
tags:
- connectors
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- $ref: '#/components/parameters/action_id'
- $ref: '#/components/parameters/space_id'
requestBody:
required: true
content:
application/json:
schema:
title: Legacy run connector request body properties
description: The properties vary depending on the connector type.
type: object
required:
- params
properties:
params:
type: object
description: The parameters of the connector. Parameter properties vary depending on the connector type.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
properties:
actionId:
type: string
data:
oneOf:
- type: object
description: Information returned from the action.
additionalProperties: true
- type: array
description: An array of information returned from the action.
items:
type: object
status:
type: string
description: The status of the action.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
components:
securitySchemes:
basicAuth:
@ -487,6 +766,7 @@ components:
type: string
in: header
name: kbn-xsrf
description: Cross-site request forgery protection
required: true
space_id:
in: path
@ -504,6 +784,14 @@ components:
schema:
type: string
example: df770e30-8b8b-11ed-a780-3b746c987a81
action_id:
in: path
name: actionId
description: An identifier for the action.
required: true
schema:
type: string
example: c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
schemas:
config_properties_cases_webhook:
title: Connector request properties for Webhook - Case Management connector
@ -945,7 +1233,7 @@ components:
description: |
The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).
default: false
type: string
type: boolean
jwtKeyId:
description: |
The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.
@ -1022,7 +1310,7 @@ components:
description: |
The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).
default: false
type: string
type: boolean
jwtKeyId:
description: |
The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.
@ -2671,6 +2959,28 @@ components:
urgency:
type: string
description: The urgency of the incident for ServiceNow ITSM connectors.
action_response_properties:
title: Action response properties
description: The properties vary depending on the action type.
type: object
properties:
actionTypeId:
type: string
config:
type: object
id:
type: string
isDeprecated:
type: boolean
description: Indicates whether the action type is deprecated.
isMissingSecrets:
type: boolean
description: Indicates whether secrets are missing for the action.
isPreconfigured:
type: boolean
description: Indicates whether it is a preconfigured action.
name:
type: string
examples:
create_index_connector_request:
summary: Create an index connector.

1
x-pack/plugins/actions/docs/openapi/components/headers/kbn_xsrf.yaml
View file

@ -2,4 +2,5 @@ schema:
type: string
in: header
name: kbn-xsrf
description: Cross-site request forgery protection
required: true

7
x-pack/plugins/actions/docs/openapi/components/parameters/action_id.yaml Normal file
View file

@ -0,0 +1,7 @@
in: path
name: actionId
description: An identifier for the action.
required: true
schema:
type: string
example: c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad

21
x-pack/plugins/actions/docs/openapi/components/schemas/action_response_properties.yaml Normal file
View file

@ -0,0 +1,21 @@
title: Action response properties
description: The properties vary depending on the action type.
type: object
properties:
actionTypeId:
type: string
config:
type: object
id:
type: string
isDeprecated:
type: boolean
description: Indicates whether the action type is deprecated.
isMissingSecrets:
type: boolean
description: Indicates whether secrets are missing for the action.
isPreconfigured:
type: boolean
description: Indicates whether it is a preconfigured action.
name:
type: string

2
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_servicenow.yaml
View file

@ -17,7 +17,7 @@ properties:
The type of authentication to use. The default value is false, which means
basic authentication is used instead of open authorization (OAuth).
default: false
type: string
type: boolean
jwtKeyId:
description: >
The key identifier assigned to the JWT verifier map of your OAuth application.

2
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_servicenow_itom.yaml
View file

@ -17,7 +17,7 @@ properties:
The type of authentication to use. The default value is false, which means
basic authentication is used instead of open authorization (OAuth).
default: false
type: string
type: boolean
jwtKeyId:
description: >
The key identifier assigned to the JWT verifier map of your OAuth application.

18
x-pack/plugins/actions/docs/openapi/entrypoint.yaml
View file

@ -26,16 +26,14 @@ paths:
'/s/{spaceId}/api/actions/connector/{connectorId}/_execute':
$ref: paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml
# Deprecated endpoints:
# '/s/{spaceId}/api/actions/action/{actionId}':
# $ref: 'paths/s@{spaceid}@api@actions@action@{actionid}.yaml'
# '/s/{spaceId}/api/actions':
# $ref: 'paths/s@{spaceid}@api@actions.yaml'
# '/s/{spaceId}/api/actions/list_action_types':
# $ref: 'paths/s@{spaceid}@api@actions@list_action_types.yaml'
# '/s/{spaceId}/api/actions/action':
# $ref: 'paths/s@{spaceid}@api@actions@action.yaml'
# '/s/{spaceId}/api/actions/action/{actionId}/_execute':
# $ref: 'paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml'
'/s/{spaceId}/api/actions/action/{actionId}':
$ref: 'paths/s@{spaceid}@api@actions@action@{actionid}.yaml'
'/s/{spaceId}/api/actions':
$ref: 'paths/s@{spaceid}@api@actions.yaml'
'/s/{spaceId}/api/actions/list_action_types':
$ref: 'paths/s@{spaceid}@api@actions@list_action_types.yaml'
'/s/{spaceId}/api/actions/action/{actionId}/_execute':
$ref: 'paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml'
components:
securitySchemes:
basicAuth:

78
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions.yaml Normal file
View file

@ -0,0 +1,78 @@
get:
summary: Retrieves all connectors.
operationId: legacyGetConnectors
deprecated: true
description: Deprecated in 7.13.0. Use the get all connectors API instead.
tags:
- connectors
parameters:
- $ref: '../components/parameters/space_id.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: array
items:
$ref: '../components/schemas/action_response_properties.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
post:
summary: Creates a connector.
operationId: legacyCreateConnector
deprecated: true
description: Deprecated in 7.13.0. Use the create connector API instead.
tags:
- connectors
parameters:
- $ref: '../components/headers/kbn_xsrf.yaml'
- $ref: '../components/parameters/space_id.yaml'
requestBody:
required: true
content:
application/json:
schema:
title: Legacy create connector request properties
type: object
properties:
actionTypeId:
type: string
description: The connector type identifier.
config:
type: object
description: The configuration for the connector. Configuration properties vary depending on the connector type.
name:
type: string
description: The display name for the connector.
secrets:
type: object
description: >
The secrets configuration for the connector.
Secrets configuration properties vary depending on the connector type.
NOTE: Remember these values. You must provide them each time you update the connector.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../components/schemas/action_response_properties.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

98
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@action@{actionid}.yaml Normal file
View file

@ -0,0 +1,98 @@
delete:
summary: Deletes a connector.
operationId: legacyDeleteConnector
deprecated: true
description: >
Deprecated in 7.13.0. Use the delete connector API instead.
WARNING: When you delete a connector, it cannot be recovered.
tags:
- connectors
parameters:
- $ref: '../components/headers/kbn_xsrf.yaml'
- $ref: '../components/parameters/action_id.yaml'
- $ref: '../components/parameters/space_id.yaml'
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
get:
summary: Retrieves a connector by ID.
operationId: legacyGetConnector
description: Deprecated in 7.13.0. Use the get connector API instead.
deprecated: true
tags:
- connectors
parameters:
- $ref: '../components/parameters/action_id.yaml'
- $ref: '../components/parameters/space_id.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../components/schemas/action_response_properties.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
put:
summary: Updates the attributes for a connector.
operationId: legacyUpdateConnector
deprecated: true
description: Deprecated in 7.13.0. Use the update connector API instead.
tags:
- connectors
parameters:
- $ref: '../components/headers/kbn_xsrf.yaml'
- $ref: '../components/parameters/action_id.yaml'
- $ref: '../components/parameters/space_id.yaml'
requestBody:
required: true
content:
application/json:
schema:
title: Legacy update connector request body properties
description: The properties vary depending on the connector type.
type: object
properties:
config:
type: object
description: The new connector configuration. Configuration properties vary depending on the connector type.
name:
type: string
description: The new name for the connector.
secrets:
type: object
description: The updated secrets configuration for the connector. Secrets properties vary depending on the connector type.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../components/schemas/action_response_properties.yaml'
'404':
description: Object is not found.
content:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

57
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml Normal file
View file

@ -0,0 +1,57 @@
post:
summary: Runs a connector.
operationId: legacyRunConnector
deprecated: true
description: Deprecated in 7.13.0. Use the run connector API instead.
tags:
- connectors
parameters:
- $ref: '../components/headers/kbn_xsrf.yaml'
- $ref: '../components/parameters/action_id.yaml'
- $ref: '../components/parameters/space_id.yaml'
requestBody:
required: true
content:
application/json:
schema:
title: Legacy run connector request body properties
description: The properties vary depending on the connector type.
type: object
required:
- params
properties:
params:
type: object
description: The parameters of the connector. Parameter properties vary depending on the connector type.
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
properties:
actionId:
type: string
data:
oneOf:
- type: object
description: Information returned from the action.
additionalProperties: true
- type: array
description: An array of information returned from the action.
items:
type: object
status:
type: string
description: The status of the action.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

50
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@list_action_types.yaml Normal file
View file

@ -0,0 +1,50 @@
get:
summary: Retrieves a list of all connector types.
operationId: legacyGetConnectorTypes
deprecated: true
description: Deprecated in 7.13.0. Use the get all connector types API instead.
tags:
- connectors
parameters:
- $ref: '../components/parameters/space_id.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
title: Legacy get connector types response body properties
description: The properties vary for each connector type.
type: array
items:
type: object
properties:
enabled:
type: boolean
description: Indicates whether the connector type is enabled in Kibana.
enabledInConfig:
type: boolean
description: Indicates whether the connector type is enabled in the Kibana `.yml` file.
enabledInLicense:
type: boolean
description: Indicates whether the connector is enabled in the license.
example: true
id:
type: string
description: The unique identifier for the connector type.
minimumLicenseRequired:
type: string
description: The license that is required to use the connector type.
name:
type: string
description: The name of the connector type.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601