mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
b888ecb45c
[Redo this PR](https://github.com/elastic/kibana/pull/167220) because [this PR](https://github.com/elastic/kibana/pull/167220) merged shortly before broke it and I had to fix an import --------- Co-authored-by: lcawl <lcawley@elastic.co>
2823 lines
248 KiB
Text
2823 lines
248 KiB
Text
////
|
|
This content is generated from the open API specification.
|
|
Any modifications made to this file will be overwritten.
|
|
////
|
|
|
|
++++
|
|
<div class="openapi">
|
|
<h2>Access</h2>
|
|
<ol>
|
|
<li>APIKey KeyParamName:ApiKey KeyInQuery:false KeyInHeader:true</li>
|
|
<li>HTTP Basic Authentication</li>
|
|
</ol>
|
|
|
|
<h2><a name="__Methods">Methods</a></h2>
|
|
[ Jump to <a href="#__Models">Models</a> ]
|
|
|
|
<h3>Table of Contents </h3>
|
|
<div class="method-summary"></div>
|
|
<h4><a href="#Connectors">Connectors</a></h4>
|
|
<ul>
|
|
<li><a href="#createConnector"><code><span class="http-method">post</span> /s/{spaceId}/api/actions/connector</code></a></li>
|
|
<li><a href="#createConnectorId"><code><span class="http-method">post</span> /s/{spaceId}/api/actions/connector/{connectorId}</code></a></li>
|
|
<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>
|
|
<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>
|
|
|
|
<h1><a name="Connectors">Connectors</a></h1>
|
|
<div class="method"><a name="createConnector"/>
|
|
<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/connector</code></pre></div>
|
|
<div class="method-summary">Creates a connector. (<span class="nickname">createConnector</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.</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">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">Create_connector_request_body_properties <a href="#Create_connector_request_body_properties">Create_connector_request_body_properties</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#connector_response_properties">connector_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>null</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="#connector_response_properties">connector_response_properties</a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#Unauthorized_response">Unauthorized_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="createConnectorId"/>
|
|
<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/connector/{connectorId}</code></pre></div>
|
|
<div class="method-summary">Creates a connector. (<span class="nickname">createConnectorId</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.</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 class="param">connectorId (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated. 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">Create_connector_request_body_properties <a href="#Create_connector_request_body_properties">Create_connector_request_body_properties</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#connector_response_properties">connector_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>null</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="#connector_response_properties">connector_response_properties</a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#Unauthorized_response">Unauthorized_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<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> — 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="#Unauthorized_response">Unauthorized_response</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object is not found.
|
|
<a href="#getConnector_404_response">getConnector_404_response</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="#connector_response_properties">connector_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>null</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="#connector_response_properties">connector_response_properties</a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#Unauthorized_response">Unauthorized_response</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object is not found.
|
|
<a href="#getConnector_404_response">getConnector_404_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="getConnectorTypes"/>
|
|
<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_types</code></pre></div>
|
|
<div class="method-summary">Retrieves a list of all connector types. (<span class="nickname">getConnectorTypes</span>)</div>
|
|
<div class="method-notes">You do not need any Kibana feature privileges to run this API.</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">Query parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">feature_id (optional)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Query Parameter</span> — A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases). default: null </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#Get_connector_types_response_body_properties_inner">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>{
|
|
"supported_feature_ids" : [ "alerting", "uptime", "siem" ],
|
|
"name" : "Index",
|
|
"enabled_in_license" : true,
|
|
"id" : ".server-log",
|
|
"enabled_in_config" : true,
|
|
"minimum_license_required" : "basic",
|
|
"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="#Unauthorized_response">Unauthorized_response</a>
|
|
</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="#Get_connectors_response_body_properties">Get_connectors_response_body_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>{
|
|
"is_missing_secrets" : false,
|
|
"is_deprecated" : false,
|
|
"is_preconfigured" : false,
|
|
"name" : "my-connector",
|
|
"is_system_action" : false,
|
|
"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.
|
|
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#Unauthorized_response">Unauthorized_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> — 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> — </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> — 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="#Unauthorized_response">Unauthorized_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> — 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> — 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> — 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="#Unauthorized_response">Unauthorized_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> — 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> — 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="#Unauthorized_response">Unauthorized_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> — 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="#Unauthorized_response">Unauthorized_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> — 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="#Unauthorized_response">Unauthorized_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> — 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> — 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> — </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> — 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="#Unauthorized_response">Unauthorized_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> — 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> — 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> — </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> — 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="#Not_found_response">Not_found_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="runConnector"/>
|
|
<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/connector/{connectorId}/_execute</code></pre></div>
|
|
<div class="method-summary">Runs a connector. (<span class="nickname">runConnector</span>)</div>
|
|
<div class="method-notes">You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. 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. If you use an index connector, you must also have <code>all</code>, <code>create</code>, <code>index</code>, or <code>write</code> indices 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">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">Run_connector_request_body_properties <a href="#Run_connector_request_body_properties">Run_connector_request_body_properties</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#runConnector_200_response">runConnector_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>{
|
|
"connector_id" : "connector_id",
|
|
"status" : "error"
|
|
}</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="#runConnector_200_response">runConnector_200_response</a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#Unauthorized_response">Unauthorized_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="updateConnector"/>
|
|
<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/connector/{connectorId}</code></pre></div>
|
|
<div class="method-summary">Updates the attributes for a connector. (<span class="nickname">updateConnector</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.</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">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">Update_connector_request_body_properties <a href="#Update_connector_request_body_properties">Update_connector_request_body_properties</a> (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — </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> — Cross-site request forgery protection default: null </div>
|
|
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#connector_response_properties">connector_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>null</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="#connector_response_properties">connector_response_properties</a>
|
|
<h4 class="field-label">400</h4>
|
|
Indicates a bad request.
|
|
<a href="#updateConnector_400_response">updateConnector_400_response</a>
|
|
<h4 class="field-label">401</h4>
|
|
Authorization information is missing or invalid.
|
|
<a href="#Unauthorized_response">Unauthorized_response</a>
|
|
<h4 class="field-label">404</h4>
|
|
Object is not found.
|
|
<a href="#Not_found_response">Not_found_response</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<h2><a name="__Models">Models</a></h2>
|
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
|
|
|
<h3>Table of Contents</h3>
|
|
<ol>
|
|
<li><a href="#Alert_identifier_mapping"><code>Alert_identifier_mapping</code> - Alert identifier mapping</a></li>
|
|
<li><a href="#Case_comment_mapping"><code>Case_comment_mapping</code> - Case comment mapping</a></li>
|
|
<li><a href="#Case_description_mapping"><code>Case_description_mapping</code> - Case description mapping</a></li>
|
|
<li><a href="#Case_identifier_mapping"><code>Case_identifier_mapping</code> - Case identifier mapping</a></li>
|
|
<li><a href="#Case_name_mapping"><code>Case_name_mapping</code> - Case name mapping</a></li>
|
|
<li><a href="#Connector_mappings_properties_for_a_Swimlane_connector"><code>Connector_mappings_properties_for_a_Swimlane_connector</code> - Connector mappings properties for a Swimlane connector</a></li>
|
|
<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="#Not_found_response"><code>Not_found_response</code> - Not found response</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="#Unauthorized_response"><code>Unauthorized_response</code> - Unauthorized response</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_d3security"><code>config_properties_d3security</code> - Connector request properties for a D3 Security connector</a></li>
|
|
<li><a href="#config_properties_email"><code>config_properties_email</code> - Connector request properties for an email connector</a></li>
|
|
<li><a href="#config_properties_genai"><code>config_properties_genai</code> - Connector request properties for an OpenAI connector</a></li>
|
|
<li><a href="#config_properties_genai_oneOf"><code>config_properties_genai_oneOf</code> - </a></li>
|
|
<li><a href="#config_properties_genai_oneOf_1"><code>config_properties_genai_oneOf_1</code> - </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>
|
|
<li><a href="#config_properties_opsgenie"><code>config_properties_opsgenie</code> - Connector request properties for an Opsgenie connector</a></li>
|
|
<li><a href="#config_properties_pagerduty"><code>config_properties_pagerduty</code> - Connector request properties for a PagerDuty connector</a></li>
|
|
<li><a href="#config_properties_resilient"><code>config_properties_resilient</code> - Connector request properties for a IBM Resilient connector</a></li>
|
|
<li><a href="#config_properties_servicenow"><code>config_properties_servicenow</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
|
|
<li><a href="#config_properties_servicenow_itom"><code>config_properties_servicenow_itom</code> - Connector request properties for a ServiceNow ITSM connector</a></li>
|
|
<li><a href="#config_properties_swimlane"><code>config_properties_swimlane</code> - Connector request properties for a Swimlane connector</a></li>
|
|
<li><a href="#config_properties_tines"><code>config_properties_tines</code> - Connector request properties for a Tines connector</a></li>
|
|
<li><a href="#config_properties_torq"><code>config_properties_torq</code> - Connector request properties for a Torq connector</a></li>
|
|
<li><a href="#config_properties_webhook"><code>config_properties_webhook</code> - Connector request properties for a Webhook connector</a></li>
|
|
<li><a href="#config_properties_xmatters"><code>config_properties_xmatters</code> - Connector request properties for an xMatters connector</a></li>
|
|
<li><a href="#connector_response_properties"><code>connector_response_properties</code> - Connector response properties</a></li>
|
|
<li><a href="#connector_response_properties_cases_webhook"><code>connector_response_properties_cases_webhook</code> - Connector request properties for a Webhook - Case Management connector</a></li>
|
|
<li><a href="#connector_response_properties_d3security"><code>connector_response_properties_d3security</code> - Connector response properties for a D3 Security connector</a></li>
|
|
<li><a href="#connector_response_properties_email"><code>connector_response_properties_email</code> - Connector response properties for an email connector</a></li>
|
|
<li><a href="#connector_response_properties_index"><code>connector_response_properties_index</code> - Connector response properties for an index connector</a></li>
|
|
<li><a href="#connector_response_properties_jira"><code>connector_response_properties_jira</code> - Connector response properties for a Jira connector</a></li>
|
|
<li><a href="#connector_response_properties_opsgenie"><code>connector_response_properties_opsgenie</code> - Connector response properties for an Opsgenie connector</a></li>
|
|
<li><a href="#connector_response_properties_pagerduty"><code>connector_response_properties_pagerduty</code> - Connector response properties for a PagerDuty connector</a></li>
|
|
<li><a href="#connector_response_properties_resilient"><code>connector_response_properties_resilient</code> - Connector response properties for a IBM Resilient connector</a></li>
|
|
<li><a href="#connector_response_properties_serverlog"><code>connector_response_properties_serverlog</code> - Connector response properties for a server log connector</a></li>
|
|
<li><a href="#connector_response_properties_servicenow"><code>connector_response_properties_servicenow</code> - Connector response properties for a ServiceNow ITSM connector</a></li>
|
|
<li><a href="#connector_response_properties_servicenow_itom"><code>connector_response_properties_servicenow_itom</code> - Connector response properties for a ServiceNow ITOM connector</a></li>
|
|
<li><a href="#connector_response_properties_servicenow_sir"><code>connector_response_properties_servicenow_sir</code> - Connector response properties for a ServiceNow SecOps connector</a></li>
|
|
<li><a href="#connector_response_properties_slack_api"><code>connector_response_properties_slack_api</code> - Connector response properties for a Slack connector</a></li>
|
|
<li><a href="#connector_response_properties_slack_webhook"><code>connector_response_properties_slack_webhook</code> - Connector response properties for a Slack connector</a></li>
|
|
<li><a href="#connector_response_properties_swimlane"><code>connector_response_properties_swimlane</code> - Connector response properties for a Swimlane connector</a></li>
|
|
<li><a href="#connector_response_properties_teams"><code>connector_response_properties_teams</code> - Connector response properties for a Microsoft Teams connector</a></li>
|
|
<li><a href="#connector_response_properties_tines"><code>connector_response_properties_tines</code> - Connector response properties for a Tines connector</a></li>
|
|
<li><a href="#connector_response_properties_torq"><code>connector_response_properties_torq</code> - Connector response properties for a Torq connector</a></li>
|
|
<li><a href="#connector_response_properties_webhook"><code>connector_response_properties_webhook</code> - Connector response properties for a Webhook connector</a></li>
|
|
<li><a href="#connector_response_properties_xmatters"><code>connector_response_properties_xmatters</code> - Connector response properties for an xMatters connector</a></li>
|
|
<li><a href="#connector_types"><code>connector_types</code> - Connector types</a></li>
|
|
<li><a href="#create_connector_request_cases_webhook"><code>create_connector_request_cases_webhook</code> - Create Webhook - Case Managment connector request</a></li>
|
|
<li><a href="#create_connector_request_d3security"><code>create_connector_request_d3security</code> - Create D3 Security connector request</a></li>
|
|
<li><a href="#create_connector_request_email"><code>create_connector_request_email</code> - Create email connector request</a></li>
|
|
<li><a href="#create_connector_request_genai"><code>create_connector_request_genai</code> - Create OpenAI connector request</a></li>
|
|
<li><a href="#create_connector_request_index"><code>create_connector_request_index</code> - Create index connector request</a></li>
|
|
<li><a href="#create_connector_request_jira"><code>create_connector_request_jira</code> - Create Jira connector request</a></li>
|
|
<li><a href="#create_connector_request_opsgenie"><code>create_connector_request_opsgenie</code> - Create Opsgenie connector request</a></li>
|
|
<li><a href="#create_connector_request_pagerduty"><code>create_connector_request_pagerduty</code> - Create PagerDuty connector request</a></li>
|
|
<li><a href="#create_connector_request_resilient"><code>create_connector_request_resilient</code> - Create IBM Resilient connector request</a></li>
|
|
<li><a href="#create_connector_request_serverlog"><code>create_connector_request_serverlog</code> - Create server log connector request</a></li>
|
|
<li><a href="#create_connector_request_servicenow"><code>create_connector_request_servicenow</code> - Create ServiceNow ITSM connector request</a></li>
|
|
<li><a href="#create_connector_request_servicenow_itom"><code>create_connector_request_servicenow_itom</code> - Create ServiceNow ITOM connector request</a></li>
|
|
<li><a href="#create_connector_request_servicenow_sir"><code>create_connector_request_servicenow_sir</code> - Create ServiceNow SecOps connector request</a></li>
|
|
<li><a href="#create_connector_request_slack_api"><code>create_connector_request_slack_api</code> - Create Slack connector request</a></li>
|
|
<li><a href="#create_connector_request_slack_webhook"><code>create_connector_request_slack_webhook</code> - Create Slack connector request</a></li>
|
|
<li><a href="#create_connector_request_swimlane"><code>create_connector_request_swimlane</code> - Create Swimlane connector request</a></li>
|
|
<li><a href="#create_connector_request_teams"><code>create_connector_request_teams</code> - Create Microsoft Teams connector request</a></li>
|
|
<li><a href="#create_connector_request_tines"><code>create_connector_request_tines</code> - Create Tines connector request</a></li>
|
|
<li><a href="#create_connector_request_torq"><code>create_connector_request_torq</code> - Create Torq connector request</a></li>
|
|
<li><a href="#create_connector_request_webhook"><code>create_connector_request_webhook</code> - Create Webhook connector request</a></li>
|
|
<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>
|
|
<li><a href="#run_connector_params_level_message"><code>run_connector_params_level_message</code> - Server log connector parameters</a></li>
|
|
<li><a href="#run_connector_subaction_addevent"><code>run_connector_subaction_addevent</code> - The addEvent subaction</a></li>
|
|
<li><a href="#run_connector_subaction_addevent_subActionParams"><code>run_connector_subaction_addevent_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_closealert"><code>run_connector_subaction_closealert</code> - The closeAlert subaction</a></li>
|
|
<li><a href="#run_connector_subaction_closealert_subActionParams"><code>run_connector_subaction_closealert_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_createalert"><code>run_connector_subaction_createalert</code> - The createAlert subaction</a></li>
|
|
<li><a href="#run_connector_subaction_createalert_subActionParams"><code>run_connector_subaction_createalert_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_createalert_subActionParams_responders_inner"><code>run_connector_subaction_createalert_subActionParams_responders_inner</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_createalert_subActionParams_visibleTo_inner"><code>run_connector_subaction_createalert_subActionParams_visibleTo_inner</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_fieldsbyissuetype"><code>run_connector_subaction_fieldsbyissuetype</code> - The fieldsByIssueType subaction</a></li>
|
|
<li><a href="#run_connector_subaction_fieldsbyissuetype_subActionParams"><code>run_connector_subaction_fieldsbyissuetype_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_getchoices"><code>run_connector_subaction_getchoices</code> - The getChoices subaction</a></li>
|
|
<li><a href="#run_connector_subaction_getchoices_subActionParams"><code>run_connector_subaction_getchoices_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_getfields"><code>run_connector_subaction_getfields</code> - The getFields subaction</a></li>
|
|
<li><a href="#run_connector_subaction_getincident"><code>run_connector_subaction_getincident</code> - The getIncident subaction</a></li>
|
|
<li><a href="#run_connector_subaction_getincident_subActionParams"><code>run_connector_subaction_getincident_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_issue"><code>run_connector_subaction_issue</code> - The issue subaction</a></li>
|
|
<li><a href="#run_connector_subaction_issue_subActionParams"><code>run_connector_subaction_issue_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_issues"><code>run_connector_subaction_issues</code> - The issues subaction</a></li>
|
|
<li><a href="#run_connector_subaction_issues_subActionParams"><code>run_connector_subaction_issues_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_issuetypes"><code>run_connector_subaction_issuetypes</code> - The issueTypes subaction</a></li>
|
|
<li><a href="#run_connector_subaction_pushtoservice"><code>run_connector_subaction_pushtoservice</code> - The pushToService subaction</a></li>
|
|
<li><a href="#run_connector_subaction_pushtoservice_subActionParams"><code>run_connector_subaction_pushtoservice_subActionParams</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_pushtoservice_subActionParams_comments_inner"><code>run_connector_subaction_pushtoservice_subActionParams_comments_inner</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_pushtoservice_subActionParams_incident"><code>run_connector_subaction_pushtoservice_subActionParams_incident</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_dest_ip"><code>run_connector_subaction_pushtoservice_subActionParams_incident_dest_ip</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_malware_hash"><code>run_connector_subaction_pushtoservice_subActionParams_incident_malware_hash</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_malware_url"><code>run_connector_subaction_pushtoservice_subActionParams_incident_malware_url</code> - </a></li>
|
|
<li><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_source_ip"><code>run_connector_subaction_pushtoservice_subActionParams_incident_source_ip</code> - </a></li>
|
|
<li><a href="#secrets_properties_cases_webhook"><code>secrets_properties_cases_webhook</code> - Connector secrets properties for Webhook - Case Management connector</a></li>
|
|
<li><a href="#secrets_properties_d3security"><code>secrets_properties_d3security</code> - Connector secrets properties for a D3 Security connector</a></li>
|
|
<li><a href="#secrets_properties_email"><code>secrets_properties_email</code> - Connector secrets properties for an email connector</a></li>
|
|
<li><a href="#secrets_properties_genai"><code>secrets_properties_genai</code> - Connector secrets properties for an OpenAI connector</a></li>
|
|
<li><a href="#secrets_properties_jira"><code>secrets_properties_jira</code> - Connector secrets properties for a Jira connector</a></li>
|
|
<li><a href="#secrets_properties_opsgenie"><code>secrets_properties_opsgenie</code> - Connector secrets properties for an Opsgenie connector</a></li>
|
|
<li><a href="#secrets_properties_pagerduty"><code>secrets_properties_pagerduty</code> - Connector secrets properties for a PagerDuty connector</a></li>
|
|
<li><a href="#secrets_properties_resilient"><code>secrets_properties_resilient</code> - Connector secrets properties for IBM Resilient connector</a></li>
|
|
<li><a href="#secrets_properties_servicenow"><code>secrets_properties_servicenow</code> - Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors</a></li>
|
|
<li><a href="#secrets_properties_slack_api"><code>secrets_properties_slack_api</code> - Connector secrets properties for a Web API Slack connector</a></li>
|
|
<li><a href="#secrets_properties_slack_webhook"><code>secrets_properties_slack_webhook</code> - Connector secrets properties for a Webhook Slack connector</a></li>
|
|
<li><a href="#secrets_properties_swimlane"><code>secrets_properties_swimlane</code> - Connector secrets properties for a Swimlane connector</a></li>
|
|
<li><a href="#secrets_properties_teams"><code>secrets_properties_teams</code> - Connector secrets properties for a Microsoft Teams connector</a></li>
|
|
<li><a href="#secrets_properties_tines"><code>secrets_properties_tines</code> - Connector secrets properties for a Tines connector</a></li>
|
|
<li><a href="#secrets_properties_torq"><code>secrets_properties_torq</code> - Connector secrets properties for a Torq connector</a></li>
|
|
<li><a href="#secrets_properties_webhook"><code>secrets_properties_webhook</code> - Connector secrets properties for a Webhook connector</a></li>
|
|
<li><a href="#secrets_properties_xmatters"><code>secrets_properties_xmatters</code> - Connector secrets properties for an xMatters connector</a></li>
|
|
<li><a href="#updateConnector_400_response"><code>updateConnector_400_response</code> - </a></li>
|
|
<li><a href="#update_connector_request_cases_webhook"><code>update_connector_request_cases_webhook</code> - Update Webhook - Case Managment connector request</a></li>
|
|
<li><a href="#update_connector_request_d3security"><code>update_connector_request_d3security</code> - Update D3 Security connector request</a></li>
|
|
<li><a href="#update_connector_request_email"><code>update_connector_request_email</code> - Update email connector request</a></li>
|
|
<li><a href="#update_connector_request_index"><code>update_connector_request_index</code> - Update index connector request</a></li>
|
|
<li><a href="#update_connector_request_jira"><code>update_connector_request_jira</code> - Update Jira connector request</a></li>
|
|
<li><a href="#update_connector_request_opsgenie"><code>update_connector_request_opsgenie</code> - Update Opsgenie connector request</a></li>
|
|
<li><a href="#update_connector_request_pagerduty"><code>update_connector_request_pagerduty</code> - Update PagerDuty connector request</a></li>
|
|
<li><a href="#update_connector_request_resilient"><code>update_connector_request_resilient</code> - Update IBM Resilient connector request</a></li>
|
|
<li><a href="#update_connector_request_serverlog"><code>update_connector_request_serverlog</code> - Update server log connector request</a></li>
|
|
<li><a href="#update_connector_request_servicenow"><code>update_connector_request_servicenow</code> - Update ServiceNow ITSM connector or ServiceNow SecOps request</a></li>
|
|
<li><a href="#update_connector_request_servicenow_itom"><code>update_connector_request_servicenow_itom</code> - Create ServiceNow ITOM connector request</a></li>
|
|
<li><a href="#update_connector_request_slack_api"><code>update_connector_request_slack_api</code> - Update Slack connector request</a></li>
|
|
<li><a href="#update_connector_request_slack_webhook"><code>update_connector_request_slack_webhook</code> - Update Slack connector request</a></li>
|
|
<li><a href="#update_connector_request_swimlane"><code>update_connector_request_swimlane</code> - Update Swimlane connector request</a></li>
|
|
<li><a href="#update_connector_request_teams"><code>update_connector_request_teams</code> - Update Microsoft Teams connector request</a></li>
|
|
<li><a href="#update_connector_request_tines"><code>update_connector_request_tines</code> - Update Tines connector request</a></li>
|
|
<li><a href="#update_connector_request_torq"><code>update_connector_request_torq</code> - Update Torq connector request</a></li>
|
|
<li><a href="#update_connector_request_webhook"><code>update_connector_request_webhook</code> - Update Webhook connector request</a></li>
|
|
<li><a href="#update_connector_request_xmatters"><code>update_connector_request_xmatters</code> - Update xMatters connector request</a></li>
|
|
</ol>
|
|
|
|
<div class="model">
|
|
<h3><a name="Alert_identifier_mapping"><code>Alert_identifier_mapping</code> - Alert identifier mapping</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Mapping for the alert ID.</div>
|
|
<div class="field-items">
|
|
<div class="param">fieldType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of field in Swimlane. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the field in Swimlane. </div>
|
|
<div class="param">key </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key for the field in Swimlane. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the field in Swimlane. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Case_comment_mapping"><code>Case_comment_mapping</code> - Case comment mapping</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Mapping for the case comments.</div>
|
|
<div class="field-items">
|
|
<div class="param">fieldType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of field in Swimlane. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the field in Swimlane. </div>
|
|
<div class="param">key </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key for the field in Swimlane. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the field in Swimlane. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Case_description_mapping"><code>Case_description_mapping</code> - Case description mapping</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Mapping for the case description.</div>
|
|
<div class="field-items">
|
|
<div class="param">fieldType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of field in Swimlane. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the field in Swimlane. </div>
|
|
<div class="param">key </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key for the field in Swimlane. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the field in Swimlane. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Case_identifier_mapping"><code>Case_identifier_mapping</code> - Case identifier mapping</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Mapping for the case ID.</div>
|
|
<div class="field-items">
|
|
<div class="param">fieldType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of field in Swimlane. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the field in Swimlane. </div>
|
|
<div class="param">key </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key for the field in Swimlane. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the field in Swimlane. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Case_name_mapping"><code>Case_name_mapping</code> - Case name mapping</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Mapping for the case name.</div>
|
|
<div class="field-items">
|
|
<div class="param">fieldType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of field in Swimlane. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the field in Swimlane. </div>
|
|
<div class="param">key </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key for the field in Swimlane. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the field in Swimlane. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Connector_mappings_properties_for_a_Swimlane_connector"><code>Connector_mappings_properties_for_a_Swimlane_connector</code> - Connector mappings properties for a Swimlane connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The field mapping.</div>
|
|
<div class="field-items">
|
|
<div class="param">alertIdConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#Alert_identifier_mapping">Alert_identifier_mapping</a></span> </div>
|
|
<div class="param">caseIdConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#Case_identifier_mapping">Case_identifier_mapping</a></span> </div>
|
|
<div class="param">caseNameConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#Case_name_mapping">Case_name_mapping</a></span> </div>
|
|
<div class="param">commentsConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#Case_comment_mapping">Case_comment_mapping</a></span> </div>
|
|
<div class="param">descriptionConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#Case_description_mapping">Case_description_mapping</a></span> </div>
|
|
<div class="param">ruleNameConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#Rule_name_mapping">Rule_name_mapping</a></span> </div>
|
|
<div class="param">severityConfig (optional)</div><div class="param-desc"><span class="param-type"><a href="#Severity_mapping">Severity_mapping</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Create_connector_request_body_properties"><code>Create_connector_request_body_properties</code> - Create 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 </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.xmatters</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Get_connector_types_response_body_properties_inner"><code>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">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="#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="Get_connectors_response_body_properties"><code>Get_connectors_response_body_properties</code> - Get connectors response body properties</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The properties vary for each connector type.</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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 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="Not_found_response"><code>Not_found_response</code> - Not found response</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">Not Found</div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">404</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>
|
|
<div class="field-items">
|
|
<div class="param">fieldType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of field in Swimlane. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the field in Swimlane. </div>
|
|
<div class="param">key </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key for the field in Swimlane. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the field in Swimlane. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Run_connector_request_body_properties"><code>Run_connector_request_body_properties</code> - 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="#Run_connector_request_body_properties_params">Run_connector_request_body_properties_params</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Run_connector_request_body_properties_params"><code>Run_connector_request_body_properties_params</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">documents </div><div class="param-desc"><span class="param-type"><a href="#map">array[map[String, oas_any_type_not_mapped]]</a></span> The documents in JSON format for index connectors. </div>
|
|
<div class="param">level (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The log level of the message for server log connectors. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">debug</div><div class="param-enum">error</div><div class="param-enum">fatal</div><div class="param-enum">info</div><div class="param-enum">trace</div><div class="param-enum">warn</div>
|
|
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The message for server log connectors. </div>
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">pushToService</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams">run_connector_subaction_pushtoservice_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Severity_mapping"><code>Severity_mapping</code> - Severity mapping</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Mapping for the severity.</div>
|
|
<div class="field-items">
|
|
<div class="param">fieldType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of field in Swimlane. </div>
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the field in Swimlane. </div>
|
|
<div class="param">key </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The key for the field in Swimlane. </div>
|
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the field in Swimlane. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Subaction_parameters"><code>Subaction_parameters</code> - Subaction parameters</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Test an action that involves a subaction.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">pushToService</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams">run_connector_subaction_pushtoservice_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Unauthorized_response"><code>Unauthorized_response</code> - Unauthorized response</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">Unauthorized</div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">statusCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">401</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="Update_connector_request_body_properties"><code>Update_connector_request_body_properties</code> - 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 </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.gen-ai</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>
|
|
<div class="field-items">
|
|
<div class="param">createCommentJson (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A JSON payload sent to the create comment URL to create a case comment. You can use variables to add Kibana Cases data to the payload. The required variable is <code>case.comment</code>. Due to Mustache template variables (the text enclosed in triple braces, for example, <code>{{{case.title}}}</code>), the JSON is not validated when you create the connector. The JSON is validated once the Mustache variables have been placed when the REST method runs. Manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass. </div>
|
|
<div class="param">createCommentMethod (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The REST API HTTP request method to create a case comment in the third-party system. Valid values are <code>patch</code>, <code>post</code>, and <code>put</code>. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">patch</div><div class="param-enum">post</div><div class="param-enum">put</div>
|
|
<div class="param">createCommentUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The REST API URL to create a case comment by ID in the third-party system. You can use a variable to add the external system ID to the URL. If you are using the <code>xpack.actions.allowedHosts setting</code>, add the hostname to the allowed hosts. </div>
|
|
<div class="param">createIncidentJson </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A JSON payload sent to the create case URL to create a case. You can use variables to add case data to the payload. Required variables are <code>case.title</code> and <code>case.description</code>. Due to Mustache template variables (which is the text enclosed in triple braces, for example, <code>{{{case.title}}}</code>), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid to avoid future validation errors; disregard Mustache variables during your review. </div>
|
|
<div class="param">createIncidentMethod (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The REST API HTTP request method to create a case in the third-party system. Valid values are <code>patch</code>, <code>post</code>, and <code>put</code>. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">patch</div><div class="param-enum">post</div><div class="param-enum">put</div>
|
|
<div class="param">createIncidentResponseKey </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The JSON key in the create case response that contains the external case ID. </div>
|
|
<div class="param">createIncidentUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The REST API URL to create a case in the third-party system. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
|
|
<div class="param">getIncidentResponseExternalTitleKey </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The JSON key in get case response that contains the external case title. </div>
|
|
<div class="param">getIncidentUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The REST API URL to get the case by ID from the third-party system. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. You can use a variable to add the external system ID to the URL. Due to Mustache template variables (the text enclosed in triple braces, for example, <code>{{{case.title}}}</code>), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass. </div>
|
|
<div class="param">hasAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> If true, a username and password for login type authentication must be provided. </div>
|
|
<div class="param">headers (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A set of key-value pairs sent as headers with the request URLs for the create case, update case, get case, and create comment methods. </div>
|
|
<div class="param">updateIncidentJson </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The JSON payload sent to the update case URL to update the case. You can use variables to add Kibana Cases data to the payload. Required variables are <code>case.title</code> and <code>case.description</code>. Due to Mustache template variables (which is the text enclosed in triple braces, for example, <code>{{{case.title}}}</code>), the JSON is not validated when you create the connector. The JSON is validated after the Mustache variables have been placed when REST method runs. Manually ensure that the JSON is valid to avoid future validation errors; disregard Mustache variables during your review. </div>
|
|
<div class="param">updateIncidentMethod (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The REST API HTTP request method to update the case in the third-party system. Valid values are <code>patch</code>, <code>post</code>, and <code>put</code>. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">patch</div><div class="param-enum">post</div><div class="param-enum">put</div>
|
|
<div class="param">updateIncidentUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The REST API URL to update the case by ID in the third-party system. You can use a variable to add the external system ID to the URL. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
|
|
<div class="param">viewIncidentUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The URL to view the case in the external system. You can use variables to add the external system ID or external system title to the URL. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_d3security"><code>config_properties_d3security</code> - Connector request properties for a D3 Security connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.d3security</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">url </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The D3 Security API request URL. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_email"><code>config_properties_email</code> - Connector request properties for an email connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.email</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">clientId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The client identifier, which is a part of OAuth 2.0 client credentials authentication, in GUID format. If <code>service</code> is <code>exchange_server</code>, this property is required. </div>
|
|
<div class="param">from </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The from address for all emails sent by the connector. It must be specified in <code>user@host-name</code> format. </div>
|
|
<div class="param">hasAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Specifies whether a user and password are required inside the secrets configuration. </div>
|
|
<div class="param">host (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The host name of the service provider. If the <code>service</code> is <code>elastic_cloud</code> (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If <code>service</code> is <code>other</code>, this property must be defined. </div>
|
|
<div class="param">oauthTokenUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">port (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> The port to connect to on the service provider. If the <code>service</code> is <code>elastic_cloud</code> (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If <code>service</code> is <code>other</code>, this property must be defined. </div>
|
|
<div class="param">secure (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Specifies whether the connection to the service provider will use TLS. If the <code>service</code> is <code>elastic_cloud</code> (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. </div>
|
|
<div class="param">service (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the email service. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">elastic_cloud</div><div class="param-enum">exchange_server</div><div class="param-enum">gmail</div><div class="param-enum">other</div><div class="param-enum">outlook365</div><div class="param-enum">ses</div>
|
|
<div class="param">tenantId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The tenant identifier, which is part of OAuth 2.0 client credentials authentication, in GUID format. If <code>service</code> is <code>exchange_server</code>, this property is required. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_genai"><code>config_properties_genai</code> - Connector request properties for an OpenAI connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.gen-ai</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiProvider </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API provider. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">OpenAI</div>
|
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API endpoint. </div>
|
|
<div class="param">defaultModel (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The default model to use for requests. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_genai_oneOf"><code>config_properties_genai_oneOf</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">apiProvider </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API provider. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">Azure OpenAI</div>
|
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API endpoint. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_genai_oneOf_1"><code>config_properties_genai_oneOf_1</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">apiProvider </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API provider. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">OpenAI</div>
|
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API endpoint. </div>
|
|
<div class="param">defaultModel (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The default model to use for requests. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_index"><code>config_properties_index</code> - Connector request properties for an index connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.index</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">executionTimeField (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A field that indicates when the document was indexed. </div>
|
|
<div class="param">index </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Elasticsearch index to be written to. </div>
|
|
<div class="param">refresh (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> The refresh policy for the write request, which affects when changes are made visible to search. Refer to the refresh setting for Elasticsearch document APIs. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_jira"><code>config_properties_jira</code> - Connector request properties for a Jira connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.jira</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Jira instance URL. </div>
|
|
<div class="param">projectKey </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Jira project key. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_opsgenie"><code>config_properties_opsgenie</code> - Connector request properties for an Opsgenie connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.opsgenie</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Opsgenie URL. For example, <code>https://api.opsgenie.com</code> or <code>https://api.eu.opsgenie.com</code>. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_pagerduty"><code>config_properties_pagerduty</code> - Connector request properties for a PagerDuty connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.pagerduty</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The PagerDuty event URL. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_resilient"><code>config_properties_resilient</code> - Connector request properties for a IBM Resilient connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.resilient</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The IBM Resilient instance URL. </div>
|
|
<div class="param">orgId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The IBM Resilient organization ID. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_servicenow"><code>config_properties_servicenow</code> - Connector request properties for a ServiceNow ITSM connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.servicenow</code>.</div>
|
|
<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="#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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_servicenow_itom"><code>config_properties_servicenow_itom</code> - Connector request properties for a ServiceNow ITSM connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.servicenow</code>.</div>
|
|
<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="#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 -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_swimlane"><code>config_properties_swimlane</code> - Connector request properties for a Swimlane connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.swimlane</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Swimlane instance URL. </div>
|
|
<div class="param">appId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Swimlane application ID. </div>
|
|
<div class="param">connectorType </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. Valid values are <code>all</code>, <code>alerts</code>, and <code>cases</code>. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">all</div><div class="param-enum">alerts</div><div class="param-enum">cases</div>
|
|
<div class="param">mappings (optional)</div><div class="param-desc"><span class="param-type"><a href="#Connector_mappings_properties_for_a_Swimlane_connector">Connector_mappings_properties_for_a_Swimlane_connector</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_tines"><code>config_properties_tines</code> - Connector request properties for a Tines connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.tines</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">url </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Tines tenant URL. If you are using the <code>xpack.actions.allowedHosts</code> setting, make sure this hostname is added to the allowed hosts. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_torq"><code>config_properties_torq</code> - Connector request properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.torq</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">webhookIntegrationUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The endpoint URL of the Elastic Security integration in Torq. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_webhook"><code>config_properties_webhook</code> - Connector request properties for a Webhook connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.webhook</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">authType (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of authentication to use: basic, SSL, or none. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">webhook-authentication-basic</div><div class="param-enum">webhook-authentication-ssl</div><div class="param-enum">null</div>
|
|
<div class="param">ca (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A base64 encoded version of the certificate authority file that the connector can trust to sign and validate certificates. This option is available for all authentication types. </div>
|
|
<div class="param">certType (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> If the <code>authType</code> is <code>webhook-authentication-ssl</code>, specifies whether the certificate authentication data is in a CRT and key file format or a PFX file format. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">ssl-crt-key</div><div class="param-enum">ssl-pfx</div>
|
|
<div class="param">hasAuth (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> If <code>true</code>, a user name and password must be provided for login type authentication. </div>
|
|
<div class="param">headers (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> A set of key-value pairs sent as headers with the request. </div>
|
|
<div class="param">method (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The HTTP request method, either <code>post</code> or <code>put</code>. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">post</div><div class="param-enum">put</div>
|
|
<div class="param">url (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The request URL. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
|
|
<div class="param">verificationMode (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Controls the verification of certificates. Use <code>full</code> to validate that the certificate has an issue date within the <code>not_before</code> and <code>not_after</code> dates, chains to a trusted certificate authority (CA), and has a hostname or IP address that matches the names within the certificate. Use <code>certificate</code> to validate the certificate and verify that it is signed by a trusted authority; this option does not check the certificate hostname. Use <code>none</code> to skip certificate validation. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">certificate</div><div class="param-enum">full</div><div class="param-enum">none</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="config_properties_xmatters"><code>config_properties_xmatters</code> - Connector request properties for an xMatters connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines properties for connectors when type is <code>.xmatters</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">configUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The request URL for the Elastic Alerts trigger in xMatters. It is applicable only when <code>usesBasic</code> is <code>true</code>. </div>
|
|
<div class="param">usesBasic (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Specifies whether the connector uses HTTP basic authentication (<code>true</code>) or URL authentication (<code>false</code>). </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="connector_response_properties"><code>connector_response_properties</code> - Connector response 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 </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.xmatters</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_cases_webhook"><code>connector_response_properties_cases_webhook</code> - Connector request properties for a Webhook - Case Management connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_cases_webhook">config_properties_cases_webhook</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.cases-webhook</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_d3security"><code>connector_response_properties_d3security</code> - Connector response properties for a D3 Security connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_d3security">config_properties_d3security</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.d3security</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_email"><code>connector_response_properties_email</code> - Connector response properties for an email connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_email">config_properties_email</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.email</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_index"><code>connector_response_properties_index</code> - Connector response properties for an index connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_index">config_properties_index</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.index</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_jira"><code>connector_response_properties_jira</code> - Connector response properties for a Jira connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_jira">config_properties_jira</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.jira</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_opsgenie"><code>connector_response_properties_opsgenie</code> - Connector response properties for an Opsgenie connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_opsgenie">config_properties_opsgenie</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.opsgenie</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_pagerduty"><code>connector_response_properties_pagerduty</code> - Connector response properties for a PagerDuty connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_pagerduty">config_properties_pagerduty</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.pagerduty</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_resilient"><code>connector_response_properties_resilient</code> - Connector response properties for a IBM Resilient connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_resilient">config_properties_resilient</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.resilient</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_serverlog"><code>connector_response_properties_serverlog</code> - Connector response properties for a server log connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.server-log</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_servicenow"><code>connector_response_properties_servicenow</code> - Connector response properties for a ServiceNow ITSM connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_servicenow">config_properties_servicenow</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.servicenow</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_servicenow_itom"><code>connector_response_properties_servicenow_itom</code> - Connector response properties for a ServiceNow ITOM connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_servicenow_itom">config_properties_servicenow_itom</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.servicenow-itom</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_servicenow_sir"><code>connector_response_properties_servicenow_sir</code> - Connector response properties for a ServiceNow SecOps connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_servicenow">config_properties_servicenow</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.servicenow-sir</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_slack_api"><code>connector_response_properties_slack_api</code> - Connector response properties for a Slack connector</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="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.slack_api</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_slack_webhook"><code>connector_response_properties_slack_webhook</code> - Connector response properties for a Slack connector</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="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.slack</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_swimlane"><code>connector_response_properties_swimlane</code> - Connector response properties for a Swimlane connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_swimlane">config_properties_swimlane</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.swimlane</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_teams"><code>connector_response_properties_teams</code> - Connector response properties for a Microsoft Teams connector</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="#">Object</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.teams</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_tines"><code>connector_response_properties_tines</code> - Connector response properties for a Tines connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_tines">config_properties_tines</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.tines</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_torq"><code>connector_response_properties_torq</code> - Connector response properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.torq</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_webhook"><code>connector_response_properties_webhook</code> - Connector response properties for a Webhook connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_webhook">config_properties_webhook</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.webhook</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_response_properties_xmatters"><code>connector_response_properties_xmatters</code> - Connector response properties for an xMatters connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.xmatters</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">is_system_action (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> Indicates whether the connector is used for system actions. </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="connector_types"><code>connector_types</code> - Connector types</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="create_connector_request_cases_webhook"><code>create_connector_request_cases_webhook</code> - Create Webhook - Case Managment connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Webhook - Case Management connector uses axios to send POST, PUT, and GET requests to a case management RESTful API web service.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_cases_webhook">config_properties_cases_webhook</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.cases-webhook</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">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_cases_webhook">secrets_properties_cases_webhook</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_d3security"><code>create_connector_request_d3security</code> - Create D3 Security connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The connector uses axios to send a POST request to a D3 Security endpoint.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_d3security">config_properties_d3security</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.d3security</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_d3security">secrets_properties_d3security</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_email"><code>create_connector_request_email</code> - Create email connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The email connector uses the SMTP protocol to send mail messages, using an integration of Nodemailer. An exception is Microsoft Exchange, which uses HTTP protocol for sending emails, Send mail. Email message text is sent as both plain text and html text.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_email">config_properties_email</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.email</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_email">secrets_properties_email</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_genai"><code>create_connector_request_genai</code> - Create OpenAI connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The OpenAI connector uses axios to send a POST request to either OpenAI or Azure OpenAPI.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_genai">config_properties_genai</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.gen-ai</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_genai">secrets_properties_genai</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_index"><code>create_connector_request_index</code> - Create index connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The index connector indexes a document into Elasticsearch.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_index">config_properties_index</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.index</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="create_connector_request_jira"><code>create_connector_request_jira</code> - Create Jira connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Jira connector uses the REST API v2 to create Jira issues.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_jira">config_properties_jira</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.jira</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_jira">secrets_properties_jira</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_opsgenie"><code>create_connector_request_opsgenie</code> - Create Opsgenie connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Opsgenie connector uses the Opsgenie alert API.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_opsgenie">config_properties_opsgenie</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.opsgenie</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_opsgenie">secrets_properties_opsgenie</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_pagerduty"><code>create_connector_request_pagerduty</code> - Create PagerDuty connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The PagerDuty connector uses the v2 Events API to trigger, acknowledge, and resolve PagerDuty alerts.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_pagerduty">config_properties_pagerduty</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.pagerduty</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_pagerduty">secrets_properties_pagerduty</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_resilient"><code>create_connector_request_resilient</code> - Create IBM Resilient connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The IBM Resilient connector uses the RESILIENT REST v2 to create IBM Resilient incidents.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_resilient">config_properties_resilient</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.resilient</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_resilient">secrets_properties_resilient</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_serverlog"><code>create_connector_request_serverlog</code> - Create server log connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>This connector writes an entry to the Kibana server log.</div>
|
|
<div class="field-items">
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.server-log</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="create_connector_request_servicenow"><code>create_connector_request_servicenow</code> - Create ServiceNow ITSM connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The ServiceNow ITSM connector uses the import set API to create ServiceNow incidents. You can use the connector for rule actions and cases.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_servicenow">config_properties_servicenow</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.servicenow</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_servicenow">secrets_properties_servicenow</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_servicenow_itom"><code>create_connector_request_servicenow_itom</code> - Create ServiceNow ITOM connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The ServiceNow ITOM connector uses the event API to create ServiceNow events. You can use the connector for rule actions.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_servicenow_itom">config_properties_servicenow_itom</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.servicenow-itom</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_servicenow">secrets_properties_servicenow</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_servicenow_sir"><code>create_connector_request_servicenow_sir</code> - Create ServiceNow SecOps connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The ServiceNow SecOps connector uses the import set API to create ServiceNow security incidents. You can use the connector for rule actions and cases.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_servicenow">config_properties_servicenow</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.servicenow-sir</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_servicenow">secrets_properties_servicenow</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_slack_api"><code>create_connector_request_slack_api</code> - Create Slack connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Slack connector uses Slack Incoming Webhooks.</div>
|
|
<div class="field-items">
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.slack_api</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_slack_api">secrets_properties_slack_api</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_slack_webhook"><code>create_connector_request_slack_webhook</code> - Create Slack connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Slack connector uses Slack Incoming Webhooks.</div>
|
|
<div class="field-items">
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.slack</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_slack_webhook">secrets_properties_slack_webhook</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_swimlane"><code>create_connector_request_swimlane</code> - Create Swimlane connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Swimlane connector uses the Swimlane REST API to create Swimlane records.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_swimlane">config_properties_swimlane</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.swimlane</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">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="create_connector_request_teams"><code>create_connector_request_teams</code> - Create Microsoft Teams connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Microsoft Teams connector uses Incoming Webhooks.</div>
|
|
<div class="field-items">
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.teams</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_teams">secrets_properties_teams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_tines"><code>create_connector_request_tines</code> - Create Tines connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Tines connector uses Tines Webhook actions to send events via POST request.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_tines">config_properties_tines</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.tines</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_tines">secrets_properties_tines</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_torq"><code>create_connector_request_torq</code> - Create Torq connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.torq</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_torq">secrets_properties_torq</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_webhook"><code>create_connector_request_webhook</code> - Create Webhook connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The Webhook connector uses axios to send a POST or PUT request to a web service.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_webhook">config_properties_webhook</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.webhook</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_webhook">secrets_properties_webhook</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="create_connector_request_xmatters"><code>create_connector_request_xmatters</code> - Create xMatters connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The xMatters connector uses the xMatters Workflow for Elastic to send actionable alerts to on-call xMatters resources.</div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</a></span> </div>
|
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">.xmatters</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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
|
|
</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>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="getConnector_404_response"><code>getConnector_404_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<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>
|
|
<div class="field-items">
|
|
<div class="param">connector_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">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 </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The status of the action. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">error</div><div class="param-enum">ok</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="runConnector_200_response_data"><code>runConnector_200_response_data</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_params_documents"><code>run_connector_params_documents</code> - Index connector parameters</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Test an action that indexes a document into Elasticsearch.</div>
|
|
<div class="field-items">
|
|
<div class="param">documents </div><div class="param-desc"><span class="param-type"><a href="#map">array[map[String, oas_any_type_not_mapped]]</a></span> The documents in JSON format for index connectors. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_params_level_message"><code>run_connector_params_level_message</code> - Server log connector parameters</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Test an action that writes an entry to the Kibana server log.</div>
|
|
<div class="field-items">
|
|
<div class="param">level (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The log level of the message for server log connectors. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">debug</div><div class="param-enum">error</div><div class="param-enum">fatal</div><div class="param-enum">info</div><div class="param-enum">trace</div><div class="param-enum">warn</div>
|
|
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The message for server log connectors. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_addevent"><code>run_connector_subaction_addevent</code> - The addEvent subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>addEvent</code> subaction for ServiceNow ITOM connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">addEvent</div>
|
|
<div class="param">subActionParams (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_addevent_subActionParams">run_connector_subaction_addevent_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_addevent_subActionParams"><code>run_connector_subaction_addevent_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The set of configuration properties for the action.</div>
|
|
<div class="field-items">
|
|
<div class="param">additional_info (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Additional information about the event. </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The details about the event. </div>
|
|
<div class="param">event_class (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A specific instance of the source. </div>
|
|
<div class="param">message_key (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> All actions sharing this key are associated with the same ServiceNow alert. The default value is <code><rule ID>:<alert instance ID></code>. </div>
|
|
<div class="param">metric_name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the metric. </div>
|
|
<div class="param">node (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The host that the event was triggered for. </div>
|
|
<div class="param">resource (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the resource. </div>
|
|
<div class="param">severity (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The severity of the event. </div>
|
|
<div class="param">source (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The name of the event source type. </div>
|
|
<div class="param">time_of_event (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The time of the event. </div>
|
|
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of event. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_closealert"><code>run_connector_subaction_closealert</code> - The closeAlert subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>closeAlert</code> subaction for Opsgenie connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">closeAlert</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_closealert_subActionParams">run_connector_subaction_closealert_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_closealert_subActionParams"><code>run_connector_subaction_closealert_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">alias </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The unique identifier used for alert deduplication in Opsgenie. The alias must match the value used when creating the alert. </div>
|
|
<div class="param">note (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Additional information for the alert. </div>
|
|
<div class="param">source (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the source of the alert. </div>
|
|
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the owner. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_createalert"><code>run_connector_subaction_createalert</code> - The createAlert subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>createAlert</code> subaction for Opsgenie connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">createAlert</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_createalert_subActionParams">run_connector_subaction_createalert_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_createalert_subActionParams"><code>run_connector_subaction_createalert_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">actions (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> The custom actions available to the alert. </div>
|
|
<div class="param">alias (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The unique identifier used for alert deduplication in Opsgenie. </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A description that provides detailed information about the alert. </div>
|
|
<div class="param">details (optional)</div><div class="param-desc"><span class="param-type"><a href="#AnyType">map[String, oas_any_type_not_mapped]</a></span> The custom properties of the alert. </div>
|
|
<div class="param">entity (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The domain of the alert. For example, the application or server name. </div>
|
|
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The alert message. </div>
|
|
<div class="param">note (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Additional information for the alert. </div>
|
|
<div class="param">priority (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The priority level for the alert. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">P1</div><div class="param-enum">P2</div><div class="param-enum">P3</div><div class="param-enum">P4</div><div class="param-enum">P5</div>
|
|
<div class="param">responders (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_createalert_subActionParams_responders_inner">array[run_connector_subaction_createalert_subActionParams_responders_inner]</a></span> The entities to receive notifications about the alert. If <code>type</code> is <code>user</code>, either <code>id</code> or <code>username</code> is required. If <code>type</code> is <code>team</code>, either <code>id</code> or <code>name</code> is required. </div>
|
|
<div class="param">source (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the source of the alert. </div>
|
|
<div class="param">tags (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> The tags for the alert. </div>
|
|
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the owner. </div>
|
|
<div class="param">visibleTo (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_createalert_subActionParams_visibleTo_inner">array[run_connector_subaction_createalert_subActionParams_visibleTo_inner]</a></span> The teams and users that the alert will be visible to without sending a notification. Only one of <code>id</code>, <code>name</code>, or <code>username</code> is required. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_createalert_subActionParams_responders_inner"><code>run_connector_subaction_createalert_subActionParams_responders_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the entity. </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 entity. </div>
|
|
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of responders, in this case <code>escalation</code>. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">escalation</div><div class="param-enum">schedule</div><div class="param-enum">team</div><div class="param-enum">user</div>
|
|
<div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A valid email address for the user. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_createalert_subActionParams_visibleTo_inner"><code>run_connector_subaction_createalert_subActionParams_visibleTo_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The identifier for the entity. </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 entity. </div>
|
|
<div class="param">type </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Valid values are <code>team</code> and <code>user</code>. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">team</div><div class="param-enum">user</div>
|
|
<div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The user name. This property is required only when the <code>type</code> is <code>user</code>. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_fieldsbyissuetype"><code>run_connector_subaction_fieldsbyissuetype</code> - The fieldsByIssueType subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>fieldsByIssueType</code> subaction for Jira connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">fieldsByIssueType</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_fieldsbyissuetype_subActionParams">run_connector_subaction_fieldsbyissuetype_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_fieldsbyissuetype_subActionParams"><code>run_connector_subaction_fieldsbyissuetype_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Jira issue type identifier. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_getchoices"><code>run_connector_subaction_getchoices</code> - The getChoices subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>getChoices</code> subaction for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">getChoices</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_getchoices_subActionParams">run_connector_subaction_getchoices_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_getchoices_subActionParams"><code>run_connector_subaction_getchoices_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The set of configuration properties for the action.</div>
|
|
<div class="field-items">
|
|
<div class="param">fields </div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> An array of fields. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_getfields"><code>run_connector_subaction_getfields</code> - The getFields subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>getFields</code> subaction for Jira, ServiceNow ITSM, and ServiceNow SecOps connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">getFields</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_getincident"><code>run_connector_subaction_getincident</code> - The getIncident subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>getIncident</code> subaction for Jira, ServiceNow ITSM, and ServiceNow SecOps connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">getIncident</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_getincident_subActionParams">run_connector_subaction_getincident_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_getincident_subActionParams"><code>run_connector_subaction_getincident_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">externalId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Jira, ServiceNow ITSM, or ServiceNow SecOps issue identifier. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_issue"><code>run_connector_subaction_issue</code> - The issue subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>issue</code> subaction for Jira connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">issue</div>
|
|
<div class="param">subActionParams (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_issue_subActionParams">run_connector_subaction_issue_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_issue_subActionParams"><code>run_connector_subaction_issue_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Jira issue identifier. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_issues"><code>run_connector_subaction_issues</code> - The issues subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>issues</code> subaction for Jira connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">issues</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_issues_subActionParams">run_connector_subaction_issues_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_issues_subActionParams"><code>run_connector_subaction_issues_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">title </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The title of the Jira issue. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_issuetypes"><code>run_connector_subaction_issuetypes</code> - The issueTypes subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>issueTypes</code> subaction for Jira connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">issueTypes</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_pushtoservice"><code>run_connector_subaction_pushtoservice</code> - The pushToService subaction</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The <code>pushToService</code> subaction for Jira, ServiceNow ITSM, ServiceNow SecOps, and Swimlane connectors.</div>
|
|
<div class="field-items">
|
|
<div class="param">subAction </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The action to test. </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">pushToService</div>
|
|
<div class="param">subActionParams </div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams">run_connector_subaction_pushtoservice_subActionParams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_pushtoservice_subActionParams"><code>run_connector_subaction_pushtoservice_subActionParams</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>The set of configuration properties for the action.</div>
|
|
<div class="field-items">
|
|
<div class="param">comments (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams_comments_inner">array[run_connector_subaction_pushtoservice_subActionParams_comments_inner]</a></span> Additional information that is sent to Jira, ServiceNow ITSM, ServiceNow SecOps, or Swimlane. </div>
|
|
<div class="param">incident (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams_incident">run_connector_subaction_pushtoservice_subActionParams_incident</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_pushtoservice_subActionParams_comments_inner"><code>run_connector_subaction_pushtoservice_subActionParams_comments_inner</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">comment (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A comment related to the incident. For example, describe how to troubleshoot the issue. </div>
|
|
<div class="param">commentId (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> A unique identifier for the comment. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_pushtoservice_subActionParams_incident"><code>run_connector_subaction_pushtoservice_subActionParams_incident</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Information necessary to create or update a Jira, ServiceNow ITSM, ServiveNow SecOps, or Swimlane incident.</div>
|
|
<div class="field-items">
|
|
<div class="param">alertId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The alert identifier for Swimlane connectors. </div>
|
|
<div class="param">caseId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The case identifier for the incident for Swimlane connectors. </div>
|
|
<div class="param">caseName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The case name for the incident for Swimlane connectors. </div>
|
|
<div class="param">category (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors. </div>
|
|
<div class="param">correlation_display (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A descriptive label of the alert for correlation purposes for ServiceNow ITSM and ServiceNow SecOps connectors. </div>
|
|
<div class="param">correlation_id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The correlation identifier for the security incident for ServiceNow ITSM and ServiveNow SecOps connectors. Connectors using the same correlation ID are associated with the same ServiceNow incident. This value determines whether a new ServiceNow incident is created or an existing one is updated. Modifying this value is optional; if not modified, the rule ID and alert ID are combined as <code>{{ruleID}}:{{alert ID}}</code> to form the correlation ID value in ServiceNow. The maximum character length for this value is 100 characters. NOTE: Using the default configuration of <code>{{ruleID}}:{{alert ID}}</code> ensures that ServiceNow creates a separate incident record for every generated alert that uses a unique alert ID. If the rule generates multiple alerts that use the same alert IDs, ServiceNow creates and continually updates a single incident record for the alert. </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The description of the incident for Jira, ServiceNow ITSM, ServiceNow SecOps, and Swimlane connectors. </div>
|
|
<div class="param">dest_ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_dest_ip">run_connector_subaction_pushtoservice_subActionParams_incident_dest_ip</a></span> </div>
|
|
<div class="param">externalId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Jira, ServiceNow ITSM, or ServiceNow SecOps issue identifier. If present, the incident is updated. Otherwise, a new incident is created. </div>
|
|
<div class="param">impact (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The impact of the incident for ServiceNow ITSM connectors. </div>
|
|
<div class="param">issueType (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> The type of incident for Jira connectors. For example, 10006. To obtain the list of valid values, set <code>subAction</code> to <code>issueTypes</code>. </div>
|
|
<div class="param">labels (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> The labels for the incident for Jira connectors. NOTE: Labels cannot contain spaces. </div>
|
|
<div class="param">malware_hash (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_malware_hash">run_connector_subaction_pushtoservice_subActionParams_incident_malware_hash</a></span> </div>
|
|
<div class="param">malware_url (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_malware_url">run_connector_subaction_pushtoservice_subActionParams_incident_malware_url</a></span> </div>
|
|
<div class="param">parent (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The ID or key of the parent issue for Jira connectors. Applies only to <code>Sub-task</code> types of issues. </div>
|
|
<div class="param">priority (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The priority of the incident in Jira and ServiceNow SecOps connectors. </div>
|
|
<div class="param">ruleName (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The rule name for Swimlane connectors. </div>
|
|
<div class="param">severity (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The severity of the incident for ServiceNow ITSM and Swimlane connectors. </div>
|
|
<div class="param">short_description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A short description of the incident for ServiceNow ITSM and ServiceNow SecOps connectors. It is used for searching the contents of the knowledge base. </div>
|
|
<div class="param">source_ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#run_connector_subaction_pushtoservice_subActionParams_incident_source_ip">run_connector_subaction_pushtoservice_subActionParams_incident_source_ip</a></span> </div>
|
|
<div class="param">subcategory (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The subcategory of the incident for ServiceNow ITSM and ServiceNow SecOps connectors. </div>
|
|
<div class="param">summary (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A summary of the incident for Jira connectors. </div>
|
|
<div class="param">title (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A title for the incident for Jira connectors. It is used for searching the contents of the knowledge base. </div>
|
|
<div class="param">urgency (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The urgency of the incident for ServiceNow ITSM connectors. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_pushtoservice_subActionParams_incident_dest_ip"><code>run_connector_subaction_pushtoservice_subActionParams_incident_dest_ip</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>A list of destination IP addresses related to the security incident for ServiceNow SecOps connectors. The IPs are added as observables to the security incident.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_pushtoservice_subActionParams_incident_malware_hash"><code>run_connector_subaction_pushtoservice_subActionParams_incident_malware_hash</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>A list of malware hashes related to the security incident for ServiceNow SecOps connectors. The hashes are added as observables to the security incident.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_pushtoservice_subActionParams_incident_malware_url"><code>run_connector_subaction_pushtoservice_subActionParams_incident_malware_url</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>A list of malware URLs related to the security incident for ServiceNow SecOps connectors. The URLs are added as observables to the security incident.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="run_connector_subaction_pushtoservice_subActionParams_incident_source_ip"><code>run_connector_subaction_pushtoservice_subActionParams_incident_source_ip</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>A list of source IP addresses related to the security incident for ServiceNow SecOps connectors. The IPs are added as observables to the security incident.</div>
|
|
<div class="field-items">
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_cases_webhook"><code>secrets_properties_cases_webhook</code> - Connector secrets properties for Webhook - Case Management connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The password for HTTP basic authentication. If <code>hasAuth</code> is set to <code>true</code>, this property is required. </div>
|
|
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The username for HTTP basic authentication. If <code>hasAuth</code> is set to <code>true</code>, this property is required. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_d3security"><code>secrets_properties_d3security</code> - Connector secrets properties for a D3 Security connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.d3security</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The D3 Security token. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_email"><code>secrets_properties_email</code> - Connector secrets properties for an email connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.email</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">clientSecret (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Microsoft Exchange Client secret for OAuth 2.0 client credentials authentication. It must be URL-encoded. If <code>service</code> is <code>exchange_server</code>, this property is required. </div>
|
|
<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The password for HTTP basic authentication. If <code>hasAuth</code> is set to <code>true</code>, this property is required. </div>
|
|
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The username for HTTP basic authentication. If <code>hasAuth</code> is set to <code>true</code>, this property is required. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_genai"><code>secrets_properties_genai</code> - Connector secrets properties for an OpenAI connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.gen-ai</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiKey (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API key. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_jira"><code>secrets_properties_jira</code> - Connector secrets properties for a Jira connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.jira</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiToken </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Jira API authentication token for HTTP basic authentication. </div>
|
|
<div class="param">email </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The account email for HTTP Basic authentication. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_opsgenie"><code>secrets_properties_opsgenie</code> - Connector secrets properties for an Opsgenie connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.opsgenie</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiKey </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Opsgenie API authentication key for HTTP Basic authentication. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_pagerduty"><code>secrets_properties_pagerduty</code> - Connector secrets properties for a PagerDuty connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.pagerduty</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">routingKey </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A 32 character PagerDuty Integration Key for an integration on a service. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_resilient"><code>secrets_properties_resilient</code> - Connector secrets properties for IBM Resilient connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.resilient</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiKeyId </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The authentication key ID for HTTP Basic authentication. </div>
|
|
<div class="param">apiKeySecret </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The authentication key secret for HTTP Basic authentication. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_servicenow"><code>secrets_properties_servicenow</code> - Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.servicenow</code>, <code>.servicenow-sir</code>, or <code>.servicenow-itom</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">clientSecret (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The client secret assigned to your OAuth application. This property is required when <code>isOAuth</code> is <code>true</code>. </div>
|
|
<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The password for HTTP basic authentication. This property is required when <code>isOAuth</code> is <code>false</code>. </div>
|
|
<div class="param">privateKey (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The RSA private key that you created for use in ServiceNow. This property is required when <code>isOAuth</code> is <code>true</code>. </div>
|
|
<div class="param">privateKeyPassword (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The password for the RSA private key. This property is required when <code>isOAuth</code> is <code>true</code> and you set a password on your private key. </div>
|
|
<div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The username for HTTP basic authentication. This property is required when <code>isOAuth</code> is <code>false</code>. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_slack_api"><code>secrets_properties_slack_api</code> - Connector secrets properties for a Web API Slack connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.slack</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Slack bot user OAuth token. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_slack_webhook"><code>secrets_properties_slack_webhook</code> - Connector secrets properties for a Webhook Slack connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.slack</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">webhookUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Slack webhook url. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_swimlane"><code>secrets_properties_swimlane</code> - Connector secrets properties for a Swimlane connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.swimlane</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">apiToken (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Swimlane API authentication token. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_teams"><code>secrets_properties_teams</code> - Connector secrets properties for a Microsoft Teams connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.teams</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">webhookUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The URL of the incoming webhook. If you are using the <code>xpack.actions.allowedHosts</code> setting, add the hostname to the allowed hosts. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_tines"><code>secrets_properties_tines</code> - Connector secrets properties for a Tines connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.tines</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">email </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The email used to sign in to Tines. </div>
|
|
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The Tines API token. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_torq"><code>secrets_properties_torq</code> - Connector secrets properties for a Torq connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.torq</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">token </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The secret of the webhook authentication header. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_webhook"><code>secrets_properties_webhook</code> - Connector secrets properties for a Webhook connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.webhook</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">crt (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> If <code>authType</code> is <code>webhook-authentication-ssl</code> and <code>certType</code> is <code>ssl-crt-key</code>, it is a base64 encoded version of the CRT or CERT file. </div>
|
|
<div class="param">key (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> If <code>authType</code> is <code>webhook-authentication-ssl</code> and <code>certType</code> is <code>ssl-crt-key</code>, it is a base64 encoded version of the KEY file. </div>
|
|
<div class="param">pfx (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> If <code>authType</code> is <code>webhook-authentication-ssl</code> and <code>certType</code> is <code>ssl-pfx</code>, it is a base64 encoded version of the PFX or P12 file. </div>
|
|
<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The password for HTTP basic authentication or the passphrase for the SSL certificate files. If <code>hasAuth</code> is set to <code>true</code> and <code>authType</code> is <code>webhook-authentication-basic</code>, this property is required. </div>
|
|
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The username for HTTP basic authentication. If <code>hasAuth</code> is set to <code>true</code> and <code>authType</code> is <code>webhook-authentication-basic</code>, this property is required. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="secrets_properties_xmatters"><code>secrets_properties_xmatters</code> - Connector secrets properties for an xMatters connector</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'>Defines secrets for connectors when type is <code>.xmatters</code>.</div>
|
|
<div class="field-items">
|
|
<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A user name for HTTP basic authentication. It is applicable only when <code>usesBasic</code> is <code>true</code>. </div>
|
|
<div class="param">secretsUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL. It is applicable only when <code>usesBasic</code> is <code>false</code>. </div>
|
|
<div class="param">user (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A password for HTTP basic authentication. It is applicable only when <code>usesBasic</code> is <code>true</code>. </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="updateConnector_400_response"><code>updateConnector_400_response</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">error (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<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="update_connector_request_cases_webhook"><code>update_connector_request_cases_webhook</code> - Update Webhook - Case Managment connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_cases_webhook">config_properties_cases_webhook</a></span> </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">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_cases_webhook">secrets_properties_cases_webhook</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_d3security"><code>update_connector_request_d3security</code> - Update D3 Security connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_d3security">config_properties_d3security</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_d3security">secrets_properties_d3security</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_email"><code>update_connector_request_email</code> - Update email connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_email">config_properties_email</a></span> </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">secrets (optional)</div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_email">secrets_properties_email</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_index"><code>update_connector_request_index</code> - Update index connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_index">config_properties_index</a></span> </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="update_connector_request_jira"><code>update_connector_request_jira</code> - Update Jira connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_jira">config_properties_jira</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_jira">secrets_properties_jira</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_opsgenie"><code>update_connector_request_opsgenie</code> - Update Opsgenie connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_opsgenie">config_properties_opsgenie</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_opsgenie">secrets_properties_opsgenie</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_pagerduty"><code>update_connector_request_pagerduty</code> - Update PagerDuty connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_pagerduty">config_properties_pagerduty</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_pagerduty">secrets_properties_pagerduty</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_resilient"><code>update_connector_request_resilient</code> - Update IBM Resilient connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_resilient">config_properties_resilient</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_resilient">secrets_properties_resilient</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_serverlog"><code>update_connector_request_serverlog</code> - Update server log connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<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="update_connector_request_servicenow"><code>update_connector_request_servicenow</code> - Update ServiceNow ITSM connector or ServiceNow SecOps request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_servicenow">config_properties_servicenow</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_servicenow">secrets_properties_servicenow</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_servicenow_itom"><code>update_connector_request_servicenow_itom</code> - Create ServiceNow ITOM connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_servicenow_itom">config_properties_servicenow_itom</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_servicenow">secrets_properties_servicenow</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_slack_api"><code>update_connector_request_slack_api</code> - Update Slack connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_slack_api">secrets_properties_slack_api</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_slack_webhook"><code>update_connector_request_slack_webhook</code> - Update Slack connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_slack_webhook">secrets_properties_slack_webhook</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_swimlane"><code>update_connector_request_swimlane</code> - Update Swimlane connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_swimlane">config_properties_swimlane</a></span> </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">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="update_connector_request_teams"><code>update_connector_request_teams</code> - Update Microsoft Teams connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_teams">secrets_properties_teams</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_tines"><code>update_connector_request_tines</code> - Update Tines connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_tines">config_properties_tines</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_tines">secrets_properties_tines</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_torq"><code>update_connector_request_torq</code> - Update Torq connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_torq">config_properties_torq</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_torq">secrets_properties_torq</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_webhook"><code>update_connector_request_webhook</code> - Update Webhook connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_webhook">config_properties_webhook</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_webhook">secrets_properties_webhook</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3><a name="update_connector_request_xmatters"><code>update_connector_request_xmatters</code> - Update xMatters connector request</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class='model-description'></div>
|
|
<div class="field-items">
|
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</a></span> </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">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
</div>
|
|
++++
|