mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[DOCS] Create open API specification for delete/get connectors (#148360)
This commit is contained in:
parent
b7ff3549ec
commit
a077a1d468
17 changed files with 918 additions and 20 deletions
|
@ -16,12 +16,110 @@ Any modifications made to this file will be overwritten.
|
|||
|
||||
<h3>Table of Contents </h3>
|
||||
<div class="method-summary"></div>
|
||||
<h4><a href="#Cases">Cases</a></h4>
|
||||
<h4><a href="#Connectors">Connectors</a></h4>
|
||||
<ul>
|
||||
<li><a href="#deleteConnector"><code><span class="http-method">delete</span> /s/{spaceId}/api/actions/connector/{connectorId}</code></a></li>
|
||||
<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>
|
||||
</ul>
|
||||
|
||||
<h1><a name="Cases">Cases</a></h1>
|
||||
<h1><a name="Connectors">Connectors</a></h1>
|
||||
<div class="method"><a name="deleteConnector"/>
|
||||
<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/connector/{connectorId}</code></pre></div>
|
||||
<div class="method-summary">Deletes a connector. (<span class="nickname">deleteConnector</span>)</div>
|
||||
<div class="method-notes">You must have <code>all</code> privileges for the <strong>Actions and Connectors</strong> feature in the <strong>Management</strong> section of the Kibana feature privileges. 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">connectorId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the connector. default: null </div><div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — 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> — default: null </div>
|
||||
|
||||
</div> <!-- field-items -->
|
||||
|
||||
|
||||
|
||||
|
||||
<!--Todo: process Response Object and its headers, schema, examples -->
|
||||
|
||||
|
||||
|
||||
<h3 class="field-label">Responses</h3>
|
||||
<h4 class="field-label">204</h4>
|
||||
Indicates a successful call.
|
||||
<a href="#"></a>
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getConnector"/>
|
||||
<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/connector/{connectorId}</code></pre></div>
|
||||
<div class="method-summary">Retrieves a connector by ID. (<span class="nickname">getConnector</span>)</div>
|
||||
<div class="method-notes">You must have <code>read</code> privileges for the <strong>Actions and Connectors</strong> feature in the <strong>Management</strong> section of the Kibana feature privileges.</div>
|
||||
|
||||
<h3 class="field-label">Path parameters</h3>
|
||||
<div class="field-items">
|
||||
<div class="param">connectorId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — An identifier for the connector. default: null </div><div class="param">spaceId (required)</div>
|
||||
|
||||
<div class="param-desc"><span class="param-type">Path Parameter</span> — 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="#getConnector_200_response">getConnector_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>{
|
||||
"is_missing_secrets" : false,
|
||||
"is_deprecated" : false,
|
||||
"is_preconfigured" : false,
|
||||
"name" : "my-connector",
|
||||
"id" : "b0766e10-d190-11ec-b04c-776c77d14fca",
|
||||
"config" : {
|
||||
"key" : ""
|
||||
},
|
||||
"connector_type_id" : ".server-log"
|
||||
}</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="#getConnector_200_response">getConnector_200_response</a>
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getConnectorTypes"/>
|
||||
<div class="method-path">
|
||||
<a class="up" href="#__Methods">Up</a>
|
||||
|
@ -61,7 +159,7 @@ Any modifications made to this file will be overwritten.
|
|||
"supported_feature_ids" : [ "alerting", "uptime", "siem" ],
|
||||
"name" : "Index",
|
||||
"enabled_in_license" : true,
|
||||
"id" : ".index",
|
||||
"id" : ".server-log",
|
||||
"enabled_in_config" : true,
|
||||
"minimum_license_required" : "basic",
|
||||
"enabled" : true
|
||||
|
@ -78,6 +176,61 @@ Any modifications made to this file will be overwritten.
|
|||
<h4 class="field-label">200</h4>
|
||||
Indicates a successful call.
|
||||
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
<div class="method"><a name="getConnectors"/>
|
||||
<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/connectors</code></pre></div>
|
||||
<div class="method-summary">Retrieves all connectors. (<span class="nickname">getConnectors</span>)</div>
|
||||
<div class="method-notes">You must have <code>read</code> privileges for the <strong>Actions and Connectors</strong> feature in the <strong>Management</strong> section of the Kibana feature privileges.</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> — 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="#getConnectors_200_response_inner">getConnectors_200_response_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>{
|
||||
"is_missing_secrets" : false,
|
||||
"is_deprecated" : false,
|
||||
"is_preconfigured" : false,
|
||||
"name" : "my-connector",
|
||||
"referenced_by_count" : 2,
|
||||
"id" : "b0766e10-d190-11ec-b04c-776c77d14fca",
|
||||
"config" : {
|
||||
"key" : ""
|
||||
},
|
||||
"connector_type_id" : ".server-log"
|
||||
}</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.
|
||||
|
||||
</div> <!-- method -->
|
||||
<hr/>
|
||||
|
||||
|
@ -86,10 +239,19 @@ Any modifications made to this file will be overwritten.
|
|||
|
||||
<h3>Table of Contents</h3>
|
||||
<ol>
|
||||
<li><a href="#connector_types"><code>connector_types</code> - </a></li>
|
||||
<li><a href="#features"><code>features</code> - </a></li>
|
||||
<li><a href="#getConnectorTypes_200_response_inner"><code>getConnectorTypes_200_response_inner</code> - </a></li>
|
||||
<li><a href="#getConnector_200_response"><code>getConnector_200_response</code> - </a></li>
|
||||
<li><a href="#getConnectors_200_response_inner"><code>getConnectors_200_response_inner</code> - </a></li>
|
||||
</ol>
|
||||
|
||||
<div class="model">
|
||||
<h3><a name="connector_types"><code>connector_types</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'>The type of connector. For example, <code>.email</code>, <code>.index</code>, <code>.jira</code>, <code>.opsgenie</code>, or <code>.server-log</code>.</div>
|
||||
<div class="field-items">
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="features"><code>features</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'>The feature that uses the connector. Valid values are <code>alerting</code>, <code>cases</code>, <code>uptime</code>, and <code>siem</code>.</div>
|
||||
|
@ -103,11 +265,38 @@ Any modifications made to this file will be overwritten.
|
|||
<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">enabled_in_config (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">enabled_in_license (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">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#connector_types">connector_types</a></span> </div>
|
||||
<div class="param">minimum_license_required (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 class="param">supported_feature_ids (optional)</div><div class="param-desc"><span class="param-type"><a href="#features">array[features]</a></span> The Kibana features that are supported by the connector type. </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getConnector_200_response"><code>getConnector_200_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
<div class="param">config (optional)</div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> The configuration for the connector. Configuration properties vary depending on the connector type. </div>
|
||||
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#connector_types">connector_types</a></span> </div>
|
||||
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. </div>
|
||||
<div class="param">is_deprecated </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector type is deprecated. </div>
|
||||
<div class="param">is_missing_secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type. </div>
|
||||
<div class="param">is_preconfigured </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether it is a preconfigured connector. If true, the <code>config</code> and <code>is_missing_secrets</code> properties are omitted from the response. </div>
|
||||
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
|
||||
</div> <!-- field-items -->
|
||||
</div>
|
||||
<div class="model">
|
||||
<h3><a name="getConnectors_200_response_inner"><code>getConnectors_200_response_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||
<div class='model-description'></div>
|
||||
<div class="field-items">
|
||||
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#connector_types">connector_types</a></span> </div>
|
||||
<div class="param">config (optional)</div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> The configuration for the connector. Configuration properties vary depending on the connector type. </div>
|
||||
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the connector. </div>
|
||||
<div class="param">is_deprecated </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector type is deprecated. </div>
|
||||
<div class="param">is_missing_secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type. </div>
|
||||
<div class="param">is_preconfigured </div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether it is a preconfigured connector. If true, the <code>config</code> and <code>is_missing_secrets</code> properties are omitted from the response. </div>
|
||||
<div class="param">name </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">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>
|
||||
++++
|
||||
|
|
|
@ -8,6 +8,12 @@ Deletes an connector by ID.
|
|||
|
||||
WARNING: When you delete a connector, _it cannot be recovered_.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For the most up-to-date API details, refer to the
|
||||
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
|
||||
====
|
||||
|
||||
[discrete]
|
||||
[[delete-connector-api-request]]
|
||||
=== {api-request-title}
|
||||
|
|
|
@ -6,6 +6,12 @@
|
|||
|
||||
Retrieves a connector by ID.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For the most up-to-date API details, refer to the
|
||||
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
|
||||
====
|
||||
|
||||
[discrete]
|
||||
[[get-connector-api-request]]
|
||||
=== {api-request-title}
|
||||
|
|
|
@ -6,6 +6,12 @@
|
|||
|
||||
Retrieves all connectors.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For the most up-to-date API details, refer to the
|
||||
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
|
||||
====
|
||||
|
||||
[discrete]
|
||||
[[get-all-connectors-api-request]]
|
||||
=== {api-request-title}
|
||||
|
|
|
@ -25,13 +25,213 @@
|
|||
}
|
||||
],
|
||||
"paths": {
|
||||
"/s/{spaceId}/api/actions/connector/{connectorId}": {
|
||||
"get": {
|
||||
"summary": "Retrieves a connector by ID.",
|
||||
"operationId": "getConnector",
|
||||
"description": "You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
|
||||
"tags": [
|
||||
"connectors"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/connector_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"connector_type_id",
|
||||
"id",
|
||||
"is_deprecated",
|
||||
"is_preconfigured",
|
||||
"name"
|
||||
],
|
||||
"properties": {
|
||||
"config": {
|
||||
"type": "object",
|
||||
"description": "The configuration for the connector. Configuration properties vary depending on the connector type.",
|
||||
"additionalProperties": true,
|
||||
"nullable": true
|
||||
},
|
||||
"connector_type_id": {
|
||||
"$ref": "#/components/schemas/connector_types"
|
||||
},
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The identifier for the connector.",
|
||||
"example": "b0766e10-d190-11ec-b04c-776c77d14fca"
|
||||
},
|
||||
"is_deprecated": {
|
||||
"$ref": "#/components/schemas/is_deprecated"
|
||||
},
|
||||
"is_missing_secrets": {
|
||||
"$ref": "#/components/schemas/is_missing_secrets"
|
||||
},
|
||||
"is_preconfigured": {
|
||||
"$ref": "#/components/schemas/is_preconfigured"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"example": "my-connector"
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"getConnectorResponse": {
|
||||
"$ref": "#/components/examples/get_connector_response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes a connector.",
|
||||
"operationId": "deleteConnector",
|
||||
"description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. WARNING: When you delete a connector, it cannot be recovered.\n",
|
||||
"tags": [
|
||||
"connectors"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/kbn_xsrf"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/connector_id"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "Indicates a successful call."
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/actions/connectors": {
|
||||
"get": {
|
||||
"summary": "Retrieves all connectors.",
|
||||
"operationId": "getConnectors",
|
||||
"description": "You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
|
||||
"tags": [
|
||||
"connectors"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"$ref": "#/components/parameters/space_id"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Indicates a successful call.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"connector_type_id",
|
||||
"id",
|
||||
"is_deprecated",
|
||||
"is_preconfigured",
|
||||
"name",
|
||||
"referenced_by_count"
|
||||
],
|
||||
"properties": {
|
||||
"connector_type_id": {
|
||||
"$ref": "#/components/schemas/connector_types"
|
||||
},
|
||||
"config": {
|
||||
"type": "object",
|
||||
"description": "The configuration for the connector. Configuration properties vary depending on the connector type.",
|
||||
"additionalProperties": true,
|
||||
"nullable": true
|
||||
},
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The identifier for the connector.",
|
||||
"example": "b0766e10-d190-11ec-b04c-776c77d14fca"
|
||||
},
|
||||
"is_deprecated": {
|
||||
"$ref": "#/components/schemas/is_deprecated"
|
||||
},
|
||||
"is_missing_secrets": {
|
||||
"$ref": "#/components/schemas/is_missing_secrets"
|
||||
},
|
||||
"is_preconfigured": {
|
||||
"$ref": "#/components/schemas/is_preconfigured"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"example": "my-connector"
|
||||
},
|
||||
"referenced_by_count": {
|
||||
"type": "integer",
|
||||
"description": "Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated.",
|
||||
"example": 2,
|
||||
"default": 0
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"getConnectorsResponse": {
|
||||
"$ref": "#/components/examples/get_connectors_response"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://localhost:5601"
|
||||
}
|
||||
]
|
||||
},
|
||||
"/s/{spaceId}/api/actions/connector_types": {
|
||||
"get": {
|
||||
"summary": "Retrieves a list of all connector types.",
|
||||
"operationId": "getConnectorTypes",
|
||||
"description": "You do not need any Kibana feature privileges to run this API.\n",
|
||||
"tags": [
|
||||
"cases"
|
||||
"connectors"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
|
@ -72,9 +272,7 @@
|
|||
"example": true
|
||||
},
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier for the connector type.",
|
||||
"example": ".index"
|
||||
"$ref": "#/components/schemas/connector_types"
|
||||
},
|
||||
"minimum_license_required": {
|
||||
"type": "string",
|
||||
|
@ -136,6 +334,16 @@
|
|||
}
|
||||
},
|
||||
"parameters": {
|
||||
"connector_id": {
|
||||
"in": "path",
|
||||
"name": "connectorId",
|
||||
"description": "An identifier for the connector.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"example": "df770e30-8b8b-11ed-a780-3b746c987a81"
|
||||
}
|
||||
},
|
||||
"space_id": {
|
||||
"in": "path",
|
||||
"name": "spaceId",
|
||||
|
@ -145,9 +353,56 @@
|
|||
"type": "string",
|
||||
"example": "default"
|
||||
}
|
||||
},
|
||||
"kbn_xsrf": {
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"in": "header",
|
||||
"name": "kbn-xsrf",
|
||||
"required": true
|
||||
}
|
||||
},
|
||||
"schemas": {
|
||||
"connector_types": {
|
||||
"type": "string",
|
||||
"description": "The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.",
|
||||
"enum": [
|
||||
".cases-webhook",
|
||||
".email",
|
||||
".index",
|
||||
".jira",
|
||||
".opsgenie",
|
||||
".pagerduty",
|
||||
".resilient",
|
||||
".servicenow",
|
||||
".servicenow-itom",
|
||||
".servicenow-sir",
|
||||
".server-log",
|
||||
".slack",
|
||||
".swimlane",
|
||||
".teams",
|
||||
".tines",
|
||||
".webhook",
|
||||
".xmatters"
|
||||
],
|
||||
"example": ".server-log"
|
||||
},
|
||||
"is_deprecated": {
|
||||
"type": "boolean",
|
||||
"description": "Indicates whether the connector type is deprecated.",
|
||||
"example": false
|
||||
},
|
||||
"is_missing_secrets": {
|
||||
"type": "boolean",
|
||||
"description": "Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.",
|
||||
"example": false
|
||||
},
|
||||
"is_preconfigured": {
|
||||
"type": "boolean",
|
||||
"description": "Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.",
|
||||
"example": false
|
||||
},
|
||||
"features": {
|
||||
"type": "string",
|
||||
"description": "The feature that uses the connector. Valid values are `alerting`, `cases`, `uptime`, and `siem`.\n",
|
||||
|
@ -160,6 +415,45 @@
|
|||
}
|
||||
},
|
||||
"examples": {
|
||||
"get_connector_response": {
|
||||
"summary": "A list of connector types",
|
||||
"value": {
|
||||
"id": "df770e30-8b8b-11ed-a780-3b746c987a81",
|
||||
"name": "my_server_log_connector",
|
||||
"config": {},
|
||||
"connector_type_id": ".server-log",
|
||||
"is_preconfigured": false,
|
||||
"is_deprecated": false,
|
||||
"is_missing_secrets": false
|
||||
}
|
||||
},
|
||||
"get_connectors_response": {
|
||||
"summary": "A list of connectors",
|
||||
"value": [
|
||||
{
|
||||
"id": "preconfigured-email-connector",
|
||||
"name": "my-preconfigured-email-notification",
|
||||
"connector_type_id": ".email",
|
||||
"is_preconfigured": true,
|
||||
"is_deprecated": false,
|
||||
"referenced_by_count": 0
|
||||
},
|
||||
{
|
||||
"id": "e07d0c80-8b8b-11ed-a780-3b746c987a81",
|
||||
"name": "my-index-connector",
|
||||
"config": {
|
||||
"index": "test-index",
|
||||
"refresh": false,
|
||||
"executionTimeField": null
|
||||
},
|
||||
"connector_type_id": ".index",
|
||||
"is_preconfigured": false,
|
||||
"is_deprecated": false,
|
||||
"referenced_by_count": 2,
|
||||
"is_missing_secrets": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"get_connector_types_response": {
|
||||
"summary": "A list of connector types",
|
||||
"value": [
|
||||
|
|
|
@ -15,6 +15,135 @@ servers:
|
|||
- url: http://localhost:5601
|
||||
description: local
|
||||
paths:
|
||||
/s/{spaceId}/api/actions/connector/{connectorId}:
|
||||
get:
|
||||
summary: Retrieves a connector by ID.
|
||||
operationId: getConnector
|
||||
description: |
|
||||
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
tags:
|
||||
- connectors
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/connector_id'
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- connector_type_id
|
||||
- id
|
||||
- is_deprecated
|
||||
- is_preconfigured
|
||||
- name
|
||||
properties:
|
||||
config:
|
||||
type: object
|
||||
description: The configuration for the connector. Configuration properties vary depending on the connector type.
|
||||
additionalProperties: true
|
||||
nullable: true
|
||||
connector_type_id:
|
||||
$ref: '#/components/schemas/connector_types'
|
||||
id:
|
||||
type: string
|
||||
description: The identifier for the connector.
|
||||
example: b0766e10-d190-11ec-b04c-776c77d14fca
|
||||
is_deprecated:
|
||||
$ref: '#/components/schemas/is_deprecated'
|
||||
is_missing_secrets:
|
||||
$ref: '#/components/schemas/is_missing_secrets'
|
||||
is_preconfigured:
|
||||
$ref: '#/components/schemas/is_preconfigured'
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
example: my-connector
|
||||
examples:
|
||||
getConnectorResponse:
|
||||
$ref: '#/components/examples/get_connector_response'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
delete:
|
||||
summary: Deletes a connector.
|
||||
operationId: deleteConnector
|
||||
description: |
|
||||
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. WARNING: When you delete a connector, it cannot be recovered.
|
||||
tags:
|
||||
- connectors
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/kbn_xsrf'
|
||||
- $ref: '#/components/parameters/connector_id'
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
responses:
|
||||
'204':
|
||||
description: Indicates a successful call.
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/actions/connectors:
|
||||
get:
|
||||
summary: Retrieves all connectors.
|
||||
operationId: getConnectors
|
||||
description: |
|
||||
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
tags:
|
||||
- connectors
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- connector_type_id
|
||||
- id
|
||||
- is_deprecated
|
||||
- is_preconfigured
|
||||
- name
|
||||
- referenced_by_count
|
||||
properties:
|
||||
connector_type_id:
|
||||
$ref: '#/components/schemas/connector_types'
|
||||
config:
|
||||
type: object
|
||||
description: The configuration for the connector. Configuration properties vary depending on the connector type.
|
||||
additionalProperties: true
|
||||
nullable: true
|
||||
id:
|
||||
type: string
|
||||
description: The identifier for the connector.
|
||||
example: b0766e10-d190-11ec-b04c-776c77d14fca
|
||||
is_deprecated:
|
||||
$ref: '#/components/schemas/is_deprecated'
|
||||
is_missing_secrets:
|
||||
$ref: '#/components/schemas/is_missing_secrets'
|
||||
is_preconfigured:
|
||||
$ref: '#/components/schemas/is_preconfigured'
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
example: my-connector
|
||||
referenced_by_count:
|
||||
type: integer
|
||||
description: Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated.
|
||||
example: 2
|
||||
default: 0
|
||||
examples:
|
||||
getConnectorsResponse:
|
||||
$ref: '#/components/examples/get_connectors_response'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
/s/{spaceId}/api/actions/connector_types:
|
||||
get:
|
||||
summary: Retrieves a list of all connector types.
|
||||
|
@ -22,7 +151,7 @@ paths:
|
|||
description: |
|
||||
You do not need any Kibana feature privileges to run this API.
|
||||
tags:
|
||||
- cases
|
||||
- connectors
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/space_id'
|
||||
- in: query
|
||||
|
@ -53,9 +182,7 @@ paths:
|
|||
description: Indicates whether the connector is enabled in the license.
|
||||
example: true
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for the connector type.
|
||||
example: .index
|
||||
$ref: '#/components/schemas/connector_types'
|
||||
minimum_license_required:
|
||||
type: string
|
||||
description: The license that is required to use the connector type.
|
||||
|
@ -90,6 +217,14 @@ components:
|
|||
in: header
|
||||
name: ApiKey
|
||||
parameters:
|
||||
connector_id:
|
||||
in: path
|
||||
name: connectorId
|
||||
description: An identifier for the connector.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
example: df770e30-8b8b-11ed-a780-3b746c987a81
|
||||
space_id:
|
||||
in: path
|
||||
name: spaceId
|
||||
|
@ -98,7 +233,47 @@ components:
|
|||
schema:
|
||||
type: string
|
||||
example: default
|
||||
kbn_xsrf:
|
||||
schema:
|
||||
type: string
|
||||
in: header
|
||||
name: kbn-xsrf
|
||||
required: true
|
||||
schemas:
|
||||
connector_types:
|
||||
type: string
|
||||
description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.
|
||||
enum:
|
||||
- .cases-webhook
|
||||
- .email
|
||||
- .index
|
||||
- .jira
|
||||
- .opsgenie
|
||||
- .pagerduty
|
||||
- .resilient
|
||||
- .servicenow
|
||||
- .servicenow-itom
|
||||
- .servicenow-sir
|
||||
- .server-log
|
||||
- .slack
|
||||
- .swimlane
|
||||
- .teams
|
||||
- .tines
|
||||
- .webhook
|
||||
- .xmatters
|
||||
example: .server-log
|
||||
is_deprecated:
|
||||
type: boolean
|
||||
description: Indicates whether the connector type is deprecated.
|
||||
example: false
|
||||
is_missing_secrets:
|
||||
type: boolean
|
||||
description: Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
|
||||
example: false
|
||||
is_preconfigured:
|
||||
type: boolean
|
||||
description: Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.
|
||||
example: false
|
||||
features:
|
||||
type: string
|
||||
description: |
|
||||
|
@ -109,6 +284,36 @@ components:
|
|||
- uptime
|
||||
- siem
|
||||
examples:
|
||||
get_connector_response:
|
||||
summary: A list of connector types
|
||||
value:
|
||||
id: df770e30-8b8b-11ed-a780-3b746c987a81
|
||||
name: my_server_log_connector
|
||||
config: {}
|
||||
connector_type_id: .server-log
|
||||
is_preconfigured: false
|
||||
is_deprecated: false
|
||||
is_missing_secrets: false
|
||||
get_connectors_response:
|
||||
summary: A list of connectors
|
||||
value:
|
||||
- id: preconfigured-email-connector
|
||||
name: my-preconfigured-email-notification
|
||||
connector_type_id: .email
|
||||
is_preconfigured: true
|
||||
is_deprecated: false
|
||||
referenced_by_count: 0
|
||||
- id: e07d0c80-8b8b-11ed-a780-3b746c987a81
|
||||
name: my-index-connector
|
||||
config:
|
||||
index: test-index
|
||||
refresh: false
|
||||
executionTimeField: null
|
||||
connector_type_id: .index
|
||||
is_preconfigured: false
|
||||
is_deprecated: false
|
||||
referenced_by_count: 2
|
||||
is_missing_secrets: false
|
||||
get_connector_types_response:
|
||||
summary: A list of connector types
|
||||
value:
|
||||
|
|
|
@ -0,0 +1,9 @@
|
|||
summary: A list of connector types
|
||||
value:
|
||||
id: df770e30-8b8b-11ed-a780-3b746c987a81
|
||||
name: my_server_log_connector
|
||||
config: {}
|
||||
connector_type_id: .server-log
|
||||
is_preconfigured: false
|
||||
is_deprecated: false
|
||||
is_missing_secrets: false
|
|
@ -0,0 +1,19 @@
|
|||
summary: A list of connectors
|
||||
value:
|
||||
- id: preconfigured-email-connector
|
||||
name: my-preconfigured-email-notification
|
||||
connector_type_id: .email
|
||||
is_preconfigured: true
|
||||
is_deprecated: false
|
||||
referenced_by_count: 0
|
||||
- id: e07d0c80-8b8b-11ed-a780-3b746c987a81
|
||||
name: my-index-connector
|
||||
config:
|
||||
index: test-index
|
||||
refresh: false
|
||||
executionTimeField: null
|
||||
connector_type_id: .index
|
||||
is_preconfigured: false
|
||||
is_deprecated: false
|
||||
referenced_by_count: 2
|
||||
is_missing_secrets: false
|
|
@ -0,0 +1,7 @@
|
|||
in: path
|
||||
name: connectorId
|
||||
description: An identifier for the connector.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
example: df770e30-8b8b-11ed-a780-3b746c987a81
|
|
@ -0,0 +1,21 @@
|
|||
type: string
|
||||
description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.
|
||||
enum:
|
||||
- .cases-webhook
|
||||
- .email
|
||||
- .index
|
||||
- .jira
|
||||
- .opsgenie
|
||||
- .pagerduty
|
||||
- .resilient
|
||||
- .servicenow
|
||||
- .servicenow-itom
|
||||
- .servicenow-sir
|
||||
- .server-log
|
||||
- .slack
|
||||
- .swimlane
|
||||
- .teams
|
||||
- .tines
|
||||
- .webhook
|
||||
- .xmatters
|
||||
example: .server-log
|
|
@ -0,0 +1,3 @@
|
|||
type: boolean
|
||||
description: Indicates whether the connector type is deprecated.
|
||||
example: false
|
|
@ -0,0 +1,3 @@
|
|||
type: boolean
|
||||
description: Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
|
||||
example: false
|
|
@ -0,0 +1,3 @@
|
|||
type: boolean
|
||||
description: Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.
|
||||
example: false
|
|
@ -17,10 +17,10 @@ servers:
|
|||
paths:
|
||||
# '/s/{spaceId}/api/actions/connector':
|
||||
# $ref: 'paths/s@{spaceid}@api@actions@connector.yaml'
|
||||
# '/s/{spaceId}/api/actions/connector/{connectorId}':
|
||||
# $ref: 'paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml'
|
||||
# '/s/{spaceId}/api/actions/connectors':
|
||||
# $ref: paths/s@{spaceid}@api@actions@connectors.yaml
|
||||
'/s/{spaceId}/api/actions/connector/{connectorId}':
|
||||
$ref: 'paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml'
|
||||
'/s/{spaceId}/api/actions/connectors':
|
||||
$ref: paths/s@{spaceid}@api@actions@connectors.yaml
|
||||
'/s/{spaceId}/api/actions/connector_types':
|
||||
$ref: paths/s@{spaceid}@api@actions@connector_types.yaml
|
||||
# '/s/{spaceId}/api/actions/connector/{connectorId}/_execute':
|
||||
|
|
|
@ -0,0 +1,70 @@
|
|||
get:
|
||||
summary: Retrieves a connector by ID.
|
||||
operationId: getConnector
|
||||
description: >
|
||||
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
tags:
|
||||
- connectors
|
||||
parameters:
|
||||
- $ref: '../components/parameters/connector_id.yaml'
|
||||
- $ref: '../components/parameters/space_id.yaml'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- connector_type_id
|
||||
- id
|
||||
- is_deprecated
|
||||
- is_preconfigured
|
||||
- name
|
||||
properties:
|
||||
config:
|
||||
type: object
|
||||
description: The configuration for the connector. Configuration properties vary depending on the connector type.
|
||||
additionalProperties: true
|
||||
nullable: true
|
||||
connector_type_id:
|
||||
$ref: '../components/schemas/connector_types.yaml'
|
||||
id:
|
||||
type: string
|
||||
description: The identifier for the connector.
|
||||
example: b0766e10-d190-11ec-b04c-776c77d14fca
|
||||
is_deprecated:
|
||||
$ref: '../components/schemas/is_deprecated.yaml'
|
||||
is_missing_secrets:
|
||||
$ref: '../components/schemas/is_missing_secrets.yaml'
|
||||
is_preconfigured:
|
||||
$ref: '../components/schemas/is_preconfigured.yaml'
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
example: my-connector
|
||||
examples:
|
||||
getConnectorResponse:
|
||||
$ref: '../components/examples/get_connector_response.yaml'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
|
||||
delete:
|
||||
summary: Deletes a connector.
|
||||
operationId: deleteConnector
|
||||
description: >
|
||||
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
WARNING: When you delete a connector, it cannot be recovered.
|
||||
tags:
|
||||
- connectors
|
||||
parameters:
|
||||
- $ref: ../components/headers/kbn_xsrf.yaml
|
||||
- $ref: '../components/parameters/connector_id.yaml'
|
||||
- $ref: '../components/parameters/space_id.yaml'
|
||||
responses:
|
||||
'204':
|
||||
description: Indicates a successful call.
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
|
@ -4,7 +4,7 @@ get:
|
|||
description: >
|
||||
You do not need any Kibana feature privileges to run this API.
|
||||
tags:
|
||||
- cases
|
||||
- connectors
|
||||
parameters:
|
||||
- $ref: '../components/parameters/space_id.yaml'
|
||||
- in: query
|
||||
|
@ -35,9 +35,7 @@ get:
|
|||
description: Indicates whether the connector is enabled in the license.
|
||||
example: true
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for the connector type.
|
||||
example: .index
|
||||
$ref: '../components/schemas/connector_types.yaml'
|
||||
minimum_license_required:
|
||||
type: string
|
||||
description: The license that is required to use the connector type.
|
||||
|
|
|
@ -0,0 +1,59 @@
|
|||
get:
|
||||
summary: Retrieves all connectors.
|
||||
operationId: getConnectors
|
||||
description: >
|
||||
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
tags:
|
||||
- connectors
|
||||
parameters:
|
||||
- $ref: '../components/parameters/space_id.yaml'
|
||||
responses:
|
||||
'200':
|
||||
description: Indicates a successful call.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- connector_type_id
|
||||
- id
|
||||
- is_deprecated
|
||||
- is_preconfigured
|
||||
- name
|
||||
- referenced_by_count
|
||||
properties:
|
||||
connector_type_id:
|
||||
$ref: '../components/schemas/connector_types.yaml'
|
||||
config:
|
||||
type: object
|
||||
description: The configuration for the connector. Configuration properties vary depending on the connector type.
|
||||
additionalProperties: true
|
||||
nullable: true
|
||||
id:
|
||||
type: string
|
||||
description: The identifier for the connector.
|
||||
example: b0766e10-d190-11ec-b04c-776c77d14fca
|
||||
is_deprecated:
|
||||
$ref: '../components/schemas/is_deprecated.yaml'
|
||||
is_missing_secrets:
|
||||
$ref: '../components/schemas/is_missing_secrets.yaml'
|
||||
is_preconfigured:
|
||||
$ref: '../components/schemas/is_preconfigured.yaml'
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
example: my-connector
|
||||
referenced_by_count:
|
||||
type: integer
|
||||
description: Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated.
|
||||
example: 2
|
||||
default: 0
|
||||
examples:
|
||||
getConnectorsResponse:
|
||||
$ref: '../components/examples/get_connectors_response.yaml'
|
||||
servers:
|
||||
- url: https://localhost:5601
|
||||
servers:
|
||||
- url: https://localhost:5601
|
Loading…
Add table
Add a link
Reference in a new issue