+
- {controlsEnabled && controlGroup && viewMode !== ViewMode.PRINT ? (
+ {controlGroup && viewMode !== ViewMode.PRINT ? (
0 ? 'dshDashboardViewport-controls' : ''}
ref={controlsRoot}
diff --git a/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts b/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
index d9a7f95108e47d..0862d6ece004a4 100644
--- a/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
+++ b/src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
@@ -489,10 +489,6 @@ export const stackManagementSchema: MakeSchemaFrom = {
type: 'boolean',
_meta: { description: 'Non-default value of setting.' },
},
- 'labs:dashboard:dashboardControls': {
- type: 'boolean',
- _meta: { description: 'Non-default value of setting.' },
- },
'labs:dashboard:linksPanel': {
type: 'boolean',
_meta: { description: 'Non-default value of setting.' },
diff --git a/src/plugins/kibana_usage_collection/server/collectors/management/types.ts b/src/plugins/kibana_usage_collection/server/collectors/management/types.ts
index 013b3de0574226..3499471e0d5a82 100644
--- a/src/plugins/kibana_usage_collection/server/collectors/management/types.ts
+++ b/src/plugins/kibana_usage_collection/server/collectors/management/types.ts
@@ -137,7 +137,6 @@ export interface UsageStats {
'labs:dashboard:enable_ui': boolean;
'labs:dashboard:linksPanel': boolean;
'labs:dashboard:deferBelowFold': boolean;
- 'labs:dashboard:dashboardControls': boolean;
'discover:rowHeightOption': number;
hideAnnouncements: boolean;
isDefaultIndexMigrated: boolean;
diff --git a/src/plugins/no_data_page/config.ts b/src/plugins/no_data_page/config.ts
index 8fae1aad10aaab..729f13000a0ba8 100644
--- a/src/plugins/no_data_page/config.ts
+++ b/src/plugins/no_data_page/config.ts
@@ -11,7 +11,13 @@ import { schema, TypeOf, offeringBasedSchema } from '@kbn/config-schema';
export const configSchema = schema.object({
analyticsNoDataPageFlavor: offeringBasedSchema({
serverless: schema.oneOf(
- [schema.oneOf([schema.literal('kibana'), schema.literal('serverless_search')])],
+ [
+ schema.oneOf([
+ schema.literal('kibana'),
+ schema.literal('serverless_search'),
+ schema.literal('serverless_observability'),
+ ]),
+ ],
{ defaultValue: 'kibana' as const }
),
}),
diff --git a/src/plugins/no_data_page/public/types.ts b/src/plugins/no_data_page/public/types.ts
index c9523f7fcd93a2..2e33170ec06bf7 100644
--- a/src/plugins/no_data_page/public/types.ts
+++ b/src/plugins/no_data_page/public/types.ts
@@ -7,7 +7,7 @@
*/
export interface NoDataPagePluginSetup {
- getAnalyticsNoDataPageFlavor: () => 'kibana' | 'serverless_search';
+ getAnalyticsNoDataPageFlavor: () => 'kibana' | 'serverless_search' | 'serverless_observability';
}
export type NoDataPagePluginStart = NoDataPagePluginSetup;
diff --git a/src/plugins/presentation_util/common/labs.ts b/src/plugins/presentation_util/common/labs.ts
index 18fd77a3644294..a6ac9c7d8ae71c 100644
--- a/src/plugins/presentation_util/common/labs.ts
+++ b/src/plugins/presentation_util/common/labs.ts
@@ -11,15 +11,9 @@ import { i18n } from '@kbn/i18n';
export const LABS_PROJECT_PREFIX = 'labs:';
export const DEFER_BELOW_FOLD = `${LABS_PROJECT_PREFIX}dashboard:deferBelowFold` as const;
export const DASHBOARD_LINKS_PANEL = `${LABS_PROJECT_PREFIX}dashboard:linksPanel` as const;
-export const DASHBOARD_CONTROLS = `${LABS_PROJECT_PREFIX}dashboard:dashboardControls` as const;
export const BY_VALUE_EMBEDDABLE = `${LABS_PROJECT_PREFIX}canvas:byValueEmbeddable` as const;
-export const projectIDs = [
- DEFER_BELOW_FOLD,
- DASHBOARD_CONTROLS,
- BY_VALUE_EMBEDDABLE,
- DASHBOARD_LINKS_PANEL,
-] as const;
+export const projectIDs = [DEFER_BELOW_FOLD, BY_VALUE_EMBEDDABLE, DASHBOARD_LINKS_PANEL] as const;
export const environmentNames = ['kibana', 'browser', 'session'] as const;
export const solutionNames = ['canvas', 'dashboard', 'presentation'] as const;
@@ -49,20 +43,6 @@ export const projects: { [ID in ProjectID]: ProjectConfig & { id: ID } } = {
}),
solutions: ['dashboard'],
},
- [DASHBOARD_CONTROLS]: {
- id: DASHBOARD_CONTROLS,
- isActive: true,
- isDisplayed: true,
- environments: ['kibana', 'browser', 'session'],
- name: i18n.translate('presentationUtil.labs.enableDashboardControlsProjectName', {
- defaultMessage: 'Enable dashboard controls',
- }),
- description: i18n.translate('presentationUtil.labs.enableDashboardControlsProjectDescription', {
- defaultMessage:
- 'Enables the controls system for dashboard, which allows dashboard authors to more easily build interactive elements for their users.',
- }),
- solutions: ['dashboard'],
- },
[DASHBOARD_LINKS_PANEL]: {
id: DASHBOARD_LINKS_PANEL,
isActive: true,
diff --git a/src/plugins/telemetry/schema/oss_plugins.json b/src/plugins/telemetry/schema/oss_plugins.json
index 8f2a80e5009869..0854944f394042 100644
--- a/src/plugins/telemetry/schema/oss_plugins.json
+++ b/src/plugins/telemetry/schema/oss_plugins.json
@@ -9923,12 +9923,6 @@
"description": "Non-default value of setting."
}
},
- "labs:dashboard:dashboardControls": {
- "type": "boolean",
- "_meta": {
- "description": "Non-default value of setting."
- }
- },
"labs:dashboard:linksPanel": {
"type": "boolean",
"_meta": {
diff --git a/test/functional/apps/dashboard_elements/controls/common/index.ts b/test/functional/apps/dashboard_elements/controls/common/index.ts
index 8a9a7b8a548340..74e64052f1663b 100644
--- a/test/functional/apps/dashboard_elements/controls/common/index.ts
+++ b/test/functional/apps/dashboard_elements/controls/common/index.ts
@@ -13,7 +13,7 @@ export default function ({ loadTestFile, getService, getPageObjects }: FtrProvid
const kibanaServer = getService('kibanaServer');
const security = getService('security');
- const { dashboardControls, dashboard } = getPageObjects(['dashboardControls', 'dashboard']);
+ const { dashboard } = getPageObjects(['dashboard']);
async function setup() {
await esArchiver.loadIfNeeded('test/functional/fixtures/es_archiver/dashboard/current/data');
@@ -28,8 +28,6 @@ export default function ({ loadTestFile, getService, getPageObjects }: FtrProvid
// enable the controls lab and navigate to the dashboard listing page to start
await dashboard.navigateToApp();
- await dashboardControls.enableControlsLab();
- await dashboard.navigateToApp();
await dashboard.preserveCrossAppState();
}
diff --git a/test/functional/apps/dashboard_elements/controls/common/range_slider.ts b/test/functional/apps/dashboard_elements/controls/common/range_slider.ts
index b97acde63f40bb..17a1873ed098fe 100644
--- a/test/functional/apps/dashboard_elements/controls/common/range_slider.ts
+++ b/test/functional/apps/dashboard_elements/controls/common/range_slider.ts
@@ -50,8 +50,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
to: 'Dec 3, 2018 @ 00:00:00.000',
});
await dashboard.navigateToApp();
- await dashboardControls.enableControlsLab();
- await dashboard.navigateToApp();
await dashboard.preserveCrossAppState();
await dashboard.gotoDashboardLandingPage();
await dashboard.clickNewDashboard();
diff --git a/test/functional/page_objects/dashboard_page_controls.ts b/test/functional/page_objects/dashboard_page_controls.ts
index 720ff928b5605a..f3d828a04d9cc9 100644
--- a/test/functional/page_objects/dashboard_page_controls.ts
+++ b/test/functional/page_objects/dashboard_page_controls.ts
@@ -54,26 +54,11 @@ export class DashboardPageControls extends FtrService {
private readonly testSubjects = this.ctx.getService('testSubjects');
private readonly common = this.ctx.getPageObject('common');
- private readonly header = this.ctx.getPageObject('header');
- private readonly settings = this.ctx.getPageObject('settings');
/* -----------------------------------------------------------
General controls functions
----------------------------------------------------------- */
- public async enableControlsLab() {
- await this.header.clickStackManagement();
- await this.settings.clickKibanaSettings();
-
- const currentValue = await this.settings.getAdvancedSettingAriaCheckbox(
- 'labs:dashboard:dashboardControls'
- );
-
- if (currentValue !== 'true') {
- await this.settings.toggleAdvancedSettingCheckbox('labs:dashboard:dashboardControls');
- }
- }
-
public async expectControlsEmpty() {
await this.testSubjects.existOrFail('controls-empty');
}
diff --git a/x-pack/plugins/actions/docs/openapi/README.md b/x-pack/plugins/actions/docs/openapi/README.md
index cb0ebce1448765..2bce08f0b1a4c6 100644
--- a/x-pack/plugins/actions/docs/openapi/README.md
+++ b/x-pack/plugins/actions/docs/openapi/README.md
@@ -16,19 +16,23 @@ A guide about the openApi specification can be found at [https://swagger.io/docs
It is possible to validate the docs before bundling them with the following
command in the `x-pack/plugins/actions/docs/openapi/` folder:
- ```
- npx swagger-cli validate entrypoint.yaml
- ```
+```
+npx swagger-cli validate entrypoint.yaml
+npx swagger-cli validate entrypoint_serverless.yaml
+```
Then you can generate the `bundled` files by running the following commands:
- ```
- npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
- npx @redocly/cli bundle entrypoint.yaml --output bundled.json --ext json
- ```
+```
+npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
+npx @redocly/cli bundle entrypoint.yaml --output bundled.json --ext json
+npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.yaml --ext yaml
+npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.json --ext json
+```
You can run additional linting with the following command:
- ```
- npx @redocly/cli lint bundled.json
- ```
+```
+npx @redocly/cli lint bundled.json
+npx @redocly/cli lint bundled_serverless.json
+```
diff --git a/x-pack/plugins/actions/docs/openapi/bundled.json b/x-pack/plugins/actions/docs/openapi/bundled.json
index 1db5f55b1c7441..06ef16a71f200f 100644
--- a/x-pack/plugins/actions/docs/openapi/bundled.json
+++ b/x-pack/plugins/actions/docs/openapi/bundled.json
@@ -33,10 +33,546 @@
}
],
"paths": {
+ "/api/actions/connector": {
+ "post": {
+ "summary": "Creates a connector.",
+ "operationId": "createConnector",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/create_connector_request"
+ },
+ "examples": {
+ "createEmailConnectorRequest": {
+ "$ref": "#/components/examples/create_email_connector_request"
+ },
+ "createIndexConnectorRequest": {
+ "$ref": "#/components/examples/create_index_connector_request"
+ },
+ "createWebhookConnectorRequest": {
+ "$ref": "#/components/examples/create_webhook_connector_request"
+ },
+ "createXmattersConnectorRequest": {
+ "$ref": "#/components/examples/create_xmatters_connector_request"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ },
+ "examples": {
+ "createEmailConnectorResponse": {
+ "$ref": "#/components/examples/create_email_connector_response"
+ },
+ "createIndexConnectorResponse": {
+ "$ref": "#/components/examples/create_index_connector_response"
+ },
+ "createWebhookConnectorResponse": {
+ "$ref": "#/components/examples/create_webhook_connector_response"
+ },
+ "createXmattersConnectorResponse": {
+ "$ref": "#/components/examples/create_xmatters_connector_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "/api/actions/connector/{connectorId}": {
+ "get": {
+ "summary": "Retrieves a connector by ID.",
+ "operationId": "getConnector",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/connector_id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ },
+ "examples": {
+ "getConnectorResponse": {
+ "$ref": "#/components/examples/get_connector_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "delete": {
+ "summary": "Deletes a connector.",
+ "operationId": "deleteConnector",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ },
+ {
+ "$ref": "#/components/parameters/connector_id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Indicates a successful call."
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Creates a connector.",
+ "operationId": "createConnectorId",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ },
+ {
+ "in": "path",
+ "name": "connectorId",
+ "description": "A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated.\n",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/create_connector_request"
+ },
+ "examples": {
+ "createIndexConnectorRequest": {
+ "$ref": "#/components/examples/create_index_connector_request"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ },
+ "examples": {
+ "createIndexConnectorResponse": {
+ "$ref": "#/components/examples/create_index_connector_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "put": {
+ "summary": "Updates the attributes for a connector.",
+ "operationId": "updateConnector",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ },
+ {
+ "$ref": "#/components/parameters/connector_id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/update_connector_request"
+ },
+ "examples": {
+ "updateIndexConnectorRequest": {
+ "$ref": "#/components/examples/update_index_connector_request"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/401"
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "/api/actions/connector/{connectorId}/_execute": {
+ "post": {
+ "summary": "Runs a connector.",
+ "operationId": "runConnector",
+ "description": "You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges.\n",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ },
+ {
+ "$ref": "#/components/parameters/connector_id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/run_connector_request"
+ },
+ "examples": {
+ "runIndexConnectorRequest": {
+ "$ref": "#/components/examples/run_index_connector_request"
+ },
+ "runJiraConnectorRequest": {
+ "$ref": "#/components/examples/run_jira_connector_request"
+ },
+ "runServerLogConnectorRequest": {
+ "$ref": "#/components/examples/run_server_log_connector_request"
+ },
+ "runServiceNowITOMConnectorRequest": {
+ "$ref": "#/components/examples/run_servicenow_itom_connector_request"
+ },
+ "runSwimlaneConnectorRequest": {
+ "$ref": "#/components/examples/run_swimlane_connector_request"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "connector_id",
+ "status"
+ ],
+ "properties": {
+ "connector_id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "data": {
+ "oneOf": [
+ {
+ "type": "object",
+ "description": "Information returned from the action.",
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "description": "An array of information returned from the action.",
+ "items": {
+ "type": "object"
+ }
+ }
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the action.",
+ "enum": [
+ "error",
+ "ok"
+ ]
+ }
+ }
+ },
+ "examples": {
+ "runIndexConnectorResponse": {
+ "$ref": "#/components/examples/run_index_connector_response"
+ },
+ "runJiraConnectorResponse": {
+ "$ref": "#/components/examples/run_jira_connector_response"
+ },
+ "runServerLogConnectorResponse": {
+ "$ref": "#/components/examples/run_server_log_connector_response"
+ },
+ "runServiceNowITOMConnectorResponse": {
+ "$ref": "#/components/examples/run_servicenow_itom_connector_response"
+ },
+ "runSwimlaneConnectorResponse": {
+ "$ref": "#/components/examples/run_swimlane_connector_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "/api/actions/connectors": {
+ "get": {
+ "summary": "Retrieves all connectors.",
+ "operationId": "getConnectors",
+ "tags": [
+ "connectors"
+ ],
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ }
+ },
+ "examples": {
+ "getConnectorsResponse": {
+ "$ref": "#/components/examples/get_connectors_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "/api/actions/connector_types": {
+ "get": {
+ "summary": "Retrieves a list of all connector types.",
+ "operationId": "getConnectorTypes",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "feature_id",
+ "description": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).",
+ "schema": {
+ "$ref": "#/components/schemas/features"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Get connector types response body properties",
+ "description": "The properties vary for each connector type.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Indicates whether the connector type is enabled in Kibana.",
+ "example": true
+ },
+ "enabled_in_config": {
+ "type": "boolean",
+ "description": "Indicates whether the connector type is enabled in the Kibana configuration file.",
+ "example": true
+ },
+ "enabled_in_license": {
+ "type": "boolean",
+ "description": "Indicates whether the connector is enabled in the license.",
+ "example": true
+ },
+ "id": {
+ "$ref": "#/components/schemas/connector_types"
+ },
+ "is_system_action_type": {
+ "type": "boolean",
+ "example": false
+ },
+ "minimum_license_required": {
+ "type": "string",
+ "description": "The license that is required to use the connector type.",
+ "example": "basic"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the connector type.",
+ "example": "Index"
+ },
+ "supported_feature_ids": {
+ "type": "array",
+ "description": "The features that are supported by the connector type.",
+ "items": {
+ "$ref": "#/components/schemas/features"
+ },
+ "example": [
+ "alerting",
+ "cases",
+ "siem"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "getConnectorTypesServerlessResponse": {
+ "$ref": "#/components/examples/get_connector_types_generativeai_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
"/s/{spaceId}/api/actions/connector": {
"post": {
"summary": "Creates a connector.",
- "operationId": "createConnector",
+ "operationId": "createConnectorWithSpaceId",
"description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
"tags": [
"connectors"
@@ -54,79 +590,7 @@
"content": {
"application/json": {
"schema": {
- "title": "Create connector request body properties",
- "description": "The properties vary depending on the connector type.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/create_connector_request_bedrock"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_cases_webhook"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_d3security"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_email"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_genai"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_index"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_jira"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_opsgenie"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_pagerduty"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_resilient"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_serverlog"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_servicenow"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_servicenow_itom"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_servicenow_sir"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_slack_api"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_slack_webhook"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_swimlane"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_teams"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_tines"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_torq"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_webhook"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_xmatters"
- }
- ],
- "discriminator": {
- "propertyName": "connector_type_id"
- }
+ "$ref": "#/components/schemas/create_connector_request"
},
"examples": {
"createEmailConnectorRequest": {
@@ -189,7 +653,7 @@
"/s/{spaceId}/api/actions/connector/{connectorId}": {
"get": {
"summary": "Retrieves a connector by ID.",
- "operationId": "getConnector",
+ "operationId": "getConnectorWithSpaceId",
"description": "You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
"tags": [
"connectors"
@@ -222,28 +686,7 @@
"$ref": "#/components/responses/401"
},
"404": {
- "description": "Object is not found.",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "error": {
- "type": "string",
- "example": "Not Found"
- },
- "message": {
- "type": "string",
- "example": "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
- },
- "statusCode": {
- "type": "integer",
- "example": 404
- }
- }
- }
- }
- }
+ "$ref": "#/components/responses/404"
}
},
"servers": [
@@ -254,7 +697,7 @@
},
"delete": {
"summary": "Deletes a connector.",
- "operationId": "deleteConnector",
+ "operationId": "deleteConnectorWithSpaceId",
"description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. WARNING: When you delete a connector, it cannot be recovered.\n",
"tags": [
"connectors"
@@ -278,28 +721,7 @@
"$ref": "#/components/responses/401"
},
"404": {
- "description": "Object is not found.",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "error": {
- "type": "string",
- "example": "Not Found"
- },
- "message": {
- "type": "string",
- "example": "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
- },
- "statusCode": {
- "type": "integer",
- "example": 404
- }
- }
- }
- }
- }
+ "$ref": "#/components/responses/404"
}
},
"servers": [
@@ -310,7 +732,7 @@
},
"post": {
"summary": "Creates a connector.",
- "operationId": "createConnectorId",
+ "operationId": "createConnectorIdWithSpaceId",
"description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
"tags": [
"connectors"
@@ -338,79 +760,7 @@
"content": {
"application/json": {
"schema": {
- "title": "Create connector request body properties",
- "description": "The properties vary depending on the connector type.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/create_connector_request_bedrock"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_cases_webhook"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_d3security"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_email"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_genai"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_index"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_jira"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_opsgenie"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_pagerduty"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_resilient"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_serverlog"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_servicenow"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_servicenow_itom"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_servicenow_sir"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_slack_api"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_slack_webhook"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_swimlane"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_teams"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_tines"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_torq"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_webhook"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_xmatters"
- }
- ],
- "discriminator": {
- "propertyName": "connector_type_id"
- }
+ "$ref": "#/components/schemas/create_connector_request"
},
"examples": {
"createIndexConnectorRequest": {
@@ -448,7 +798,7 @@
},
"put": {
"summary": "Updates the attributes for a connector.",
- "operationId": "updateConnector",
+ "operationId": "updateConnectorWithSpaceId",
"description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
"tags": [
"connectors"
@@ -469,73 +819,7 @@
"content": {
"application/json": {
"schema": {
- "title": "Update connector request body properties",
- "description": "The properties vary depending on the connector type.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/create_connector_request_bedrock"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_cases_webhook"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_d3security"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_email"
- },
- {
- "$ref": "#/components/schemas/create_connector_request_genai"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_index"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_jira"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_opsgenie"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_pagerduty"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_resilient"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_serverlog"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_servicenow"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_servicenow_itom"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_slack_api"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_slack_webhook"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_swimlane"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_teams"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_tines"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_torq"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_webhook"
- },
- {
- "$ref": "#/components/schemas/update_connector_request_xmatters"
- }
- ]
+ "$ref": "#/components/schemas/update_connector_request"
},
"examples": {
"updateIndexConnectorRequest": {
@@ -557,28 +841,7 @@
}
},
"400": {
- "description": "Indicates a bad request.",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "error": {
- "type": "string",
- "example": "Bad Request"
- },
- "message": {
- "type": "string",
- "example": "error validating action type config: [index]: expected value of type [string] but got [undefined]"
- },
- "statusCode": {
- "type": "integer",
- "example": 400
- }
- }
- }
- }
- }
+ "$ref": "#/components/responses/401"
},
"401": {
"$ref": "#/components/responses/401"
@@ -602,7 +865,7 @@
"/s/{spaceId}/api/actions/connectors": {
"get": {
"summary": "Retrieves all connectors.",
- "operationId": "getConnectors",
+ "operationId": "getConnectorsWithSpaceId",
"description": "You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n",
"tags": [
"connectors"
@@ -616,60 +879,11 @@
"200": {
"description": "Indicates a successful call.",
"content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "title": "Get connectors response body properties",
- "description": "The properties vary for each connector type.",
- "type": "object",
- "required": [
- "connector_type_id",
- "id",
- "is_deprecated",
- "is_preconfigured",
- "name",
- "referenced_by_count"
- ],
- "properties": {
- "connector_type_id": {
- "$ref": "#/components/schemas/connector_types"
- },
- "config": {
- "type": "object",
- "description": "The configuration for the connector. Configuration properties vary depending on the connector type.",
- "additionalProperties": true,
- "nullable": true
- },
- "id": {
- "type": "string",
- "description": "The identifier for the connector.",
- "example": "b0766e10-d190-11ec-b04c-776c77d14fca"
- },
- "is_deprecated": {
- "$ref": "#/components/schemas/is_deprecated"
- },
- "is_missing_secrets": {
- "$ref": "#/components/schemas/is_missing_secrets"
- },
- "is_preconfigured": {
- "$ref": "#/components/schemas/is_preconfigured"
- },
- "is_system_action": {
- "$ref": "#/components/schemas/is_system_action"
- },
- "name": {
- "type": "string",
- "description": "The display name for the connector.",
- "example": "my-connector"
- },
- "referenced_by_count": {
- "type": "integer",
- "description": "Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated.",
- "example": 2,
- "default": 0
- }
- }
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector_response_properties"
}
},
"examples": {
@@ -699,7 +913,7 @@
"/s/{spaceId}/api/actions/connector_types": {
"get": {
"summary": "Retrieves a list of all connector types.",
- "operationId": "getConnectorTypes",
+ "operationId": "getConnectorTypesWithSpaceId",
"description": "You do not need any Kibana feature privileges to run this API.\n",
"tags": [
"connectors"
@@ -799,7 +1013,7 @@
"/s/{spaceId}/api/actions/connector/{connectorId}/_execute": {
"post": {
"summary": "Runs a connector.",
- "operationId": "runConnector",
+ "operationId": "runConnectorWithSpaceId",
"description": "You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges.\n",
"tags": [
"connectors"
@@ -820,66 +1034,7 @@
"content": {
"application/json": {
"schema": {
- "title": "Run connector request body properties",
- "description": "The properties vary depending on the connector type.",
- "type": "object",
- "required": [
- "params"
- ],
- "properties": {
- "params": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/run_connector_params_documents"
- },
- {
- "$ref": "#/components/schemas/run_connector_params_level_message"
- },
- {
- "title": "Subaction parameters",
- "description": "Test an action that involves a subaction.",
- "oneOf": [
- {
- "$ref": "#/components/schemas/run_connector_subaction_addevent"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_closealert"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_createalert"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_fieldsbyissuetype"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_getchoices"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_getfields"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_getincident"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_issue"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_issues"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_issuetypes"
- },
- {
- "$ref": "#/components/schemas/run_connector_subaction_pushtoservice"
- }
- ],
- "discriminator": {
- "propertyName": "subAction"
- }
- }
- ]
- }
- }
+ "$ref": "#/components/schemas/run_connector_request"
},
"examples": {
"runIndexConnectorRequest": {
@@ -1400,24 +1555,24 @@
"description": "Cross-site request forgery protection",
"required": true
},
- "space_id": {
+ "connector_id": {
"in": "path",
- "name": "spaceId",
- "description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used.",
+ "name": "connectorId",
+ "description": "An identifier for the connector.",
"required": true,
"schema": {
"type": "string",
- "example": "default"
+ "example": "df770e30-8b8b-11ed-a780-3b746c987a81"
}
},
- "connector_id": {
+ "space_id": {
"in": "path",
- "name": "connectorId",
- "description": "An identifier for the connector.",
+ "name": "spaceId",
+ "description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used.",
"required": true,
"schema": {
"type": "string",
- "example": "df770e30-8b8b-11ed-a780-3b746c987a81"
+ "example": "default"
}
},
"action_id": {
@@ -3188,6 +3343,81 @@
}
}
},
+ "create_connector_request": {
+ "title": "Create connector request body properties",
+ "description": "The properties vary depending on the connector type.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/create_connector_request_bedrock"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_cases_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_d3security"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_email"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_genai"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_index"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_jira"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_opsgenie"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_pagerduty"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_resilient"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_serverlog"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_servicenow"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_servicenow_itom"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_servicenow_sir"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_slack_api"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_slack_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_swimlane"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_teams"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_tines"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_torq"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_xmatters"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "connector_type_id"
+ }
+ },
"is_deprecated": {
"type": "boolean",
"description": "Indicates whether the connector type is deprecated.",
@@ -3200,7 +3430,7 @@
},
"is_preconfigured": {
"type": "boolean",
- "description": "Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.",
+ "description": "Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. \n",
"example": false
},
"is_system_action": {
@@ -3208,11 +3438,59 @@
"description": "Indicates whether the connector is used for system actions.",
"example": false
},
+ "connector_response_properties_bedrock": {
+ "title": "Connector response properties for an Amazon Bedrock connector",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_bedrock"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".bedrock"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ }
+ }
+ },
+ "referenced_by_count": {
+ "type": "integer",
+ "description": "Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated. This property is returned only by the get all connectors API.\n",
+ "example": 2
+ },
"connector_response_properties_cases_webhook": {
"title": "Connector request properties for a Webhook - Case Management connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3249,6 +3527,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3256,7 +3537,6 @@
"title": "Connector response properties for a D3 Security connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3293,6 +3573,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3300,7 +3583,6 @@
"title": "Connector response properties for an email connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3337,6 +3619,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3344,7 +3629,6 @@
"title": "Connector response properties for an index connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3381,6 +3665,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3388,7 +3675,6 @@
"title": "Connector response properties for a Jira connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3425,6 +3711,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3432,7 +3721,6 @@
"title": "Connector response properties for an Opsgenie connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3469,6 +3757,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3476,7 +3767,6 @@
"title": "Connector response properties for a PagerDuty connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3513,6 +3803,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3520,7 +3813,6 @@
"title": "Connector response properties for a IBM Resilient connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3557,6 +3849,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3564,7 +3859,6 @@
"title": "Connector response properties for a server log connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3602,6 +3896,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3609,7 +3906,6 @@
"title": "Connector response properties for a ServiceNow ITSM connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3646,6 +3942,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3653,7 +3952,6 @@
"title": "Connector response properties for a ServiceNow ITOM connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3690,6 +3988,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3697,7 +3998,6 @@
"title": "Connector response properties for a ServiceNow SecOps connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3734,6 +4034,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3774,6 +4077,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3814,6 +4120,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3821,7 +4130,6 @@
"title": "Connector response properties for a Swimlane connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3858,6 +4166,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3901,6 +4212,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3908,7 +4222,6 @@
"title": "Connector response properties for a Tines connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3945,6 +4258,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3952,7 +4268,6 @@
"title": "Connector response properties for a Torq connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -3989,6 +4304,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -3996,7 +4314,6 @@
"title": "Connector response properties for a Webhook connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -4033,6 +4350,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -4040,7 +4360,6 @@
"title": "Connector response properties for an xMatters connector",
"type": "object",
"required": [
- "config",
"connector_type_id",
"id",
"is_deprecated",
@@ -4077,6 +4396,9 @@
"name": {
"type": "string",
"description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
}
}
},
@@ -4084,6 +4406,9 @@
"title": "Connector response properties",
"description": "The properties vary depending on the connector type.",
"oneOf": [
+ {
+ "$ref": "#/components/schemas/connector_response_properties_bedrock"
+ },
{
"$ref": "#/components/schemas/connector_response_properties_cases_webhook"
},
@@ -4149,6 +4474,26 @@
"propertyName": "connector_type_id"
}
},
+ "update_connector_request_bedrock": {
+ "title": "Update Amazon Bedrock connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_bedrock"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_bedrock"
+ }
+ }
+ },
"update_connector_request_cases_webhook": {
"title": "Update Webhook - Case Managment connector request",
"type": "object",
@@ -4524,44 +4869,73 @@
}
}
},
- "connector_types": {
- "title": "Connector types",
- "type": "string",
- "description": "The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.",
- "enum": [
- ".bedrock",
- ".cases-webhook",
- ".d3security",
- ".email",
- ".gen-ai",
- ".index",
- ".jira",
- ".opsgenie",
- ".pagerduty",
- ".resilient",
- ".servicenow",
- ".servicenow-itom",
- ".servicenow-sir",
- ".server-log",
- ".slack",
- ".slack_api",
- ".swimlane",
- ".teams",
- ".tines",
- ".torq",
- ".webhook",
- ".xmatters"
- ],
- "example": ".server-log"
- },
- "features": {
- "type": "string",
- "description": "The feature that uses the connector. Valid values are `alerting`, `cases`, `uptime`, and `siem`.\n",
- "enum": [
- "alerting",
- "cases",
- "uptime",
- "siem"
+ "update_connector_request": {
+ "title": "Update connector request body properties",
+ "description": "The properties vary depending on the connector type.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/update_connector_request_bedrock"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_cases_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_d3security"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_email"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_genai"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_index"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_jira"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_opsgenie"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_pagerduty"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_resilient"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_serverlog"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_servicenow"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_servicenow_itom"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_slack_api"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_slack_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_swimlane"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_teams"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_tines"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_torq"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_xmatters"
+ }
]
},
"run_connector_params_documents": {
@@ -5246,6 +5620,109 @@
}
}
},
+ "run_connector_request": {
+ "title": "Run connector request body properties",
+ "description": "The properties vary depending on the connector type.",
+ "type": "object",
+ "required": [
+ "params"
+ ],
+ "properties": {
+ "params": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/run_connector_params_documents"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_params_level_message"
+ },
+ {
+ "title": "Subaction parameters",
+ "description": "Test an action that involves a subaction.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_addevent"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_closealert"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_createalert"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_fieldsbyissuetype"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_getchoices"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_getfields"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_getincident"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_issue"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_issues"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_issuetypes"
+ },
+ {
+ "$ref": "#/components/schemas/run_connector_subaction_pushtoservice"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "subAction"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "features": {
+ "type": "string",
+ "description": "The feature that uses the connector.\n",
+ "enum": [
+ "alerting",
+ "cases",
+ "generativeAI",
+ "siem",
+ "uptime"
+ ]
+ },
+ "connector_types": {
+ "title": "Connector types",
+ "type": "string",
+ "description": "The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.",
+ "enum": [
+ ".bedrock",
+ ".cases-webhook",
+ ".d3security",
+ ".email",
+ ".gen-ai",
+ ".index",
+ ".jira",
+ ".opsgenie",
+ ".pagerduty",
+ ".resilient",
+ ".servicenow",
+ ".servicenow-itom",
+ ".servicenow-sir",
+ ".server-log",
+ ".slack",
+ ".slack_api",
+ ".swimlane",
+ ".teams",
+ ".tines",
+ ".torq",
+ ".webhook",
+ ".xmatters"
+ ],
+ "example": ".server-log"
+ },
"action_response_properties": {
"title": "Action response properties",
"description": "The properties vary depending on the action type.",
@@ -5417,7 +5894,7 @@
}
},
"get_connector_response": {
- "summary": "A list of connector types",
+ "summary": "Get connector details.",
"value": {
"id": "df770e30-8b8b-11ed-a780-3b746c987a81",
"name": "my_server_log_connector",
@@ -5438,78 +5915,6 @@
}
}
},
- "get_connectors_response": {
- "summary": "A list of connectors",
- "value": [
- {
- "id": "preconfigured-email-connector",
- "name": "my-preconfigured-email-notification",
- "connector_type_id": ".email",
- "is_preconfigured": true,
- "is_deprecated": false,
- "referenced_by_count": 0,
- "is_system_action": false
- },
- {
- "id": "e07d0c80-8b8b-11ed-a780-3b746c987a81",
- "name": "my-index-connector",
- "config": {
- "index": "test-index",
- "refresh": false,
- "executionTimeField": null
- },
- "connector_type_id": ".index",
- "is_preconfigured": false,
- "is_deprecated": false,
- "referenced_by_count": 2,
- "is_missing_secrets": false,
- "is_system_action": false
- }
- ]
- },
- "get_connector_types_response": {
- "summary": "A list of connector types",
- "value": [
- {
- "id": ".swimlane",
- "name": "Swimlane",
- "enabled": true,
- "enabled_in_config": true,
- "enabled_in_license": true,
- "minimum_license_required": "gold",
- "supported_feature_ids": [
- "alerting",
- "cases",
- "siem"
- ]
- },
- {
- "id": ".index",
- "name": "Index",
- "enabled": true,
- "enabled_in_config": true,
- "enabled_in_license": true,
- "minimum_license_required": "basic",
- "supported_feature_ids": [
- "alerting",
- "uptime",
- "siem"
- ]
- },
- {
- "id": ".server-log",
- "name": "Server log",
- "enabled": true,
- "enabled_in_config": true,
- "enabled_in_license": true,
- "minimum_license_required": "basic",
- "supported_feature_ids": [
- "alerting",
- "uptime"
- ]
- }
- ]
- },
"run_index_connector_request": {
"summary": "Run an index connector.",
"value": {
@@ -5726,6 +6131,107 @@
},
"status": "ok"
}
+ },
+ "get_connectors_response": {
+ "summary": "A list of connectors",
+ "value": [
+ {
+ "id": "preconfigured-email-connector",
+ "name": "my-preconfigured-email-notification",
+ "connector_type_id": ".email",
+ "is_preconfigured": true,
+ "is_deprecated": false,
+ "referenced_by_count": 0,
+ "is_system_action": false
+ },
+ {
+ "id": "e07d0c80-8b8b-11ed-a780-3b746c987a81",
+ "name": "my-index-connector",
+ "config": {
+ "index": "test-index",
+ "refresh": false,
+ "executionTimeField": null
+ },
+ "connector_type_id": ".index",
+ "is_preconfigured": false,
+ "is_deprecated": false,
+ "referenced_by_count": 2,
+ "is_missing_secrets": false,
+ "is_system_action": false
+ }
+ ]
+ },
+ "get_connector_types_generativeai_response": {
+ "summary": "A list of connector types for the `generativeAI` feature.",
+ "value": [
+ {
+ "id": ".gen-ai",
+ "name": "OpenAI",
+ "enabled": true,
+ "enabled_in_config": true,
+ "enabled_in_license": true,
+ "minimum_license_required": "enterprise",
+ "supported_feature_ids": [
+ "generativeAI"
+ ],
+ "is_system_action_type": false
+ },
+ {
+ "id": ".bedrock",
+ "name": "AWS Bedrock",
+ "enabled": true,
+ "enabled_in_config": true,
+ "enabled_in_license": true,
+ "minimum_license_required": "enterprise",
+ "supported_feature_ids": [
+ "generativeAI"
+ ],
+ "is_system_action_type": false
+ }
+ ]
+ },
+ "get_connector_types_response": {
+ "summary": "A list of connector types",
+ "value": [
+ {
+ "id": ".swimlane",
+ "name": "Swimlane",
+ "enabled": true,
+ "enabled_in_config": true,
+ "enabled_in_license": true,
+ "minimum_license_required": "gold",
+ "supported_feature_ids": [
+ "alerting",
+ "cases",
+ "siem"
+ ]
+ },
+ {
+ "id": ".index",
+ "name": "Index",
+ "enabled": true,
+ "enabled_in_config": true,
+ "enabled_in_license": true,
+ "minimum_license_required": "basic",
+ "supported_feature_ids": [
+ "alerting",
+ "uptime",
+ "siem"
+ ]
+ },
+ {
+ "id": ".server-log",
+ "name": "Server log",
+ "enabled": true,
+ "enabled_in_config": true,
+ "enabled_in_license": true,
+ "minimum_license_required": "basic",
+ "supported_feature_ids": [
+ "alerting",
+ "uptime"
+ ]
+ }
+ ]
}
},
"responses": {
diff --git a/x-pack/plugins/actions/docs/openapi/bundled.yaml b/x-pack/plugins/actions/docs/openapi/bundled.yaml
index 9fb7caccd1f170..099757a354f9ec 100644
--- a/x-pack/plugins/actions/docs/openapi/bundled.yaml
+++ b/x-pack/plugins/actions/docs/openapi/bundled.yaml
@@ -18,49 +18,20 @@ tags:
- name: connectors
description: Connector APIs enable you to create and manage connectors.
paths:
- /s/{spaceId}/api/actions/connector:
+ /api/actions/connector:
post:
summary: Creates a connector.
operationId: createConnector
- description: |
- You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
- connectors
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- - $ref: '#/components/parameters/space_id'
requestBody:
required: true
content:
application/json:
schema:
- title: Create connector request body properties
- description: The properties vary depending on the connector type.
- oneOf:
- - $ref: '#/components/schemas/create_connector_request_bedrock'
- - $ref: '#/components/schemas/create_connector_request_cases_webhook'
- - $ref: '#/components/schemas/create_connector_request_d3security'
- - $ref: '#/components/schemas/create_connector_request_email'
- - $ref: '#/components/schemas/create_connector_request_genai'
- - $ref: '#/components/schemas/create_connector_request_index'
- - $ref: '#/components/schemas/create_connector_request_jira'
- - $ref: '#/components/schemas/create_connector_request_opsgenie'
- - $ref: '#/components/schemas/create_connector_request_pagerduty'
- - $ref: '#/components/schemas/create_connector_request_resilient'
- - $ref: '#/components/schemas/create_connector_request_serverlog'
- - $ref: '#/components/schemas/create_connector_request_servicenow'
- - $ref: '#/components/schemas/create_connector_request_servicenow_itom'
- - $ref: '#/components/schemas/create_connector_request_servicenow_sir'
- - $ref: '#/components/schemas/create_connector_request_slack_api'
- - $ref: '#/components/schemas/create_connector_request_slack_webhook'
- - $ref: '#/components/schemas/create_connector_request_swimlane'
- - $ref: '#/components/schemas/create_connector_request_teams'
- - $ref: '#/components/schemas/create_connector_request_tines'
- - $ref: '#/components/schemas/create_connector_request_torq'
- - $ref: '#/components/schemas/create_connector_request_webhook'
- - $ref: '#/components/schemas/create_connector_request_xmatters'
- discriminator:
- propertyName: connector_type_id
+ $ref: '#/components/schemas/create_connector_request'
examples:
createEmailConnectorRequest:
$ref: '#/components/examples/create_email_connector_request'
@@ -92,17 +63,14 @@ paths:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
- /s/{spaceId}/api/actions/connector/{connectorId}:
+ /api/actions/connector/{connectorId}:
get:
summary: Retrieves a connector by ID.
operationId: getConnector
- description: |
- You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
- connectors
parameters:
- $ref: '#/components/parameters/connector_id'
- - $ref: '#/components/parameters/space_id'
responses:
'200':
description: Indicates a successful call.
@@ -116,26 +84,341 @@ paths:
'401':
$ref: '#/components/responses/401'
'404':
- description: Object is not found.
+ $ref: '#/components/responses/404'
+ servers:
+ - url: https://localhost:5601
+ delete:
+ summary: Deletes a connector.
+ operationId: deleteConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ - $ref: '#/components/parameters/connector_id'
+ responses:
+ '204':
+ description: Indicates a successful call.
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ servers:
+ - url: https://localhost:5601
+ post:
+ summary: Creates a connector.
+ operationId: createConnectorId
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ - in: path
+ name: connectorId
+ description: |
+ A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated.
+ required: true
+ schema:
+ type: string
+ example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/create_connector_request'
+ examples:
+ createIndexConnectorRequest:
+ $ref: '#/components/examples/create_index_connector_request'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connector_response_properties'
+ examples:
+ createIndexConnectorResponse:
+ $ref: '#/components/examples/create_index_connector_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ put:
+ summary: Updates the attributes for a connector.
+ operationId: updateConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ - $ref: '#/components/parameters/connector_id'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/update_connector_request'
+ examples:
+ updateIndexConnectorRequest:
+ $ref: '#/components/examples/update_index_connector_request'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connector_response_properties'
+ '400':
+ $ref: '#/components/responses/401'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+ /api/actions/connector/{connectorId}/_execute:
+ post:
+ summary: Runs a connector.
+ operationId: runConnector
+ description: |
+ You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges.
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ - $ref: '#/components/parameters/connector_id'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/run_connector_request'
+ examples:
+ runIndexConnectorRequest:
+ $ref: '#/components/examples/run_index_connector_request'
+ runJiraConnectorRequest:
+ $ref: '#/components/examples/run_jira_connector_request'
+ runServerLogConnectorRequest:
+ $ref: '#/components/examples/run_server_log_connector_request'
+ runServiceNowITOMConnectorRequest:
+ $ref: '#/components/examples/run_servicenow_itom_connector_request'
+ runSwimlaneConnectorRequest:
+ $ref: '#/components/examples/run_swimlane_connector_request'
+ responses:
+ '200':
+ description: Indicates a successful call.
content:
application/json:
schema:
type: object
+ required:
+ - connector_id
+ - status
properties:
- error:
+ connector_id:
type: string
- example: Not Found
- message:
+ description: The identifier for the connector.
+ data:
+ oneOf:
+ - type: object
+ description: Information returned from the action.
+ additionalProperties: true
+ - type: array
+ description: An array of information returned from the action.
+ items:
+ type: object
+ status:
type: string
- example: Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found
- statusCode:
- type: integer
- example: 404
+ description: The status of the action.
+ enum:
+ - error
+ - ok
+ examples:
+ runIndexConnectorResponse:
+ $ref: '#/components/examples/run_index_connector_response'
+ runJiraConnectorResponse:
+ $ref: '#/components/examples/run_jira_connector_response'
+ runServerLogConnectorResponse:
+ $ref: '#/components/examples/run_server_log_connector_response'
+ runServiceNowITOMConnectorResponse:
+ $ref: '#/components/examples/run_servicenow_itom_connector_response'
+ runSwimlaneConnectorResponse:
+ $ref: '#/components/examples/run_swimlane_connector_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+ /api/actions/connectors:
+ get:
+ summary: Retrieves all connectors.
+ operationId: getConnectors
+ tags:
+ - connectors
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/connector_response_properties'
+ examples:
+ getConnectorsResponse:
+ $ref: '#/components/examples/get_connectors_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+ /api/actions/connector_types:
+ get:
+ summary: Retrieves a list of all connector types.
+ operationId: getConnectorTypes
+ tags:
+ - connectors
+ parameters:
+ - in: query
+ name: feature_id
+ description: A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).
+ schema:
+ $ref: '#/components/schemas/features'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ title: Get connector types response body properties
+ description: The properties vary for each connector type.
+ type: array
+ items:
+ type: object
+ properties:
+ enabled:
+ type: boolean
+ description: Indicates whether the connector type is enabled in Kibana.
+ example: true
+ enabled_in_config:
+ type: boolean
+ description: Indicates whether the connector type is enabled in the Kibana configuration file.
+ example: true
+ enabled_in_license:
+ type: boolean
+ description: Indicates whether the connector is enabled in the license.
+ example: true
+ id:
+ $ref: '#/components/schemas/connector_types'
+ is_system_action_type:
+ type: boolean
+ example: false
+ minimum_license_required:
+ type: string
+ description: The license that is required to use the connector type.
+ example: basic
+ name:
+ type: string
+ description: The name of the connector type.
+ example: Index
+ supported_feature_ids:
+ type: array
+ description: The features that are supported by the connector type.
+ items:
+ $ref: '#/components/schemas/features'
+ example:
+ - alerting
+ - cases
+ - siem
+ examples:
+ getConnectorTypesServerlessResponse:
+ $ref: '#/components/examples/get_connector_types_generativeai_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+ /s/{spaceId}/api/actions/connector:
+ post:
+ summary: Creates a connector.
+ operationId: createConnectorWithSpaceId
+ description: |
+ You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ - $ref: '#/components/parameters/space_id'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/create_connector_request'
+ examples:
+ createEmailConnectorRequest:
+ $ref: '#/components/examples/create_email_connector_request'
+ createIndexConnectorRequest:
+ $ref: '#/components/examples/create_index_connector_request'
+ createWebhookConnectorRequest:
+ $ref: '#/components/examples/create_webhook_connector_request'
+ createXmattersConnectorRequest:
+ $ref: '#/components/examples/create_xmatters_connector_request'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connector_response_properties'
+ examples:
+ createEmailConnectorResponse:
+ $ref: '#/components/examples/create_email_connector_response'
+ createIndexConnectorResponse:
+ $ref: '#/components/examples/create_index_connector_response'
+ createWebhookConnectorResponse:
+ $ref: '#/components/examples/create_webhook_connector_response'
+ createXmattersConnectorResponse:
+ $ref: '#/components/examples/create_xmatters_connector_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+ /s/{spaceId}/api/actions/connector/{connectorId}:
+ get:
+ summary: Retrieves a connector by ID.
+ operationId: getConnectorWithSpaceId
+ description: |
+ You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/connector_id'
+ - $ref: '#/components/parameters/space_id'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connector_response_properties'
+ examples:
+ getConnectorResponse:
+ $ref: '#/components/examples/get_connector_response'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
servers:
- url: https://localhost:5601
delete:
summary: Deletes a connector.
- operationId: deleteConnector
+ operationId: deleteConnectorWithSpaceId
description: |
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. WARNING: When you delete a connector, it cannot be recovered.
tags:
@@ -150,26 +433,12 @@ paths:
'401':
$ref: '#/components/responses/401'
'404':
- description: Object is not found.
- content:
- application/json:
- schema:
- type: object
- properties:
- error:
- type: string
- example: Not Found
- message:
- type: string
- example: Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found
- statusCode:
- type: integer
- example: 404
+ $ref: '#/components/responses/404'
servers:
- url: https://localhost:5601
post:
summary: Creates a connector.
- operationId: createConnectorId
+ operationId: createConnectorIdWithSpaceId
description: |
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
@@ -189,33 +458,7 @@ paths:
content:
application/json:
schema:
- title: Create connector request body properties
- description: The properties vary depending on the connector type.
- oneOf:
- - $ref: '#/components/schemas/create_connector_request_bedrock'
- - $ref: '#/components/schemas/create_connector_request_cases_webhook'
- - $ref: '#/components/schemas/create_connector_request_d3security'
- - $ref: '#/components/schemas/create_connector_request_email'
- - $ref: '#/components/schemas/create_connector_request_genai'
- - $ref: '#/components/schemas/create_connector_request_index'
- - $ref: '#/components/schemas/create_connector_request_jira'
- - $ref: '#/components/schemas/create_connector_request_opsgenie'
- - $ref: '#/components/schemas/create_connector_request_pagerduty'
- - $ref: '#/components/schemas/create_connector_request_resilient'
- - $ref: '#/components/schemas/create_connector_request_serverlog'
- - $ref: '#/components/schemas/create_connector_request_servicenow'
- - $ref: '#/components/schemas/create_connector_request_servicenow_itom'
- - $ref: '#/components/schemas/create_connector_request_servicenow_sir'
- - $ref: '#/components/schemas/create_connector_request_slack_api'
- - $ref: '#/components/schemas/create_connector_request_slack_webhook'
- - $ref: '#/components/schemas/create_connector_request_swimlane'
- - $ref: '#/components/schemas/create_connector_request_teams'
- - $ref: '#/components/schemas/create_connector_request_tines'
- - $ref: '#/components/schemas/create_connector_request_torq'
- - $ref: '#/components/schemas/create_connector_request_webhook'
- - $ref: '#/components/schemas/create_connector_request_xmatters'
- discriminator:
- propertyName: connector_type_id
+ $ref: '#/components/schemas/create_connector_request'
examples:
createIndexConnectorRequest:
$ref: '#/components/examples/create_index_connector_request'
@@ -235,7 +478,7 @@ paths:
- url: https://localhost:5601
put:
summary: Updates the attributes for a connector.
- operationId: updateConnector
+ operationId: updateConnectorWithSpaceId
description: |
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
@@ -249,30 +492,7 @@ paths:
content:
application/json:
schema:
- title: Update connector request body properties
- description: The properties vary depending on the connector type.
- oneOf:
- - $ref: '#/components/schemas/create_connector_request_bedrock'
- - $ref: '#/components/schemas/update_connector_request_cases_webhook'
- - $ref: '#/components/schemas/update_connector_request_d3security'
- - $ref: '#/components/schemas/update_connector_request_email'
- - $ref: '#/components/schemas/create_connector_request_genai'
- - $ref: '#/components/schemas/update_connector_request_index'
- - $ref: '#/components/schemas/update_connector_request_jira'
- - $ref: '#/components/schemas/update_connector_request_opsgenie'
- - $ref: '#/components/schemas/update_connector_request_pagerduty'
- - $ref: '#/components/schemas/update_connector_request_resilient'
- - $ref: '#/components/schemas/update_connector_request_serverlog'
- - $ref: '#/components/schemas/update_connector_request_servicenow'
- - $ref: '#/components/schemas/update_connector_request_servicenow_itom'
- - $ref: '#/components/schemas/update_connector_request_slack_api'
- - $ref: '#/components/schemas/update_connector_request_slack_webhook'
- - $ref: '#/components/schemas/update_connector_request_swimlane'
- - $ref: '#/components/schemas/update_connector_request_teams'
- - $ref: '#/components/schemas/update_connector_request_tines'
- - $ref: '#/components/schemas/update_connector_request_torq'
- - $ref: '#/components/schemas/update_connector_request_webhook'
- - $ref: '#/components/schemas/update_connector_request_xmatters'
+ $ref: '#/components/schemas/update_connector_request'
examples:
updateIndexConnectorRequest:
$ref: '#/components/examples/update_index_connector_request'
@@ -284,21 +504,7 @@ paths:
schema:
$ref: '#/components/schemas/connector_response_properties'
'400':
- description: Indicates a bad request.
- content:
- application/json:
- schema:
- type: object
- properties:
- error:
- type: string
- example: Bad Request
- message:
- type: string
- example: 'error validating action type config: [index]: expected value of type [string] but got [undefined]'
- statusCode:
- type: integer
- example: 400
+ $ref: '#/components/responses/401'
'401':
$ref: '#/components/responses/401'
'404':
@@ -310,7 +516,7 @@ paths:
/s/{spaceId}/api/actions/connectors:
get:
summary: Retrieves all connectors.
- operationId: getConnectors
+ operationId: getConnectorsWithSpaceId
description: |
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
@@ -325,45 +531,7 @@ paths:
schema:
type: array
items:
- title: Get connectors response body properties
- description: The properties vary for each connector type.
- type: object
- required:
- - connector_type_id
- - id
- - is_deprecated
- - is_preconfigured
- - name
- - referenced_by_count
- properties:
- connector_type_id:
- $ref: '#/components/schemas/connector_types'
- config:
- type: object
- description: The configuration for the connector. Configuration properties vary depending on the connector type.
- additionalProperties: true
- nullable: true
- id:
- type: string
- description: The identifier for the connector.
- example: b0766e10-d190-11ec-b04c-776c77d14fca
- is_deprecated:
- $ref: '#/components/schemas/is_deprecated'
- is_missing_secrets:
- $ref: '#/components/schemas/is_missing_secrets'
- is_preconfigured:
- $ref: '#/components/schemas/is_preconfigured'
- is_system_action:
- $ref: '#/components/schemas/is_system_action'
- name:
- type: string
- description: The display name for the connector.
- example: my-connector
- referenced_by_count:
- type: integer
- description: Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated.
- example: 2
- default: 0
+ $ref: '#/components/schemas/connector_response_properties'
examples:
getConnectorsResponse:
$ref: '#/components/examples/get_connectors_response'
@@ -376,7 +544,7 @@ paths:
/s/{spaceId}/api/actions/connector_types:
get:
summary: Retrieves a list of all connector types.
- operationId: getConnectorTypes
+ operationId: getConnectorTypesWithSpaceId
description: |
You do not need any Kibana feature privileges to run this API.
tags:
@@ -443,7 +611,7 @@ paths:
/s/{spaceId}/api/actions/connector/{connectorId}/_execute:
post:
summary: Runs a connector.
- operationId: runConnector
+ operationId: runConnectorWithSpaceId
description: |
You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges.
tags:
@@ -457,32 +625,7 @@ paths:
content:
application/json:
schema:
- title: Run connector request body properties
- description: The properties vary depending on the connector type.
- type: object
- required:
- - params
- properties:
- params:
- oneOf:
- - $ref: '#/components/schemas/run_connector_params_documents'
- - $ref: '#/components/schemas/run_connector_params_level_message'
- - title: Subaction parameters
- description: Test an action that involves a subaction.
- oneOf:
- - $ref: '#/components/schemas/run_connector_subaction_addevent'
- - $ref: '#/components/schemas/run_connector_subaction_closealert'
- - $ref: '#/components/schemas/run_connector_subaction_createalert'
- - $ref: '#/components/schemas/run_connector_subaction_fieldsbyissuetype'
- - $ref: '#/components/schemas/run_connector_subaction_getchoices'
- - $ref: '#/components/schemas/run_connector_subaction_getfields'
- - $ref: '#/components/schemas/run_connector_subaction_getincident'
- - $ref: '#/components/schemas/run_connector_subaction_issue'
- - $ref: '#/components/schemas/run_connector_subaction_issues'
- - $ref: '#/components/schemas/run_connector_subaction_issuetypes'
- - $ref: '#/components/schemas/run_connector_subaction_pushtoservice'
- discriminator:
- propertyName: subAction
+ $ref: '#/components/schemas/run_connector_request'
examples:
runIndexConnectorRequest:
$ref: '#/components/examples/run_index_connector_request'
@@ -796,14 +939,6 @@ components:
name: kbn-xsrf
description: Cross-site request forgery protection
required: true
- space_id:
- in: path
- name: spaceId
- description: An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used.
- required: true
- schema:
- type: string
- example: default
connector_id:
in: path
name: connectorId
@@ -812,6 +947,14 @@ components:
schema:
type: string
example: df770e30-8b8b-11ed-a780-3b746c987a81
+ space_id:
+ in: path
+ name: spaceId
+ description: An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used.
+ required: true
+ schema:
+ type: string
+ example: default
action_id:
in: path
name: actionId
@@ -2189,30 +2332,95 @@ components:
name:
type: string
description: The display name for the connector.
- example: my-connector
- secrets:
- $ref: '#/components/schemas/secrets_properties_xmatters'
- is_deprecated:
- type: boolean
- description: Indicates whether the connector type is deprecated.
- example: false
- is_missing_secrets:
- type: boolean
- description: Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
- example: false
- is_preconfigured:
- type: boolean
- description: Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.
- example: false
- is_system_action:
- type: boolean
- description: Indicates whether the connector is used for system actions.
- example: false
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_xmatters'
+ create_connector_request:
+ title: Create connector request body properties
+ description: The properties vary depending on the connector type.
+ oneOf:
+ - $ref: '#/components/schemas/create_connector_request_bedrock'
+ - $ref: '#/components/schemas/create_connector_request_cases_webhook'
+ - $ref: '#/components/schemas/create_connector_request_d3security'
+ - $ref: '#/components/schemas/create_connector_request_email'
+ - $ref: '#/components/schemas/create_connector_request_genai'
+ - $ref: '#/components/schemas/create_connector_request_index'
+ - $ref: '#/components/schemas/create_connector_request_jira'
+ - $ref: '#/components/schemas/create_connector_request_opsgenie'
+ - $ref: '#/components/schemas/create_connector_request_pagerduty'
+ - $ref: '#/components/schemas/create_connector_request_resilient'
+ - $ref: '#/components/schemas/create_connector_request_serverlog'
+ - $ref: '#/components/schemas/create_connector_request_servicenow'
+ - $ref: '#/components/schemas/create_connector_request_servicenow_itom'
+ - $ref: '#/components/schemas/create_connector_request_servicenow_sir'
+ - $ref: '#/components/schemas/create_connector_request_slack_api'
+ - $ref: '#/components/schemas/create_connector_request_slack_webhook'
+ - $ref: '#/components/schemas/create_connector_request_swimlane'
+ - $ref: '#/components/schemas/create_connector_request_teams'
+ - $ref: '#/components/schemas/create_connector_request_tines'
+ - $ref: '#/components/schemas/create_connector_request_torq'
+ - $ref: '#/components/schemas/create_connector_request_webhook'
+ - $ref: '#/components/schemas/create_connector_request_xmatters'
+ discriminator:
+ propertyName: connector_type_id
+ is_deprecated:
+ type: boolean
+ description: Indicates whether the connector type is deprecated.
+ example: false
+ is_missing_secrets:
+ type: boolean
+ description: Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
+ example: false
+ is_preconfigured:
+ type: boolean
+ description: |
+ Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.
+ example: false
+ is_system_action:
+ type: boolean
+ description: Indicates whether the connector is used for system actions.
+ example: false
+ connector_response_properties_bedrock:
+ title: Connector response properties for an Amazon Bedrock connector
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_bedrock'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .bedrock
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ type: integer
+ description: |
+ Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated. This property is returned only by the get all connectors API.
+ example: 2
connector_response_properties_cases_webhook:
title: Connector request properties for a Webhook - Case Management connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2240,11 +2448,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_d3security:
title: Connector response properties for a D3 Security connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2272,11 +2481,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_email:
title: Connector response properties for an email connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2304,11 +2514,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_index:
title: Connector response properties for an index connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2336,11 +2547,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_jira:
title: Connector response properties for a Jira connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2368,11 +2580,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_opsgenie:
title: Connector response properties for an Opsgenie connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2400,11 +2613,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_pagerduty:
title: Connector response properties for a PagerDuty connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2432,11 +2646,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_resilient:
title: Connector response properties for a IBM Resilient connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2464,11 +2679,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_serverlog:
title: Connector response properties for a server log connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2497,11 +2713,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_servicenow:
title: Connector response properties for a ServiceNow ITSM connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2529,11 +2746,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_servicenow_itom:
title: Connector response properties for a ServiceNow ITOM connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2561,11 +2779,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_servicenow_sir:
title: Connector response properties for a ServiceNow SecOps connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2593,6 +2812,8 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_slack_api:
title: Connector response properties for a Slack connector
type: object
@@ -2622,6 +2843,8 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_slack_webhook:
title: Connector response properties for a Slack connector
type: object
@@ -2651,11 +2874,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_swimlane:
title: Connector response properties for a Swimlane connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2683,6 +2907,8 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_teams:
title: Connector response properties for a Microsoft Teams connector
type: object
@@ -2714,11 +2940,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_tines:
title: Connector response properties for a Tines connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2746,11 +2973,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_torq:
title: Connector response properties for a Torq connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2778,11 +3006,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_webhook:
title: Connector response properties for a Webhook connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2810,11 +3039,12 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties_xmatters:
title: Connector response properties for an xMatters connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -2842,10 +3072,13 @@ components:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
connector_response_properties:
title: Connector response properties
description: The properties vary depending on the connector type.
oneOf:
+ - $ref: '#/components/schemas/connector_response_properties_bedrock'
- $ref: '#/components/schemas/connector_response_properties_cases_webhook'
- $ref: '#/components/schemas/connector_response_properties_d3security'
- $ref: '#/components/schemas/connector_response_properties_email'
@@ -2868,6 +3101,20 @@ components:
- $ref: '#/components/schemas/connector_response_properties_xmatters'
discriminator:
propertyName: connector_type_id
+ update_connector_request_bedrock:
+ title: Update Amazon Bedrock connector request
+ type: object
+ required:
+ - config
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_bedrock'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_bedrock'
update_connector_request_cases_webhook:
title: Update Webhook - Case Managment connector request
type: object
@@ -3135,43 +3382,31 @@ components:
description: The display name for the connector.
secrets:
$ref: '#/components/schemas/secrets_properties_xmatters'
- connector_types:
- title: Connector types
- type: string
- description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.
- enum:
- - .bedrock
- - .cases-webhook
- - .d3security
- - .email
- - .gen-ai
- - .index
- - .jira
- - .opsgenie
- - .pagerduty
- - .resilient
- - .servicenow
- - .servicenow-itom
- - .servicenow-sir
- - .server-log
- - .slack
- - .slack_api
- - .swimlane
- - .teams
- - .tines
- - .torq
- - .webhook
- - .xmatters
- example: .server-log
- features:
- type: string
- description: |
- The feature that uses the connector. Valid values are `alerting`, `cases`, `uptime`, and `siem`.
- enum:
- - alerting
- - cases
- - uptime
- - siem
+ update_connector_request:
+ title: Update connector request body properties
+ description: The properties vary depending on the connector type.
+ oneOf:
+ - $ref: '#/components/schemas/update_connector_request_bedrock'
+ - $ref: '#/components/schemas/update_connector_request_cases_webhook'
+ - $ref: '#/components/schemas/update_connector_request_d3security'
+ - $ref: '#/components/schemas/update_connector_request_email'
+ - $ref: '#/components/schemas/create_connector_request_genai'
+ - $ref: '#/components/schemas/update_connector_request_index'
+ - $ref: '#/components/schemas/update_connector_request_jira'
+ - $ref: '#/components/schemas/update_connector_request_opsgenie'
+ - $ref: '#/components/schemas/update_connector_request_pagerduty'
+ - $ref: '#/components/schemas/update_connector_request_resilient'
+ - $ref: '#/components/schemas/update_connector_request_serverlog'
+ - $ref: '#/components/schemas/update_connector_request_servicenow'
+ - $ref: '#/components/schemas/update_connector_request_servicenow_itom'
+ - $ref: '#/components/schemas/update_connector_request_slack_api'
+ - $ref: '#/components/schemas/update_connector_request_slack_webhook'
+ - $ref: '#/components/schemas/update_connector_request_swimlane'
+ - $ref: '#/components/schemas/update_connector_request_teams'
+ - $ref: '#/components/schemas/update_connector_request_tines'
+ - $ref: '#/components/schemas/update_connector_request_torq'
+ - $ref: '#/components/schemas/update_connector_request_webhook'
+ - $ref: '#/components/schemas/update_connector_request_xmatters'
run_connector_params_documents:
title: Index connector parameters
description: Test an action that indexes a document into Elasticsearch.
@@ -3661,6 +3896,71 @@ components:
urgency:
type: string
description: The urgency of the incident for ServiceNow ITSM connectors.
+ run_connector_request:
+ title: Run connector request body properties
+ description: The properties vary depending on the connector type.
+ type: object
+ required:
+ - params
+ properties:
+ params:
+ oneOf:
+ - $ref: '#/components/schemas/run_connector_params_documents'
+ - $ref: '#/components/schemas/run_connector_params_level_message'
+ - title: Subaction parameters
+ description: Test an action that involves a subaction.
+ oneOf:
+ - $ref: '#/components/schemas/run_connector_subaction_addevent'
+ - $ref: '#/components/schemas/run_connector_subaction_closealert'
+ - $ref: '#/components/schemas/run_connector_subaction_createalert'
+ - $ref: '#/components/schemas/run_connector_subaction_fieldsbyissuetype'
+ - $ref: '#/components/schemas/run_connector_subaction_getchoices'
+ - $ref: '#/components/schemas/run_connector_subaction_getfields'
+ - $ref: '#/components/schemas/run_connector_subaction_getincident'
+ - $ref: '#/components/schemas/run_connector_subaction_issue'
+ - $ref: '#/components/schemas/run_connector_subaction_issues'
+ - $ref: '#/components/schemas/run_connector_subaction_issuetypes'
+ - $ref: '#/components/schemas/run_connector_subaction_pushtoservice'
+ discriminator:
+ propertyName: subAction
+ features:
+ type: string
+ description: |
+ The feature that uses the connector.
+ enum:
+ - alerting
+ - cases
+ - generativeAI
+ - siem
+ - uptime
+ connector_types:
+ title: Connector types
+ type: string
+ description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.
+ enum:
+ - .bedrock
+ - .cases-webhook
+ - .d3security
+ - .email
+ - .gen-ai
+ - .index
+ - .jira
+ - .opsgenie
+ - .pagerduty
+ - .resilient
+ - .servicenow
+ - .servicenow-itom
+ - .servicenow-sir
+ - .server-log
+ - .slack
+ - .slack_api
+ - .swimlane
+ - .teams
+ - .tines
+ - .torq
+ - .webhook
+ - .xmatters
+ example: .server-log
action_response_properties:
title: Action response properties
description: The properties vary depending on the action type.
@@ -3795,7 +4095,7 @@ components:
is_missing_secrets: false
is_system_action: false
get_connector_response:
- summary: A list of connector types
+ summary: Get connector details.
value:
id: df770e30-8b8b-11ed-a780-3b746c987a81
name: my_server_log_connector
@@ -3811,60 +4111,6 @@ components:
name: updated-connector
config:
index: updated-index
- get_connectors_response:
- summary: A list of connectors
- value:
- - id: preconfigured-email-connector
- name: my-preconfigured-email-notification
- connector_type_id: .email
- is_preconfigured: true
- is_deprecated: false
- referenced_by_count: 0
- is_system_action: false
- - id: e07d0c80-8b8b-11ed-a780-3b746c987a81
- name: my-index-connector
- config:
- index: test-index
- refresh: false
- executionTimeField: null
- connector_type_id: .index
- is_preconfigured: false
- is_deprecated: false
- referenced_by_count: 2
- is_missing_secrets: false
- is_system_action: false
- get_connector_types_response:
- summary: A list of connector types
- value:
- - id: .swimlane
- name: Swimlane
- enabled: true
- enabled_in_config: true
- enabled_in_license: true
- minimum_license_required: gold
- supported_feature_ids:
- - alerting
- - cases
- - siem
- - id: .index
- name: Index
- enabled: true
- enabled_in_config: true
- enabled_in_license: true
- minimum_license_required: basic
- supported_feature_ids:
- - alerting
- - uptime
- - siem
- - id: .server-log
- name: Server log
- enabled: true
- enabled_in_config: true
- enabled_in_license: true
- minimum_license_required: basic
- supported_feature_ids:
- - alerting
- - uptime
run_index_connector_request:
summary: Run an index connector.
value:
@@ -4005,6 +4251,81 @@ components:
- commentId: 1
pushedDate: '2022-09-08T16:52:27.865Z'
status: ok
+ get_connectors_response:
+ summary: A list of connectors
+ value:
+ - id: preconfigured-email-connector
+ name: my-preconfigured-email-notification
+ connector_type_id: .email
+ is_preconfigured: true
+ is_deprecated: false
+ referenced_by_count: 0
+ is_system_action: false
+ - id: e07d0c80-8b8b-11ed-a780-3b746c987a81
+ name: my-index-connector
+ config:
+ index: test-index
+ refresh: false
+ executionTimeField: null
+ connector_type_id: .index
+ is_preconfigured: false
+ is_deprecated: false
+ referenced_by_count: 2
+ is_missing_secrets: false
+ is_system_action: false
+ get_connector_types_generativeai_response:
+ summary: A list of connector types for the `generativeAI` feature.
+ value:
+ - id: .gen-ai
+ name: OpenAI
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAI
+ is_system_action_type: false
+ - id: .bedrock
+ name: AWS Bedrock
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAI
+ is_system_action_type: false
+ get_connector_types_response:
+ summary: A list of connector types
+ value:
+ - id: .swimlane
+ name: Swimlane
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: gold
+ supported_feature_ids:
+ - alerting
+ - cases
+ - siem
+ - id: .index
+ name: Index
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: basic
+ supported_feature_ids:
+ - alerting
+ - uptime
+ - siem
+ - id: .server-log
+ name: Server log
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: basic
+ supported_feature_ids:
+ - alerting
+ - uptime
responses:
'401':
description: Authorization information is missing or invalid.
diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json
new file mode 100644
index 00000000000000..25d7b7484ae8d5
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json
@@ -0,0 +1,4155 @@
+{
+ "openapi": "3.0.1",
+ "info": {
+ "title": "Connectors",
+ "description": "OpenAPI schema for connectors in Serverless projects",
+ "version": "0.1",
+ "contact": {
+ "name": "Connectors Team"
+ },
+ "license": {
+ "name": "Elastic License 2.0",
+ "url": "https://www.elastic.co/licensing/elastic-license"
+ }
+ },
+ "servers": [
+ {
+ "url": "http://localhost:5601",
+ "description": "local"
+ }
+ ],
+ "security": [
+ {
+ "apiKeyAuth": []
+ }
+ ],
+ "tags": [
+ {
+ "name": "connectors",
+ "description": "Connector APIs enable you to create and manage connectors."
+ }
+ ],
+ "paths": {
+ "/api/actions/connector": {
+ "post": {
+ "summary": "Creates a connector.",
+ "operationId": "createConnector",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/create_connector_request"
+ },
+ "examples": {
+ "createEmailConnectorRequest": {
+ "$ref": "#/components/examples/create_email_connector_request"
+ },
+ "createIndexConnectorRequest": {
+ "$ref": "#/components/examples/create_index_connector_request"
+ },
+ "createWebhookConnectorRequest": {
+ "$ref": "#/components/examples/create_webhook_connector_request"
+ },
+ "createXmattersConnectorRequest": {
+ "$ref": "#/components/examples/create_xmatters_connector_request"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ },
+ "examples": {
+ "createEmailConnectorResponse": {
+ "$ref": "#/components/examples/create_email_connector_response"
+ },
+ "createIndexConnectorResponse": {
+ "$ref": "#/components/examples/create_index_connector_response"
+ },
+ "createWebhookConnectorResponse": {
+ "$ref": "#/components/examples/create_webhook_connector_response"
+ },
+ "createXmattersConnectorResponse": {
+ "$ref": "#/components/examples/create_xmatters_connector_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "/api/actions/connector/{connectorId}": {
+ "get": {
+ "summary": "Retrieves a connector by ID.",
+ "operationId": "getConnector",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/connector_id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ },
+ "examples": {
+ "getConnectorResponse": {
+ "$ref": "#/components/examples/get_connector_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "delete": {
+ "summary": "Deletes a connector.",
+ "operationId": "deleteConnector",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ },
+ {
+ "$ref": "#/components/parameters/connector_id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Indicates a successful call."
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Creates a connector.",
+ "operationId": "createConnectorId",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ },
+ {
+ "in": "path",
+ "name": "connectorId",
+ "description": "A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated.\n",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/create_connector_request"
+ },
+ "examples": {
+ "createIndexConnectorRequest": {
+ "$ref": "#/components/examples/create_index_connector_request"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ },
+ "examples": {
+ "createIndexConnectorResponse": {
+ "$ref": "#/components/examples/create_index_connector_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "put": {
+ "summary": "Updates the attributes for a connector.",
+ "operationId": "updateConnector",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/kbn_xsrf"
+ },
+ {
+ "$ref": "#/components/parameters/connector_id"
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/update_connector_request"
+ },
+ "examples": {
+ "updateIndexConnectorRequest": {
+ "$ref": "#/components/examples/update_index_connector_request"
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#/components/responses/401"
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ },
+ "404": {
+ "$ref": "#/components/responses/404"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "/api/actions/connectors": {
+ "get": {
+ "summary": "Retrieves all connectors.",
+ "operationId": "getConnectors",
+ "tags": [
+ "connectors"
+ ],
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/connector_response_properties"
+ }
+ },
+ "examples": {
+ "getConnectorsResponse": {
+ "$ref": "#/components/examples/get_connectors_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "/api/actions/connector_types": {
+ "get": {
+ "summary": "Retrieves a list of all connector types.",
+ "operationId": "getConnectorTypes",
+ "tags": [
+ "connectors"
+ ],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "feature_id",
+ "description": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).",
+ "schema": {
+ "$ref": "#/components/schemas/features"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Indicates a successful call.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Get connector types response body properties",
+ "description": "The properties vary for each connector type.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Indicates whether the connector type is enabled in Kibana.",
+ "example": true
+ },
+ "enabled_in_config": {
+ "type": "boolean",
+ "description": "Indicates whether the connector type is enabled in the Kibana configuration file.",
+ "example": true
+ },
+ "enabled_in_license": {
+ "type": "boolean",
+ "description": "Indicates whether the connector is enabled in the license.",
+ "example": true
+ },
+ "id": {
+ "$ref": "#/components/schemas/connector_types"
+ },
+ "is_system_action_type": {
+ "type": "boolean",
+ "example": false
+ },
+ "minimum_license_required": {
+ "type": "string",
+ "description": "The license that is required to use the connector type.",
+ "example": "basic"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the connector type.",
+ "example": "Index"
+ },
+ "supported_feature_ids": {
+ "type": "array",
+ "description": "The features that are supported by the connector type.",
+ "items": {
+ "$ref": "#/components/schemas/features"
+ },
+ "example": [
+ "alerting",
+ "cases",
+ "siem"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "getConnectorTypesServerlessResponse": {
+ "$ref": "#/components/examples/get_connector_types_generativeai_response"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/401"
+ }
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ },
+ "servers": [
+ {
+ "url": "https://localhost:5601"
+ }
+ ]
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "apiKeyAuth": {
+ "type": "apiKey",
+ "in": "header",
+ "name": "ApiKey"
+ }
+ },
+ "parameters": {
+ "kbn_xsrf": {
+ "schema": {
+ "type": "string"
+ },
+ "in": "header",
+ "name": "kbn-xsrf",
+ "description": "Cross-site request forgery protection",
+ "required": true
+ },
+ "connector_id": {
+ "in": "path",
+ "name": "connectorId",
+ "description": "An identifier for the connector.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "df770e30-8b8b-11ed-a780-3b746c987a81"
+ }
+ }
+ },
+ "schemas": {
+ "config_properties_bedrock": {
+ "title": "Connector request properties for an Amazon Bedrock connector",
+ "description": "Defines properties for connectors when type is `.bedrock`.",
+ "type": "object",
+ "required": [
+ "apiUrl"
+ ],
+ "properties": {
+ "apiUrl": {
+ "type": "string",
+ "description": "The Amazon Bedrock request URL."
+ },
+ "defaultModel": {
+ "type": "string",
+ "description": "The generative artificial intelligence model for Amazon Bedrock to use. Current support is for the Anthropic Claude models.\n",
+ "default": "anthropic.claude-v2"
+ }
+ }
+ },
+ "secrets_properties_bedrock": {
+ "title": "Connector secrets properties for an Amazon Bedrock connector",
+ "description": "Defines secrets for connectors when type is `.bedrock`.",
+ "type": "object",
+ "required": [
+ "accessKey",
+ "secret"
+ ],
+ "properties": {
+ "accessKey": {
+ "type": "string",
+ "description": "The AWS access key for authentication."
+ },
+ "secret": {
+ "type": "string",
+ "description": "The AWS secret for authentication."
+ }
+ }
+ },
+ "create_connector_request_bedrock": {
+ "title": "Create Amazon Bedrock connector request",
+ "description": "The Amazon Bedrock connector uses axios to send a POST request to Amazon Bedrock.",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_bedrock"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".bedrock"
+ ],
+ "example": ".bedrock"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_bedrock"
+ }
+ }
+ },
+ "config_properties_cases_webhook": {
+ "title": "Connector request properties for Webhook - Case Management connector",
+ "required": [
+ "createIncidentJson",
+ "createIncidentResponseKey",
+ "createIncidentUrl",
+ "getIncidentResponseExternalTitleKey",
+ "getIncidentUrl",
+ "updateIncidentJson",
+ "updateIncidentUrl",
+ "viewIncidentUrl"
+ ],
+ "description": "Defines properties for connectors when type is `.cases-webhook`.",
+ "type": "object",
+ "properties": {
+ "createCommentJson": {
+ "type": "string",
+ "description": "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 `case.comment`. Due to Mustache template variables (the text enclosed in triple braces, for example, `{{{case.title}}}`), 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.\n",
+ "example": {
+ "body": {
+ "[object Object]": null
+ }
+ }
+ },
+ "createCommentMethod": {
+ "type": "string",
+ "description": "The REST API HTTP request method to create a case comment in the third-party system. Valid values are `patch`, `post`, and `put`.\n",
+ "default": "put",
+ "enum": [
+ "patch",
+ "post",
+ "put"
+ ]
+ },
+ "createCommentUrl": {
+ "type": "string",
+ "description": "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 `xpack.actions.allowedHosts setting`, add the hostname to the allowed hosts.\n",
+ "example": "https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.id}}}/comment"
+ },
+ "createIncidentJson": {
+ "type": "string",
+ "description": "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 `case.title` and `case.description`. Due to Mustache template variables (which is the text enclosed in triple braces, for example, `{{{case.title}}}`), 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.\n",
+ "example": {
+ "fields": {
+ "summary": {
+ "[object Object]": null
+ },
+ "description": {
+ "[object Object]": null
+ },
+ "labels": {
+ "[object Object]": null
+ }
+ }
+ }
+ },
+ "createIncidentMethod": {
+ "type": "string",
+ "description": "The REST API HTTP request method to create a case in the third-party system. Valid values are `patch`, `post`, and `put`.\n",
+ "enum": [
+ "patch",
+ "post",
+ "put"
+ ],
+ "default": "post"
+ },
+ "createIncidentResponseKey": {
+ "type": "string",
+ "description": "The JSON key in the create case response that contains the external case ID."
+ },
+ "createIncidentUrl": {
+ "type": "string",
+ "description": "The REST API URL to create a case in the third-party system. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.\n"
+ },
+ "getIncidentResponseExternalTitleKey": {
+ "type": "string",
+ "description": "The JSON key in get case response that contains the external case title."
+ },
+ "getIncidentUrl": {
+ "type": "string",
+ "description": "The REST API URL to get the case by ID from the third-party system. If you are using the `xpack.actions.allowedHosts` 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, `{{{case.title}}}`), 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.\n",
+ "example": "https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.id}}}"
+ },
+ "hasAuth": {
+ "type": "boolean",
+ "description": "If true, a username and password for login type authentication must be provided.",
+ "default": true
+ },
+ "headers": {
+ "type": "string",
+ "description": "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.\n"
+ },
+ "updateIncidentJson": {
+ "type": "string",
+ "description": "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 `case.title` and `case.description`. Due to Mustache template variables (which is the text enclosed in triple braces, for example, `{{{case.title}}}`), 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.\n",
+ "example": {
+ "fields": {
+ "summary": {
+ "[object Object]": null
+ },
+ "description": {
+ "[object Object]": null
+ },
+ "labels": {
+ "[object Object]": null
+ }
+ }
+ }
+ },
+ "updateIncidentMethod": {
+ "type": "string",
+ "description": "The REST API HTTP request method to update the case in the third-party system. Valid values are `patch`, `post`, and `put`.\n",
+ "default": "put",
+ "enum": [
+ "patch",
+ "post",
+ "put"
+ ]
+ },
+ "updateIncidentUrl": {
+ "type": "string",
+ "description": "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 `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.\n",
+ "example": "https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.ID}}}"
+ },
+ "viewIncidentUrl": {
+ "type": "string",
+ "description": "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.\n",
+ "example": "https://testing-jira.atlassian.net/browse/{{{external.system.title}}}"
+ }
+ }
+ },
+ "secrets_properties_cases_webhook": {
+ "title": "Connector secrets properties for Webhook - Case Management connector",
+ "type": "object",
+ "properties": {
+ "password": {
+ "type": "string",
+ "description": "The password for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required."
+ },
+ "user": {
+ "type": "string",
+ "description": "The username for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required."
+ }
+ }
+ },
+ "create_connector_request_cases_webhook": {
+ "title": "Create Webhook - Case Managment connector request",
+ "description": "The Webhook - Case Management connector uses axios to send POST, PUT, and GET requests to a case management RESTful API web service.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_cases_webhook"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".cases-webhook"
+ ],
+ "example": ".cases-webhook"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_cases_webhook"
+ }
+ }
+ },
+ "config_properties_d3security": {
+ "title": "Connector request properties for a D3 Security connector",
+ "description": "Defines properties for connectors when type is `.d3security`.",
+ "type": "object",
+ "required": [
+ "url"
+ ],
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The D3 Security API request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.\n"
+ }
+ }
+ },
+ "secrets_properties_d3security": {
+ "title": "Connector secrets properties for a D3 Security connector",
+ "description": "Defines secrets for connectors when type is `.d3security`.",
+ "required": [
+ "token"
+ ],
+ "type": "object",
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "The D3 Security token."
+ }
+ }
+ },
+ "create_connector_request_d3security": {
+ "title": "Create D3 Security connector request",
+ "description": "The connector uses axios to send a POST request to a D3 Security endpoint.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_d3security"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".d3security"
+ ],
+ "example": ".d3security"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_d3security"
+ }
+ }
+ },
+ "config_properties_email": {
+ "title": "Connector request properties for an email connector",
+ "description": "Defines properties for connectors when type is `.email`.",
+ "required": [
+ "from"
+ ],
+ "type": "object",
+ "properties": {
+ "clientId": {
+ "description": "The client identifier, which is a part of OAuth 2.0 client credentials authentication, in GUID format. If `service` is `exchange_server`, this property is required.\n",
+ "type": "string",
+ "nullable": true
+ },
+ "from": {
+ "description": "The from address for all emails sent by the connector. It must be specified in `user@host-name` format.\n",
+ "type": "string"
+ },
+ "hasAuth": {
+ "description": "Specifies whether a user and password are required inside the secrets configuration.\n",
+ "default": true,
+ "type": "boolean"
+ },
+ "host": {
+ "description": "The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. \n",
+ "type": "string"
+ },
+ "oauthTokenUrl": {
+ "type": "string",
+ "nullable": true
+ },
+ "port": {
+ "description": "The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. \n",
+ "type": "integer"
+ },
+ "secure": {
+ "description": "Specifies whether the connection to the service provider will use TLS. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored.\n",
+ "type": "boolean"
+ },
+ "service": {
+ "description": "The name of the email service.\n",
+ "type": "string",
+ "enum": [
+ "elastic_cloud",
+ "exchange_server",
+ "gmail",
+ "other",
+ "outlook365",
+ "ses"
+ ]
+ },
+ "tenantId": {
+ "description": "The tenant identifier, which is part of OAuth 2.0 client credentials authentication, in GUID format. If `service` is `exchange_server`, this property is required.\n",
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "secrets_properties_email": {
+ "title": "Connector secrets properties for an email connector",
+ "description": "Defines secrets for connectors when type is `.email`.",
+ "type": "object",
+ "properties": {
+ "clientSecret": {
+ "type": "string",
+ "description": "The Microsoft Exchange Client secret for OAuth 2.0 client credentials authentication. It must be URL-encoded. If `service` is `exchange_server`, this property is required.\n"
+ },
+ "password": {
+ "type": "string",
+ "description": "The password for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.\n"
+ },
+ "user": {
+ "type": "string",
+ "description": "The username for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.\n"
+ }
+ }
+ },
+ "create_connector_request_email": {
+ "title": "Create email connector request",
+ "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.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_email"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".email"
+ ],
+ "example": ".email"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_email"
+ }
+ }
+ },
+ "config_properties_genai": {
+ "title": "Connector request properties for an OpenAI connector",
+ "description": "Defines properties for connectors when type is `.gen-ai`.",
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "apiProvider",
+ "apiUrl"
+ ],
+ "properties": {
+ "apiProvider": {
+ "type": "string",
+ "description": "The OpenAI API provider.",
+ "enum": [
+ "Azure OpenAI"
+ ]
+ },
+ "apiUrl": {
+ "type": "string",
+ "description": "The OpenAI API endpoint."
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "apiProvider",
+ "apiUrl"
+ ],
+ "properties": {
+ "apiProvider": {
+ "type": "string",
+ "description": "The OpenAI API provider.",
+ "enum": [
+ "OpenAI"
+ ]
+ },
+ "apiUrl": {
+ "type": "string",
+ "description": "The OpenAI API endpoint."
+ },
+ "defaultModel": {
+ "type": "string",
+ "description": "The default model to use for requests."
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "apiProvider"
+ }
+ },
+ "secrets_properties_genai": {
+ "title": "Connector secrets properties for an OpenAI connector",
+ "description": "Defines secrets for connectors when type is `.gen-ai`.",
+ "type": "object",
+ "properties": {
+ "apiKey": {
+ "type": "string",
+ "description": "The OpenAI API key."
+ }
+ }
+ },
+ "create_connector_request_genai": {
+ "title": "Create OpenAI connector request",
+ "description": "The OpenAI connector uses axios to send a POST request to either OpenAI or Azure OpenAPI.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_genai"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".gen-ai"
+ ],
+ "example": ".gen-ai"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_genai"
+ }
+ }
+ },
+ "config_properties_index": {
+ "title": "Connector request properties for an index connector",
+ "required": [
+ "index"
+ ],
+ "description": "Defines properties for connectors when type is `.index`.",
+ "type": "object",
+ "properties": {
+ "executionTimeField": {
+ "description": "A field that indicates when the document was indexed.",
+ "default": null,
+ "type": "string",
+ "nullable": true
+ },
+ "index": {
+ "description": "The Elasticsearch index to be written to.",
+ "type": "string"
+ },
+ "refresh": {
+ "description": "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.\n",
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ },
+ "create_connector_request_index": {
+ "title": "Create index connector request",
+ "description": "The index connector indexes a document into Elasticsearch.",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_index"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".index"
+ ],
+ "example": ".index"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ }
+ }
+ },
+ "config_properties_jira": {
+ "title": "Connector request properties for a Jira connector",
+ "required": [
+ "apiUrl",
+ "projectKey"
+ ],
+ "description": "Defines properties for connectors when type is `.jira`.",
+ "type": "object",
+ "properties": {
+ "apiUrl": {
+ "description": "The Jira instance URL.",
+ "type": "string"
+ },
+ "projectKey": {
+ "description": "The Jira project key.",
+ "type": "string"
+ }
+ }
+ },
+ "secrets_properties_jira": {
+ "title": "Connector secrets properties for a Jira connector",
+ "required": [
+ "apiToken",
+ "email"
+ ],
+ "description": "Defines secrets for connectors when type is `.jira`.",
+ "type": "object",
+ "properties": {
+ "apiToken": {
+ "description": "The Jira API authentication token for HTTP basic authentication.",
+ "type": "string"
+ },
+ "email": {
+ "description": "The account email for HTTP Basic authentication.",
+ "type": "string"
+ }
+ }
+ },
+ "create_connector_request_jira": {
+ "title": "Create Jira connector request",
+ "description": "The Jira connector uses the REST API v2 to create Jira issues.",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_jira"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".jira"
+ ],
+ "example": ".jira"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_jira"
+ }
+ }
+ },
+ "config_properties_opsgenie": {
+ "title": "Connector request properties for an Opsgenie connector",
+ "required": [
+ "apiUrl"
+ ],
+ "description": "Defines properties for connectors when type is `.opsgenie`.",
+ "type": "object",
+ "properties": {
+ "apiUrl": {
+ "description": "The Opsgenie URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.\n",
+ "type": "string"
+ }
+ }
+ },
+ "secrets_properties_opsgenie": {
+ "title": "Connector secrets properties for an Opsgenie connector",
+ "required": [
+ "apiKey"
+ ],
+ "description": "Defines secrets for connectors when type is `.opsgenie`.",
+ "type": "object",
+ "properties": {
+ "apiKey": {
+ "description": "The Opsgenie API authentication key for HTTP Basic authentication.",
+ "type": "string"
+ }
+ }
+ },
+ "create_connector_request_opsgenie": {
+ "title": "Create Opsgenie connector request",
+ "description": "The Opsgenie connector uses the Opsgenie alert API.",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_opsgenie"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".opsgenie"
+ ],
+ "example": ".opsgenie"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_opsgenie"
+ }
+ }
+ },
+ "config_properties_pagerduty": {
+ "title": "Connector request properties for a PagerDuty connector",
+ "description": "Defines properties for connectors when type is `.pagerduty`.",
+ "type": "object",
+ "properties": {
+ "apiUrl": {
+ "description": "The PagerDuty event URL.",
+ "type": "string",
+ "nullable": true,
+ "example": "https://events.pagerduty.com/v2/enqueue"
+ }
+ }
+ },
+ "secrets_properties_pagerduty": {
+ "title": "Connector secrets properties for a PagerDuty connector",
+ "description": "Defines secrets for connectors when type is `.pagerduty`.",
+ "type": "object",
+ "required": [
+ "routingKey"
+ ],
+ "properties": {
+ "routingKey": {
+ "description": "A 32 character PagerDuty Integration Key for an integration on a service.\n",
+ "type": "string"
+ }
+ }
+ },
+ "create_connector_request_pagerduty": {
+ "title": "Create PagerDuty connector request",
+ "description": "The PagerDuty connector uses the v2 Events API to trigger, acknowledge, and resolve PagerDuty alerts.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_pagerduty"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".pagerduty"
+ ],
+ "example": ".pagerduty"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_pagerduty"
+ }
+ }
+ },
+ "config_properties_resilient": {
+ "title": "Connector request properties for a IBM Resilient connector",
+ "required": [
+ "apiUrl",
+ "orgId"
+ ],
+ "description": "Defines properties for connectors when type is `.resilient`.",
+ "type": "object",
+ "properties": {
+ "apiUrl": {
+ "description": "The IBM Resilient instance URL.",
+ "type": "string"
+ },
+ "orgId": {
+ "description": "The IBM Resilient organization ID.",
+ "type": "string"
+ }
+ }
+ },
+ "secrets_properties_resilient": {
+ "title": "Connector secrets properties for IBM Resilient connector",
+ "required": [
+ "apiKeyId",
+ "apiKeySecret"
+ ],
+ "description": "Defines secrets for connectors when type is `.resilient`.",
+ "type": "object",
+ "properties": {
+ "apiKeyId": {
+ "type": "string",
+ "description": "The authentication key ID for HTTP Basic authentication."
+ },
+ "apiKeySecret": {
+ "type": "string",
+ "description": "The authentication key secret for HTTP Basic authentication."
+ }
+ }
+ },
+ "create_connector_request_resilient": {
+ "title": "Create IBM Resilient connector request",
+ "description": "The IBM Resilient connector uses the RESILIENT REST v2 to create IBM Resilient incidents.",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_resilient"
+ },
+ "connector_type_id": {
+ "description": "The type of connector.",
+ "type": "string",
+ "example": ".resilient",
+ "enum": [
+ ".resilient"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_resilient"
+ }
+ }
+ },
+ "create_connector_request_serverlog": {
+ "title": "Create server log connector request",
+ "description": "This connector writes an entry to the Kibana server log.",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "name"
+ ],
+ "properties": {
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".server-log"
+ ],
+ "example": ".server-log"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ }
+ }
+ },
+ "config_properties_servicenow": {
+ "title": "Connector request properties for a ServiceNow ITSM connector",
+ "required": [
+ "apiUrl"
+ ],
+ "description": "Defines properties for connectors when type is `.servicenow`.",
+ "type": "object",
+ "properties": {
+ "apiUrl": {
+ "type": "string",
+ "description": "The ServiceNow instance URL."
+ },
+ "clientId": {
+ "description": "The client ID assigned to your OAuth application. This property is required when `isOAuth` is `true`.\n",
+ "type": "string"
+ },
+ "isOAuth": {
+ "description": "The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).\n",
+ "default": false,
+ "type": "boolean"
+ },
+ "jwtKeyId": {
+ "description": "The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.\n",
+ "type": "string"
+ },
+ "userIdentifierValue": {
+ "description": "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 `Email`, the user identifier should be the user's email address. This property is required when `isOAuth` is `true`.\n",
+ "type": "string"
+ },
+ "usesTableApi": {
+ "description": "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 `false`, the Elastic application should be installed in ServiceNow.\n",
+ "default": true,
+ "type": "boolean"
+ }
+ }
+ },
+ "secrets_properties_servicenow": {
+ "title": "Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors",
+ "description": "Defines secrets for connectors when type is `.servicenow`, `.servicenow-sir`, or `.servicenow-itom`.",
+ "type": "object",
+ "properties": {
+ "clientSecret": {
+ "type": "string",
+ "description": "The client secret assigned to your OAuth application. This property is required when `isOAuth` is `true`."
+ },
+ "password": {
+ "type": "string",
+ "description": "The password for HTTP basic authentication. This property is required when `isOAuth` is `false`."
+ },
+ "privateKey": {
+ "type": "string",
+ "description": "The RSA private key that you created for use in ServiceNow. This property is required when `isOAuth` is `true`."
+ },
+ "privateKeyPassword": {
+ "type": "string",
+ "description": "The password for the RSA private key. This property is required when `isOAuth` is `true` and you set a password on your private key."
+ },
+ "username": {
+ "type": "string",
+ "description": "The username for HTTP basic authentication. This property is required when `isOAuth` is `false`."
+ }
+ }
+ },
+ "create_connector_request_servicenow": {
+ "title": "Create ServiceNow ITSM connector request",
+ "description": "The ServiceNow ITSM connector uses the import set API to create ServiceNow incidents. You can use the connector for rule actions and cases.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_servicenow"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".servicenow"
+ ],
+ "example": ".servicenow"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_servicenow"
+ }
+ }
+ },
+ "config_properties_servicenow_itom": {
+ "title": "Connector request properties for a ServiceNow ITSM connector",
+ "required": [
+ "apiUrl"
+ ],
+ "description": "Defines properties for connectors when type is `.servicenow`.",
+ "type": "object",
+ "properties": {
+ "apiUrl": {
+ "type": "string",
+ "description": "The ServiceNow instance URL."
+ },
+ "clientId": {
+ "description": "The client ID assigned to your OAuth application. This property is required when `isOAuth` is `true`.\n",
+ "type": "string"
+ },
+ "isOAuth": {
+ "description": "The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).\n",
+ "default": false,
+ "type": "boolean"
+ },
+ "jwtKeyId": {
+ "description": "The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.\n",
+ "type": "string"
+ },
+ "userIdentifierValue": {
+ "description": "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 `Email`, the user identifier should be the user's email address. This property is required when `isOAuth` is `true`.\n",
+ "type": "string"
+ }
+ }
+ },
+ "create_connector_request_servicenow_itom": {
+ "title": "Create ServiceNow ITOM connector request",
+ "description": "The ServiceNow ITOM connector uses the event API to create ServiceNow events. You can use the connector for rule actions.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_servicenow_itom"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".servicenow-itom"
+ ],
+ "example": ".servicenow-itom"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_servicenow"
+ }
+ }
+ },
+ "create_connector_request_servicenow_sir": {
+ "title": "Create ServiceNow SecOps connector request",
+ "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.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_servicenow"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".servicenow-sir"
+ ],
+ "example": ".servicenow-sir"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_servicenow"
+ }
+ }
+ },
+ "secrets_properties_slack_api": {
+ "title": "Connector secrets properties for a Web API Slack connector",
+ "description": "Defines secrets for connectors when type is `.slack`.",
+ "required": [
+ "token"
+ ],
+ "type": "object",
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "Slack bot user OAuth token."
+ }
+ }
+ },
+ "create_connector_request_slack_api": {
+ "title": "Create Slack connector request",
+ "description": "The Slack connector uses Slack Incoming Webhooks.",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".slack_api"
+ ],
+ "example": ".slack_api"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_slack_api"
+ }
+ }
+ },
+ "secrets_properties_slack_webhook": {
+ "title": "Connector secrets properties for a Webhook Slack connector",
+ "description": "Defines secrets for connectors when type is `.slack`.",
+ "required": [
+ "webhookUrl"
+ ],
+ "type": "object",
+ "properties": {
+ "webhookUrl": {
+ "type": "string",
+ "description": "Slack webhook url."
+ }
+ }
+ },
+ "create_connector_request_slack_webhook": {
+ "title": "Create Slack connector request",
+ "description": "The Slack connector uses Slack Incoming Webhooks.",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".slack"
+ ],
+ "example": ".slack"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_slack_webhook"
+ }
+ }
+ },
+ "config_properties_swimlane": {
+ "title": "Connector request properties for a Swimlane connector",
+ "required": [
+ "apiUrl",
+ "appId",
+ "connectorType"
+ ],
+ "description": "Defines properties for connectors when type is `.swimlane`.",
+ "type": "object",
+ "properties": {
+ "apiUrl": {
+ "description": "The Swimlane instance URL.",
+ "type": "string"
+ },
+ "appId": {
+ "description": "The Swimlane application ID.",
+ "type": "string"
+ },
+ "connectorType": {
+ "description": "The type of connector. Valid values are `all`, `alerts`, and `cases`.",
+ "type": "string",
+ "enum": [
+ "all",
+ "alerts",
+ "cases"
+ ]
+ },
+ "mappings": {
+ "title": "Connector mappings properties for a Swimlane connector",
+ "description": "The field mapping.",
+ "type": "object",
+ "properties": {
+ "alertIdConfig": {
+ "title": "Alert identifier mapping",
+ "description": "Mapping for the alert ID.",
+ "type": "object",
+ "required": [
+ "fieldType",
+ "id",
+ "key",
+ "name"
+ ],
+ "properties": {
+ "fieldType": {
+ "type": "string",
+ "description": "The type of field in Swimlane."
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the field in Swimlane."
+ },
+ "key": {
+ "type": "string",
+ "description": "The key for the field in Swimlane."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the field in Swimlane."
+ }
+ }
+ },
+ "caseIdConfig": {
+ "title": "Case identifier mapping",
+ "description": "Mapping for the case ID.",
+ "type": "object",
+ "required": [
+ "fieldType",
+ "id",
+ "key",
+ "name"
+ ],
+ "properties": {
+ "fieldType": {
+ "type": "string",
+ "description": "The type of field in Swimlane."
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the field in Swimlane."
+ },
+ "key": {
+ "type": "string",
+ "description": "The key for the field in Swimlane."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the field in Swimlane."
+ }
+ }
+ },
+ "caseNameConfig": {
+ "title": "Case name mapping",
+ "description": "Mapping for the case name.",
+ "type": "object",
+ "required": [
+ "fieldType",
+ "id",
+ "key",
+ "name"
+ ],
+ "properties": {
+ "fieldType": {
+ "type": "string",
+ "description": "The type of field in Swimlane."
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the field in Swimlane."
+ },
+ "key": {
+ "type": "string",
+ "description": "The key for the field in Swimlane."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the field in Swimlane."
+ }
+ }
+ },
+ "commentsConfig": {
+ "title": "Case comment mapping",
+ "description": "Mapping for the case comments.",
+ "type": "object",
+ "required": [
+ "fieldType",
+ "id",
+ "key",
+ "name"
+ ],
+ "properties": {
+ "fieldType": {
+ "type": "string",
+ "description": "The type of field in Swimlane."
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the field in Swimlane."
+ },
+ "key": {
+ "type": "string",
+ "description": "The key for the field in Swimlane."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the field in Swimlane."
+ }
+ }
+ },
+ "descriptionConfig": {
+ "title": "Case description mapping",
+ "description": "Mapping for the case description.",
+ "type": "object",
+ "required": [
+ "fieldType",
+ "id",
+ "key",
+ "name"
+ ],
+ "properties": {
+ "fieldType": {
+ "type": "string",
+ "description": "The type of field in Swimlane."
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the field in Swimlane."
+ },
+ "key": {
+ "type": "string",
+ "description": "The key for the field in Swimlane."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the field in Swimlane."
+ }
+ }
+ },
+ "ruleNameConfig": {
+ "title": "Rule name mapping",
+ "description": "Mapping for the name of the alert's rule.",
+ "type": "object",
+ "required": [
+ "fieldType",
+ "id",
+ "key",
+ "name"
+ ],
+ "properties": {
+ "fieldType": {
+ "type": "string",
+ "description": "The type of field in Swimlane."
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the field in Swimlane."
+ },
+ "key": {
+ "type": "string",
+ "description": "The key for the field in Swimlane."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the field in Swimlane."
+ }
+ }
+ },
+ "severityConfig": {
+ "title": "Severity mapping",
+ "description": "Mapping for the severity.",
+ "type": "object",
+ "required": [
+ "fieldType",
+ "id",
+ "key",
+ "name"
+ ],
+ "properties": {
+ "fieldType": {
+ "type": "string",
+ "description": "The type of field in Swimlane."
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the field in Swimlane."
+ },
+ "key": {
+ "type": "string",
+ "description": "The key for the field in Swimlane."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the field in Swimlane."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "secrets_properties_swimlane": {
+ "title": "Connector secrets properties for a Swimlane connector",
+ "description": "Defines secrets for connectors when type is `.swimlane`.",
+ "type": "object",
+ "properties": {
+ "apiToken": {
+ "description": "Swimlane API authentication token.",
+ "type": "string"
+ }
+ }
+ },
+ "create_connector_request_swimlane": {
+ "title": "Create Swimlane connector request",
+ "description": "The Swimlane connector uses the Swimlane REST API to create Swimlane records.",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_swimlane"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".swimlane"
+ ],
+ "example": ".swimlane"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_swimlane"
+ }
+ }
+ },
+ "secrets_properties_teams": {
+ "title": "Connector secrets properties for a Microsoft Teams connector",
+ "description": "Defines secrets for connectors when type is `.teams`.",
+ "type": "object",
+ "required": [
+ "webhookUrl"
+ ],
+ "properties": {
+ "webhookUrl": {
+ "type": "string",
+ "description": "The URL of the incoming webhook. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.\n"
+ }
+ }
+ },
+ "create_connector_request_teams": {
+ "title": "Create Microsoft Teams connector request",
+ "description": "The Microsoft Teams connector uses Incoming Webhooks.",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".teams"
+ ],
+ "example": ".teams"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_teams"
+ }
+ }
+ },
+ "config_properties_tines": {
+ "title": "Connector request properties for a Tines connector",
+ "description": "Defines properties for connectors when type is `.tines`.",
+ "type": "object",
+ "required": [
+ "url"
+ ],
+ "properties": {
+ "url": {
+ "description": "The Tines tenant URL. If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.\n",
+ "type": "string"
+ }
+ }
+ },
+ "secrets_properties_tines": {
+ "title": "Connector secrets properties for a Tines connector",
+ "description": "Defines secrets for connectors when type is `.tines`.",
+ "type": "object",
+ "required": [
+ "email",
+ "token"
+ ],
+ "properties": {
+ "email": {
+ "description": "The email used to sign in to Tines.",
+ "type": "string"
+ },
+ "token": {
+ "description": "The Tines API token.",
+ "type": "string"
+ }
+ }
+ },
+ "create_connector_request_tines": {
+ "title": "Create Tines connector request",
+ "description": "The Tines connector uses Tines Webhook actions to send events via POST request.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_tines"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".tines"
+ ],
+ "example": ".tines"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_tines"
+ }
+ }
+ },
+ "config_properties_torq": {
+ "title": "Connector request properties for a Torq connector",
+ "description": "Defines properties for connectors when type is `.torq`.",
+ "type": "object",
+ "required": [
+ "webhookIntegrationUrl"
+ ],
+ "properties": {
+ "webhookIntegrationUrl": {
+ "description": "The endpoint URL of the Elastic Security integration in Torq.",
+ "type": "string"
+ }
+ }
+ },
+ "secrets_properties_torq": {
+ "title": "Connector secrets properties for a Torq connector",
+ "description": "Defines secrets for connectors when type is `.torq`.",
+ "type": "object",
+ "required": [
+ "token"
+ ],
+ "properties": {
+ "token": {
+ "description": "The secret of the webhook authentication header.",
+ "type": "string"
+ }
+ }
+ },
+ "create_connector_request_torq": {
+ "title": "Create Torq connector request",
+ "description": "The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_torq"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".torq"
+ ],
+ "example": ".torq"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_torq"
+ }
+ }
+ },
+ "config_properties_webhook": {
+ "title": "Connector request properties for a Webhook connector",
+ "description": "Defines properties for connectors when type is `.webhook`.",
+ "type": "object",
+ "properties": {
+ "authType": {
+ "type": "string",
+ "enum": [
+ "webhook-authentication-basic",
+ "webhook-authentication-ssl",
+ "null"
+ ],
+ "description": "The type of authentication to use: basic, SSL, or none.\n"
+ },
+ "ca": {
+ "type": "string",
+ "description": "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.\n"
+ },
+ "certType": {
+ "type": "string",
+ "description": "If the `authType` is `webhook-authentication-ssl`, specifies whether the certificate authentication data is in a CRT and key file format or a PFX file format.\n",
+ "enum": [
+ "ssl-crt-key",
+ "ssl-pfx"
+ ]
+ },
+ "hasAuth": {
+ "type": "boolean",
+ "description": "If `true`, a user name and password must be provided for login type authentication.\n"
+ },
+ "headers": {
+ "type": "object",
+ "nullable": true,
+ "description": "A set of key-value pairs sent as headers with the request."
+ },
+ "method": {
+ "type": "string",
+ "default": "post",
+ "enum": [
+ "post",
+ "put"
+ ],
+ "description": "The HTTP request method, either `post` or `put`.\n"
+ },
+ "url": {
+ "type": "string",
+ "description": "The request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.\n"
+ },
+ "verificationMode": {
+ "type": "string",
+ "enum": [
+ "certificate",
+ "full",
+ "none"
+ ],
+ "default": "full",
+ "description": "Controls the verification of certificates. Use `full` to validate that the certificate has an issue date within the `not_before` and `not_after` dates, chains to a trusted certificate authority (CA), and has a hostname or IP address that matches the names within the certificate. Use `certificate` to validate the certificate and verify that it is signed by a trusted authority; this option does not check the certificate hostname. Use `none` to skip certificate validation.\n"
+ }
+ }
+ },
+ "secrets_properties_webhook": {
+ "title": "Connector secrets properties for a Webhook connector",
+ "description": "Defines secrets for connectors when type is `.webhook`.",
+ "type": "object",
+ "properties": {
+ "crt": {
+ "type": "string",
+ "description": "If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-crt-key`, it is a base64 encoded version of the CRT or CERT file."
+ },
+ "key": {
+ "type": "string",
+ "description": "If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-crt-key`, it is a base64 encoded version of the KEY file."
+ },
+ "pfx": {
+ "type": "string",
+ "description": "If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-pfx`, it is a base64 encoded version of the PFX or P12 file."
+ },
+ "password": {
+ "type": "string",
+ "description": "The password for HTTP basic authentication or the passphrase for the SSL certificate files. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.\n"
+ },
+ "user": {
+ "type": "string",
+ "description": "The username for HTTP basic authentication. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.\n"
+ }
+ }
+ },
+ "create_connector_request_webhook": {
+ "title": "Create Webhook connector request",
+ "description": "The Webhook connector uses axios to send a POST or PUT request to a web service.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_webhook"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".webhook"
+ ],
+ "example": ".webhook"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_webhook"
+ }
+ }
+ },
+ "config_properties_xmatters": {
+ "title": "Connector request properties for an xMatters connector",
+ "description": "Defines properties for connectors when type is `.xmatters`.",
+ "type": "object",
+ "properties": {
+ "configUrl": {
+ "description": "The request URL for the Elastic Alerts trigger in xMatters. It is applicable only when `usesBasic` is `true`.\n",
+ "type": "string",
+ "nullable": true
+ },
+ "usesBasic": {
+ "description": "Specifies whether the connector uses HTTP basic authentication (`true`) or URL authentication (`false`).",
+ "type": "boolean",
+ "default": true
+ }
+ }
+ },
+ "secrets_properties_xmatters": {
+ "title": "Connector secrets properties for an xMatters connector",
+ "description": "Defines secrets for connectors when type is `.xmatters`.",
+ "type": "object",
+ "properties": {
+ "password": {
+ "description": "A user name for HTTP basic authentication. It is applicable only when `usesBasic` is `true`.\n",
+ "type": "string"
+ },
+ "secretsUrl": {
+ "description": "The request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL. It is applicable only when `usesBasic` is `false`.\n",
+ "type": "string"
+ },
+ "user": {
+ "description": "A password for HTTP basic authentication. It is applicable only when `usesBasic` is `true`.\n",
+ "type": "string"
+ }
+ }
+ },
+ "create_connector_request_xmatters": {
+ "title": "Create xMatters connector request",
+ "description": "The xMatters connector uses the xMatters Workflow for Elastic to send actionable alerts to on-call xMatters resources.\n",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_xmatters"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".xmatters"
+ ],
+ "example": ".xmatters"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_xmatters"
+ }
+ }
+ },
+ "create_connector_request": {
+ "title": "Create connector request body properties",
+ "description": "The properties vary depending on the connector type.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/create_connector_request_bedrock"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_cases_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_d3security"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_email"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_genai"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_index"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_jira"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_opsgenie"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_pagerduty"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_resilient"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_serverlog"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_servicenow"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_servicenow_itom"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_servicenow_sir"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_slack_api"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_slack_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_swimlane"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_teams"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_tines"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_torq"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_xmatters"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "connector_type_id"
+ }
+ },
+ "is_deprecated": {
+ "type": "boolean",
+ "description": "Indicates whether the connector type is deprecated.",
+ "example": false
+ },
+ "is_missing_secrets": {
+ "type": "boolean",
+ "description": "Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.",
+ "example": false
+ },
+ "is_preconfigured": {
+ "type": "boolean",
+ "description": "Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. \n",
+ "example": false
+ },
+ "is_system_action": {
+ "type": "boolean",
+ "description": "Indicates whether the connector is used for system actions.",
+ "example": false
+ },
+ "connector_response_properties_bedrock": {
+ "title": "Connector response properties for an Amazon Bedrock connector",
+ "type": "object",
+ "required": [
+ "config",
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_bedrock"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".bedrock"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ }
+ }
+ },
+ "referenced_by_count": {
+ "type": "integer",
+ "description": "Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated. This property is returned only by the get all connectors API.\n",
+ "example": 2
+ },
+ "connector_response_properties_cases_webhook": {
+ "title": "Connector request properties for a Webhook - Case Management connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_cases_webhook"
+ },
+ "connector_type_id": {
+ "description": "The type of connector.",
+ "type": "string",
+ "enum": [
+ ".cases-webhook"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_d3security": {
+ "title": "Connector response properties for a D3 Security connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_d3security"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".d3security"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_email": {
+ "title": "Connector response properties for an email connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_email"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".email"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_index": {
+ "title": "Connector response properties for an index connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_index"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".index"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_jira": {
+ "title": "Connector response properties for a Jira connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_jira"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".jira"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_opsgenie": {
+ "title": "Connector response properties for an Opsgenie connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_opsgenie"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".opsgenie"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_pagerduty": {
+ "title": "Connector response properties for a PagerDuty connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_pagerduty"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".pagerduty"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_resilient": {
+ "title": "Connector response properties for a IBM Resilient connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_resilient"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".resilient"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_serverlog": {
+ "title": "Connector response properties for a server log connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "type": "object",
+ "nullable": true
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".server-log"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_servicenow": {
+ "title": "Connector response properties for a ServiceNow ITSM connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_servicenow"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".servicenow"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_servicenow_itom": {
+ "title": "Connector response properties for a ServiceNow ITOM connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_servicenow_itom"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".servicenow-itom"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_servicenow_sir": {
+ "title": "Connector response properties for a ServiceNow SecOps connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_servicenow"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".servicenow-sir"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_slack_api": {
+ "title": "Connector response properties for a Slack connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".slack_api"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_slack_webhook": {
+ "title": "Connector response properties for a Slack connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".slack"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_swimlane": {
+ "title": "Connector response properties for a Swimlane connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_swimlane"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".swimlane"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_teams": {
+ "title": "Connector response properties for a Microsoft Teams connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "type": "object"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".teams"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_tines": {
+ "title": "Connector response properties for a Tines connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_tines"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".tines"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_torq": {
+ "title": "Connector response properties for a Torq connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_torq"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".torq"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_webhook": {
+ "title": "Connector response properties for a Webhook connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_webhook"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".webhook"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties_xmatters": {
+ "title": "Connector response properties for an xMatters connector",
+ "type": "object",
+ "required": [
+ "connector_type_id",
+ "id",
+ "is_deprecated",
+ "is_preconfigured",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_xmatters"
+ },
+ "connector_type_id": {
+ "type": "string",
+ "description": "The type of connector.",
+ "enum": [
+ ".xmatters"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "description": "The identifier for the connector."
+ },
+ "is_deprecated": {
+ "$ref": "#/components/schemas/is_deprecated"
+ },
+ "is_missing_secrets": {
+ "$ref": "#/components/schemas/is_missing_secrets"
+ },
+ "is_preconfigured": {
+ "$ref": "#/components/schemas/is_preconfigured"
+ },
+ "is_system_action": {
+ "$ref": "#/components/schemas/is_system_action"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "referenced_by_count": {
+ "$ref": "#/components/schemas/referenced_by_count"
+ }
+ }
+ },
+ "connector_response_properties": {
+ "title": "Connector response properties",
+ "description": "The properties vary depending on the connector type.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/connector_response_properties_bedrock"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_cases_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_d3security"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_email"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_index"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_jira"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_opsgenie"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_pagerduty"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_resilient"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_serverlog"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_servicenow"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_servicenow_itom"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_servicenow_sir"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_slack_api"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_slack_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_swimlane"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_teams"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_tines"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_torq"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/connector_response_properties_xmatters"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "connector_type_id"
+ }
+ },
+ "update_connector_request_bedrock": {
+ "title": "Update Amazon Bedrock connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_bedrock"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_bedrock"
+ }
+ }
+ },
+ "update_connector_request_cases_webhook": {
+ "title": "Update Webhook - Case Managment connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_cases_webhook"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_cases_webhook"
+ }
+ }
+ },
+ "update_connector_request_d3security": {
+ "title": "Update D3 Security connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_d3security"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_d3security"
+ }
+ }
+ },
+ "update_connector_request_email": {
+ "title": "Update email connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_email"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_email"
+ }
+ }
+ },
+ "update_connector_request_index": {
+ "title": "Update index connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_index"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ }
+ }
+ },
+ "update_connector_request_jira": {
+ "title": "Update Jira connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_jira"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_jira"
+ }
+ }
+ },
+ "update_connector_request_opsgenie": {
+ "title": "Update Opsgenie connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_opsgenie"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_opsgenie"
+ }
+ }
+ },
+ "update_connector_request_pagerduty": {
+ "title": "Update PagerDuty connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_pagerduty"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_pagerduty"
+ }
+ }
+ },
+ "update_connector_request_resilient": {
+ "title": "Update IBM Resilient connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_resilient"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_resilient"
+ }
+ }
+ },
+ "update_connector_request_serverlog": {
+ "title": "Update server log connector request",
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ }
+ }
+ },
+ "update_connector_request_servicenow": {
+ "title": "Update ServiceNow ITSM connector or ServiceNow SecOps request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_servicenow"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_servicenow"
+ }
+ }
+ },
+ "update_connector_request_servicenow_itom": {
+ "title": "Create ServiceNow ITOM connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_servicenow_itom"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_servicenow"
+ }
+ }
+ },
+ "update_connector_request_slack_api": {
+ "title": "Update Slack connector request",
+ "type": "object",
+ "required": [
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_slack_api"
+ }
+ }
+ },
+ "update_connector_request_slack_webhook": {
+ "title": "Update Slack connector request",
+ "type": "object",
+ "required": [
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_slack_webhook"
+ }
+ }
+ },
+ "update_connector_request_swimlane": {
+ "title": "Update Swimlane connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_swimlane"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector.",
+ "example": "my-connector"
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_swimlane"
+ }
+ }
+ },
+ "update_connector_request_teams": {
+ "title": "Update Microsoft Teams connector request",
+ "type": "object",
+ "required": [
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_teams"
+ }
+ }
+ },
+ "update_connector_request_tines": {
+ "title": "Update Tines connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_tines"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_tines"
+ }
+ }
+ },
+ "update_connector_request_torq": {
+ "title": "Update Torq connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_torq"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_torq"
+ }
+ }
+ },
+ "update_connector_request_webhook": {
+ "title": "Update Webhook connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_webhook"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_webhook"
+ }
+ }
+ },
+ "update_connector_request_xmatters": {
+ "title": "Update xMatters connector request",
+ "type": "object",
+ "required": [
+ "config",
+ "name",
+ "secrets"
+ ],
+ "properties": {
+ "config": {
+ "$ref": "#/components/schemas/config_properties_xmatters"
+ },
+ "name": {
+ "type": "string",
+ "description": "The display name for the connector."
+ },
+ "secrets": {
+ "$ref": "#/components/schemas/secrets_properties_xmatters"
+ }
+ }
+ },
+ "update_connector_request": {
+ "title": "Update connector request body properties",
+ "description": "The properties vary depending on the connector type.",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/update_connector_request_bedrock"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_cases_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_d3security"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_email"
+ },
+ {
+ "$ref": "#/components/schemas/create_connector_request_genai"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_index"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_jira"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_opsgenie"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_pagerduty"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_resilient"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_serverlog"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_servicenow"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_servicenow_itom"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_slack_api"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_slack_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_swimlane"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_teams"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_tines"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_torq"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_webhook"
+ },
+ {
+ "$ref": "#/components/schemas/update_connector_request_xmatters"
+ }
+ ]
+ },
+ "features": {
+ "type": "string",
+ "description": "The feature that uses the connector.\n",
+ "enum": [
+ "alerting",
+ "cases",
+ "generativeAI",
+ "siem",
+ "uptime"
+ ]
+ },
+ "connector_types": {
+ "title": "Connector types",
+ "type": "string",
+ "description": "The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.",
+ "enum": [
+ ".bedrock",
+ ".cases-webhook",
+ ".d3security",
+ ".email",
+ ".gen-ai",
+ ".index",
+ ".jira",
+ ".opsgenie",
+ ".pagerduty",
+ ".resilient",
+ ".servicenow",
+ ".servicenow-itom",
+ ".servicenow-sir",
+ ".server-log",
+ ".slack",
+ ".slack_api",
+ ".swimlane",
+ ".teams",
+ ".tines",
+ ".torq",
+ ".webhook",
+ ".xmatters"
+ ],
+ "example": ".server-log"
+ }
+ },
+ "examples": {
+ "create_email_connector_request": {
+ "summary": "Create an email connector.",
+ "value": {
+ "name": "email-connector-1",
+ "connector_type_id": ".email",
+ "config": {
+ "from": "tester@example.com",
+ "hasAuth": true,
+ "host": "https://example.com",
+ "port": 1025,
+ "secure": false,
+ "service": "other"
+ },
+ "secrets": {
+ "user": "username",
+ "password": "password"
+ }
+ }
+ },
+ "create_index_connector_request": {
+ "summary": "Create an index connector.",
+ "value": {
+ "name": "my-connector",
+ "connector_type_id": ".index",
+ "config": {
+ "index": "test-index"
+ }
+ }
+ },
+ "create_webhook_connector_request": {
+ "summary": "Create a webhook connector with SSL authentication.",
+ "value": {
+ "name": "my-webhook-connector",
+ "connector_type_id": ".webhook",
+ "config": {
+ "method": "post",
+ "url": "https://example.com",
+ "authType": "webhook-authentication-ssl",
+ "certType": "ssl-crt-key"
+ },
+ "secrets": {
+ "crt": "QmFnIEF0dH...",
+ "key": "LS0tLS1CRUdJ...",
+ "password": "my-passphrase"
+ }
+ }
+ },
+ "create_xmatters_connector_request": {
+ "summary": "Create an xMatters connector with URL authentication.",
+ "value": {
+ "name": "my-xmatters-connector",
+ "connector_type_id": ".xmatters",
+ "config": {
+ "usesBasic": false
+ },
+ "secrets": {
+ "secretsUrl": "https://example.com?apiKey=xxxxx"
+ }
+ }
+ },
+ "create_email_connector_response": {
+ "summary": "A new email connector.",
+ "value": {
+ "id": "90a82c60-478f-11ee-a343-f98a117c727f",
+ "connector_type_id": ".email",
+ "name": "email-connector-1",
+ "config": {
+ "from": "tester@example.com",
+ "service": "other",
+ "host": "https://example.com",
+ "port": 1025,
+ "secure": false,
+ "hasAuth": true,
+ "tenantId": null,
+ "clientId": null,
+ "oauthTokenUrl": null
+ },
+ "is_preconfigured": false,
+ "is_deprecated": false,
+ "is_missing_secrets": false,
+ "is_system_action": false
+ }
+ },
+ "create_index_connector_response": {
+ "summary": "A new index connector.",
+ "value": {
+ "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
+ "connector_type_id": ".index",
+ "name": "my-connector",
+ "config": {
+ "index": "test-index",
+ "refresh": false,
+ "executionTimeField": null
+ },
+ "is_preconfigured": false,
+ "is_deprecated": false,
+ "is_missing_secrets": false,
+ "is_system_action": false
+ }
+ },
+ "create_webhook_connector_response": {
+ "summary": "A new webhook connector.",
+ "value": {
+ "id": "900eb010-3b9d-11ee-a642-8ffbb94e38bd",
+ "name": "my-webhook-connector",
+ "config": {
+ "method": "post",
+ "url": "https://example.com",
+ "authType": "webhook-authentication-ssl",
+ "certType": "ssl-crt-key",
+ "verificationMode": "full",
+ "headers": null,
+ "hasAuth": true
+ },
+ "connector_type_id": ".webhook",
+ "is_preconfigured": false,
+ "is_deprecated": false,
+ "is_missing_secrets": false,
+ "is_system_action": false
+ }
+ },
+ "create_xmatters_connector_response": {
+ "summary": "A new xMatters connector.",
+ "value": {
+ "id": "4d2d8da0-4d1f-11ee-9367-577408be4681",
+ "name": "my-xmatters-connector",
+ "config": {
+ "usesBasic": false,
+ "configUrl": null
+ },
+ "connector_type_id": ".xmatters",
+ "is_preconfigured": false,
+ "is_deprecated": false,
+ "is_missing_secrets": false,
+ "is_system_action": false
+ }
+ },
+ "get_connector_response": {
+ "summary": "Get connector details.",
+ "value": {
+ "id": "df770e30-8b8b-11ed-a780-3b746c987a81",
+ "name": "my_server_log_connector",
+ "config": {},
+ "connector_type_id": ".server-log",
+ "is_preconfigured": false,
+ "is_deprecated": false,
+ "is_missing_secrets": false,
+ "is_system_action": false
+ }
+ },
+ "update_index_connector_request": {
+ "summary": "Update an index connector.",
+ "value": {
+ "name": "updated-connector",
+ "config": {
+ "index": "updated-index"
+ }
+ }
+ },
+ "get_connectors_response": {
+ "summary": "A list of connectors",
+ "value": [
+ {
+ "id": "preconfigured-email-connector",
+ "name": "my-preconfigured-email-notification",
+ "connector_type_id": ".email",
+ "is_preconfigured": true,
+ "is_deprecated": false,
+ "referenced_by_count": 0,
+ "is_system_action": false
+ },
+ {
+ "id": "e07d0c80-8b8b-11ed-a780-3b746c987a81",
+ "name": "my-index-connector",
+ "config": {
+ "index": "test-index",
+ "refresh": false,
+ "executionTimeField": null
+ },
+ "connector_type_id": ".index",
+ "is_preconfigured": false,
+ "is_deprecated": false,
+ "referenced_by_count": 2,
+ "is_missing_secrets": false,
+ "is_system_action": false
+ }
+ ]
+ },
+ "get_connector_types_generativeai_response": {
+ "summary": "A list of connector types for the `generativeAI` feature.",
+ "value": [
+ {
+ "id": ".gen-ai",
+ "name": "OpenAI",
+ "enabled": true,
+ "enabled_in_config": true,
+ "enabled_in_license": true,
+ "minimum_license_required": "enterprise",
+ "supported_feature_ids": [
+ "generativeAI"
+ ],
+ "is_system_action_type": false
+ },
+ {
+ "id": ".bedrock",
+ "name": "AWS Bedrock",
+ "enabled": true,
+ "enabled_in_config": true,
+ "enabled_in_license": true,
+ "minimum_license_required": "enterprise",
+ "supported_feature_ids": [
+ "generativeAI"
+ ],
+ "is_system_action_type": false
+ }
+ ]
+ }
+ },
+ "responses": {
+ "401": {
+ "description": "Authorization information is missing or invalid.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "Unauthorized response",
+ "properties": {
+ "error": {
+ "type": "string",
+ "example": "Unauthorized",
+ "enum": [
+ "Unauthorized"
+ ]
+ },
+ "message": {
+ "type": "string"
+ },
+ "statusCode": {
+ "type": "integer",
+ "example": 401,
+ "enum": [
+ 401
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Object is not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "Not found response",
+ "properties": {
+ "error": {
+ "type": "string",
+ "example": "Not Found",
+ "enum": [
+ "Not Found"
+ ]
+ },
+ "message": {
+ "type": "string",
+ "example": "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
+ },
+ "statusCode": {
+ "type": "integer",
+ "example": 404,
+ "enum": [
+ 404
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml
new file mode 100644
index 00000000000000..b66a820c1b77d7
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml
@@ -0,0 +1,2985 @@
+openapi: 3.0.1
+info:
+ title: Connectors
+ description: OpenAPI schema for connectors in Serverless projects
+ version: '0.1'
+ contact:
+ name: Connectors Team
+ license:
+ name: Elastic License 2.0
+ url: https://www.elastic.co/licensing/elastic-license
+servers:
+ - url: http://localhost:5601
+ description: local
+security:
+ - apiKeyAuth: []
+tags:
+ - name: connectors
+ description: Connector APIs enable you to create and manage connectors.
+paths:
+ /api/actions/connector:
+ post:
+ summary: Creates a connector.
+ operationId: createConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/create_connector_request'
+ examples:
+ createEmailConnectorRequest:
+ $ref: '#/components/examples/create_email_connector_request'
+ createIndexConnectorRequest:
+ $ref: '#/components/examples/create_index_connector_request'
+ createWebhookConnectorRequest:
+ $ref: '#/components/examples/create_webhook_connector_request'
+ createXmattersConnectorRequest:
+ $ref: '#/components/examples/create_xmatters_connector_request'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connector_response_properties'
+ examples:
+ createEmailConnectorResponse:
+ $ref: '#/components/examples/create_email_connector_response'
+ createIndexConnectorResponse:
+ $ref: '#/components/examples/create_index_connector_response'
+ createWebhookConnectorResponse:
+ $ref: '#/components/examples/create_webhook_connector_response'
+ createXmattersConnectorResponse:
+ $ref: '#/components/examples/create_xmatters_connector_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+ /api/actions/connector/{connectorId}:
+ get:
+ summary: Retrieves a connector by ID.
+ operationId: getConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/connector_id'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connector_response_properties'
+ examples:
+ getConnectorResponse:
+ $ref: '#/components/examples/get_connector_response'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ servers:
+ - url: https://localhost:5601
+ delete:
+ summary: Deletes a connector.
+ operationId: deleteConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ - $ref: '#/components/parameters/connector_id'
+ responses:
+ '204':
+ description: Indicates a successful call.
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ servers:
+ - url: https://localhost:5601
+ post:
+ summary: Creates a connector.
+ operationId: createConnectorId
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ - in: path
+ name: connectorId
+ description: |
+ A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated.
+ required: true
+ schema:
+ type: string
+ example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/create_connector_request'
+ examples:
+ createIndexConnectorRequest:
+ $ref: '#/components/examples/create_index_connector_request'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connector_response_properties'
+ examples:
+ createIndexConnectorResponse:
+ $ref: '#/components/examples/create_index_connector_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ put:
+ summary: Updates the attributes for a connector.
+ operationId: updateConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '#/components/parameters/kbn_xsrf'
+ - $ref: '#/components/parameters/connector_id'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/update_connector_request'
+ examples:
+ updateIndexConnectorRequest:
+ $ref: '#/components/examples/update_index_connector_request'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/connector_response_properties'
+ '400':
+ $ref: '#/components/responses/401'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+ /api/actions/connectors:
+ get:
+ summary: Retrieves all connectors.
+ operationId: getConnectors
+ tags:
+ - connectors
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/connector_response_properties'
+ examples:
+ getConnectorsResponse:
+ $ref: '#/components/examples/get_connectors_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+ /api/actions/connector_types:
+ get:
+ summary: Retrieves a list of all connector types.
+ operationId: getConnectorTypes
+ tags:
+ - connectors
+ parameters:
+ - in: query
+ name: feature_id
+ description: A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).
+ schema:
+ $ref: '#/components/schemas/features'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ title: Get connector types response body properties
+ description: The properties vary for each connector type.
+ type: array
+ items:
+ type: object
+ properties:
+ enabled:
+ type: boolean
+ description: Indicates whether the connector type is enabled in Kibana.
+ example: true
+ enabled_in_config:
+ type: boolean
+ description: Indicates whether the connector type is enabled in the Kibana configuration file.
+ example: true
+ enabled_in_license:
+ type: boolean
+ description: Indicates whether the connector is enabled in the license.
+ example: true
+ id:
+ $ref: '#/components/schemas/connector_types'
+ is_system_action_type:
+ type: boolean
+ example: false
+ minimum_license_required:
+ type: string
+ description: The license that is required to use the connector type.
+ example: basic
+ name:
+ type: string
+ description: The name of the connector type.
+ example: Index
+ supported_feature_ids:
+ type: array
+ description: The features that are supported by the connector type.
+ items:
+ $ref: '#/components/schemas/features'
+ example:
+ - alerting
+ - cases
+ - siem
+ examples:
+ getConnectorTypesServerlessResponse:
+ $ref: '#/components/examples/get_connector_types_generativeai_response'
+ '401':
+ $ref: '#/components/responses/401'
+ servers:
+ - url: https://localhost:5601
+ servers:
+ - url: https://localhost:5601
+components:
+ securitySchemes:
+ apiKeyAuth:
+ type: apiKey
+ in: header
+ name: ApiKey
+ parameters:
+ kbn_xsrf:
+ schema:
+ type: string
+ in: header
+ name: kbn-xsrf
+ description: Cross-site request forgery protection
+ required: true
+ connector_id:
+ in: path
+ name: connectorId
+ description: An identifier for the connector.
+ required: true
+ schema:
+ type: string
+ example: df770e30-8b8b-11ed-a780-3b746c987a81
+ schemas:
+ config_properties_bedrock:
+ title: Connector request properties for an Amazon Bedrock connector
+ description: Defines properties for connectors when type is `.bedrock`.
+ type: object
+ required:
+ - apiUrl
+ properties:
+ apiUrl:
+ type: string
+ description: The Amazon Bedrock request URL.
+ defaultModel:
+ type: string
+ description: |
+ The generative artificial intelligence model for Amazon Bedrock to use. Current support is for the Anthropic Claude models.
+ default: anthropic.claude-v2
+ secrets_properties_bedrock:
+ title: Connector secrets properties for an Amazon Bedrock connector
+ description: Defines secrets for connectors when type is `.bedrock`.
+ type: object
+ required:
+ - accessKey
+ - secret
+ properties:
+ accessKey:
+ type: string
+ description: The AWS access key for authentication.
+ secret:
+ type: string
+ description: The AWS secret for authentication.
+ create_connector_request_bedrock:
+ title: Create Amazon Bedrock connector request
+ description: The Amazon Bedrock connector uses axios to send a POST request to Amazon Bedrock.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_bedrock'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .bedrock
+ example: .bedrock
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_bedrock'
+ config_properties_cases_webhook:
+ title: Connector request properties for Webhook - Case Management connector
+ required:
+ - createIncidentJson
+ - createIncidentResponseKey
+ - createIncidentUrl
+ - getIncidentResponseExternalTitleKey
+ - getIncidentUrl
+ - updateIncidentJson
+ - updateIncidentUrl
+ - viewIncidentUrl
+ description: Defines properties for connectors when type is `.cases-webhook`.
+ type: object
+ properties:
+ createCommentJson:
+ type: string
+ description: |
+ 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 `case.comment`. Due to Mustache template variables (the text enclosed in triple braces, for example, `{{{case.title}}}`), 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.
+ example:
+ body:
+ '[object Object]': null
+ createCommentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to create a case comment in the third-party system. Valid values are `patch`, `post`, and `put`.
+ default: put
+ enum:
+ - patch
+ - post
+ - put
+ createCommentUrl:
+ type: string
+ description: |
+ 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 `xpack.actions.allowedHosts setting`, add the hostname to the allowed hosts.
+ example: https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.id}}}/comment
+ createIncidentJson:
+ type: string
+ description: |
+ 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 `case.title` and `case.description`. Due to Mustache template variables (which is the text enclosed in triple braces, for example, `{{{case.title}}}`), 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.
+ example:
+ fields:
+ summary:
+ '[object Object]': null
+ description:
+ '[object Object]': null
+ labels:
+ '[object Object]': null
+ createIncidentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to create a case in the third-party system. Valid values are `patch`, `post`, and `put`.
+ enum:
+ - patch
+ - post
+ - put
+ default: post
+ createIncidentResponseKey:
+ type: string
+ description: The JSON key in the create case response that contains the external case ID.
+ createIncidentUrl:
+ type: string
+ description: |
+ The REST API URL to create a case in the third-party system. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ getIncidentResponseExternalTitleKey:
+ type: string
+ description: The JSON key in get case response that contains the external case title.
+ getIncidentUrl:
+ type: string
+ description: |
+ The REST API URL to get the case by ID from the third-party system. If you are using the `xpack.actions.allowedHosts` 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, `{{{case.title}}}`), 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.
+ example: https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.id}}}
+ hasAuth:
+ type: boolean
+ description: If true, a username and password for login type authentication must be provided.
+ default: true
+ headers:
+ type: string
+ description: |
+ 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.
+ updateIncidentJson:
+ type: string
+ description: |
+ 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 `case.title` and `case.description`. Due to Mustache template variables (which is the text enclosed in triple braces, for example, `{{{case.title}}}`), 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.
+ example:
+ fields:
+ summary:
+ '[object Object]': null
+ description:
+ '[object Object]': null
+ labels:
+ '[object Object]': null
+ updateIncidentMethod:
+ type: string
+ description: |
+ The REST API HTTP request method to update the case in the third-party system. Valid values are `patch`, `post`, and `put`.
+ default: put
+ enum:
+ - patch
+ - post
+ - put
+ updateIncidentUrl:
+ type: string
+ description: |
+ 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 `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ example: https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.ID}}}
+ viewIncidentUrl:
+ type: string
+ description: |
+ 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.
+ example: https://testing-jira.atlassian.net/browse/{{{external.system.title}}}
+ secrets_properties_cases_webhook:
+ title: Connector secrets properties for Webhook - Case Management connector
+ type: object
+ properties:
+ password:
+ type: string
+ description: The password for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
+ user:
+ type: string
+ description: The username for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
+ create_connector_request_cases_webhook:
+ title: Create Webhook - Case Managment connector request
+ description: |
+ The Webhook - Case Management connector uses axios to send POST, PUT, and GET requests to a case management RESTful API web service.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_cases_webhook'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .cases-webhook
+ example: .cases-webhook
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_cases_webhook'
+ config_properties_d3security:
+ title: Connector request properties for a D3 Security connector
+ description: Defines properties for connectors when type is `.d3security`.
+ type: object
+ required:
+ - url
+ properties:
+ url:
+ type: string
+ description: |
+ The D3 Security API request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ secrets_properties_d3security:
+ title: Connector secrets properties for a D3 Security connector
+ description: Defines secrets for connectors when type is `.d3security`.
+ required:
+ - token
+ type: object
+ properties:
+ token:
+ type: string
+ description: The D3 Security token.
+ create_connector_request_d3security:
+ title: Create D3 Security connector request
+ description: |
+ The connector uses axios to send a POST request to a D3 Security endpoint.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_d3security'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .d3security
+ example: .d3security
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_d3security'
+ config_properties_email:
+ title: Connector request properties for an email connector
+ description: Defines properties for connectors when type is `.email`.
+ required:
+ - from
+ type: object
+ properties:
+ clientId:
+ description: |
+ The client identifier, which is a part of OAuth 2.0 client credentials authentication, in GUID format. If `service` is `exchange_server`, this property is required.
+ type: string
+ nullable: true
+ from:
+ description: |
+ The from address for all emails sent by the connector. It must be specified in `user@host-name` format.
+ type: string
+ hasAuth:
+ description: |
+ Specifies whether a user and password are required inside the secrets configuration.
+ default: true
+ type: boolean
+ host:
+ description: |
+ The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.
+ type: string
+ oauthTokenUrl:
+ type: string
+ nullable: true
+ port:
+ description: |
+ The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.
+ type: integer
+ secure:
+ description: |
+ Specifies whether the connection to the service provider will use TLS. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored.
+ type: boolean
+ service:
+ description: |
+ The name of the email service.
+ type: string
+ enum:
+ - elastic_cloud
+ - exchange_server
+ - gmail
+ - other
+ - outlook365
+ - ses
+ tenantId:
+ description: |
+ The tenant identifier, which is part of OAuth 2.0 client credentials authentication, in GUID format. If `service` is `exchange_server`, this property is required.
+ type: string
+ nullable: true
+ secrets_properties_email:
+ title: Connector secrets properties for an email connector
+ description: Defines secrets for connectors when type is `.email`.
+ type: object
+ properties:
+ clientSecret:
+ type: string
+ description: |
+ The Microsoft Exchange Client secret for OAuth 2.0 client credentials authentication. It must be URL-encoded. If `service` is `exchange_server`, this property is required.
+ password:
+ type: string
+ description: |
+ The password for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
+ user:
+ type: string
+ description: |
+ The username for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
+ create_connector_request_email:
+ title: Create email connector request
+ 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.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_email'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .email
+ example: .email
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_email'
+ config_properties_genai:
+ title: Connector request properties for an OpenAI connector
+ description: Defines properties for connectors when type is `.gen-ai`.
+ oneOf:
+ - type: object
+ required:
+ - apiProvider
+ - apiUrl
+ properties:
+ apiProvider:
+ type: string
+ description: The OpenAI API provider.
+ enum:
+ - Azure OpenAI
+ apiUrl:
+ type: string
+ description: The OpenAI API endpoint.
+ - type: object
+ required:
+ - apiProvider
+ - apiUrl
+ properties:
+ apiProvider:
+ type: string
+ description: The OpenAI API provider.
+ enum:
+ - OpenAI
+ apiUrl:
+ type: string
+ description: The OpenAI API endpoint.
+ defaultModel:
+ type: string
+ description: The default model to use for requests.
+ discriminator:
+ propertyName: apiProvider
+ secrets_properties_genai:
+ title: Connector secrets properties for an OpenAI connector
+ description: Defines secrets for connectors when type is `.gen-ai`.
+ type: object
+ properties:
+ apiKey:
+ type: string
+ description: The OpenAI API key.
+ create_connector_request_genai:
+ title: Create OpenAI connector request
+ description: |
+ The OpenAI connector uses axios to send a POST request to either OpenAI or Azure OpenAPI.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_genai'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .gen-ai
+ example: .gen-ai
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_genai'
+ config_properties_index:
+ title: Connector request properties for an index connector
+ required:
+ - index
+ description: Defines properties for connectors when type is `.index`.
+ type: object
+ properties:
+ executionTimeField:
+ description: A field that indicates when the document was indexed.
+ default: null
+ type: string
+ nullable: true
+ index:
+ description: The Elasticsearch index to be written to.
+ type: string
+ refresh:
+ description: |
+ 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.
+ default: false
+ type: boolean
+ create_connector_request_index:
+ title: Create index connector request
+ description: The index connector indexes a document into Elasticsearch.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_index'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .index
+ example: .index
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ config_properties_jira:
+ title: Connector request properties for a Jira connector
+ required:
+ - apiUrl
+ - projectKey
+ description: Defines properties for connectors when type is `.jira`.
+ type: object
+ properties:
+ apiUrl:
+ description: The Jira instance URL.
+ type: string
+ projectKey:
+ description: The Jira project key.
+ type: string
+ secrets_properties_jira:
+ title: Connector secrets properties for a Jira connector
+ required:
+ - apiToken
+ - email
+ description: Defines secrets for connectors when type is `.jira`.
+ type: object
+ properties:
+ apiToken:
+ description: The Jira API authentication token for HTTP basic authentication.
+ type: string
+ email:
+ description: The account email for HTTP Basic authentication.
+ type: string
+ create_connector_request_jira:
+ title: Create Jira connector request
+ description: The Jira connector uses the REST API v2 to create Jira issues.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_jira'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .jira
+ example: .jira
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_jira'
+ config_properties_opsgenie:
+ title: Connector request properties for an Opsgenie connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.opsgenie`.
+ type: object
+ properties:
+ apiUrl:
+ description: |
+ The Opsgenie URL. For example, `https://api.opsgenie.com` or `https://api.eu.opsgenie.com`. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ type: string
+ secrets_properties_opsgenie:
+ title: Connector secrets properties for an Opsgenie connector
+ required:
+ - apiKey
+ description: Defines secrets for connectors when type is `.opsgenie`.
+ type: object
+ properties:
+ apiKey:
+ description: The Opsgenie API authentication key for HTTP Basic authentication.
+ type: string
+ create_connector_request_opsgenie:
+ title: Create Opsgenie connector request
+ description: The Opsgenie connector uses the Opsgenie alert API.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_opsgenie'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .opsgenie
+ example: .opsgenie
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_opsgenie'
+ config_properties_pagerduty:
+ title: Connector request properties for a PagerDuty connector
+ description: Defines properties for connectors when type is `.pagerduty`.
+ type: object
+ properties:
+ apiUrl:
+ description: The PagerDuty event URL.
+ type: string
+ nullable: true
+ example: https://events.pagerduty.com/v2/enqueue
+ secrets_properties_pagerduty:
+ title: Connector secrets properties for a PagerDuty connector
+ description: Defines secrets for connectors when type is `.pagerduty`.
+ type: object
+ required:
+ - routingKey
+ properties:
+ routingKey:
+ description: |
+ A 32 character PagerDuty Integration Key for an integration on a service.
+ type: string
+ create_connector_request_pagerduty:
+ title: Create PagerDuty connector request
+ description: |
+ The PagerDuty connector uses the v2 Events API to trigger, acknowledge, and resolve PagerDuty alerts.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_pagerduty'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .pagerduty
+ example: .pagerduty
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_pagerduty'
+ config_properties_resilient:
+ title: Connector request properties for a IBM Resilient connector
+ required:
+ - apiUrl
+ - orgId
+ description: Defines properties for connectors when type is `.resilient`.
+ type: object
+ properties:
+ apiUrl:
+ description: The IBM Resilient instance URL.
+ type: string
+ orgId:
+ description: The IBM Resilient organization ID.
+ type: string
+ secrets_properties_resilient:
+ title: Connector secrets properties for IBM Resilient connector
+ required:
+ - apiKeyId
+ - apiKeySecret
+ description: Defines secrets for connectors when type is `.resilient`.
+ type: object
+ properties:
+ apiKeyId:
+ type: string
+ description: The authentication key ID for HTTP Basic authentication.
+ apiKeySecret:
+ type: string
+ description: The authentication key secret for HTTP Basic authentication.
+ create_connector_request_resilient:
+ title: Create IBM Resilient connector request
+ description: The IBM Resilient connector uses the RESILIENT REST v2 to create IBM Resilient incidents.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_resilient'
+ connector_type_id:
+ description: The type of connector.
+ type: string
+ example: .resilient
+ enum:
+ - .resilient
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_resilient'
+ create_connector_request_serverlog:
+ title: Create server log connector request
+ description: This connector writes an entry to the Kibana server log.
+ type: object
+ required:
+ - connector_type_id
+ - name
+ properties:
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .server-log
+ example: .server-log
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ config_properties_servicenow:
+ title: Connector request properties for a ServiceNow ITSM connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.servicenow`.
+ type: object
+ properties:
+ apiUrl:
+ type: string
+ description: The ServiceNow instance URL.
+ clientId:
+ description: |
+ The client ID assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ isOAuth:
+ description: |
+ The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).
+ default: false
+ type: boolean
+ jwtKeyId:
+ description: |
+ The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ userIdentifierValue:
+ description: |
+ 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 `Email`, the user identifier should be the user's email address. This property is required when `isOAuth` is `true`.
+ type: string
+ usesTableApi:
+ description: |
+ 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 `false`, the Elastic application should be installed in ServiceNow.
+ default: true
+ type: boolean
+ secrets_properties_servicenow:
+ title: Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors
+ description: Defines secrets for connectors when type is `.servicenow`, `.servicenow-sir`, or `.servicenow-itom`.
+ type: object
+ properties:
+ clientSecret:
+ type: string
+ description: The client secret assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ password:
+ type: string
+ description: The password for HTTP basic authentication. This property is required when `isOAuth` is `false`.
+ privateKey:
+ type: string
+ description: The RSA private key that you created for use in ServiceNow. This property is required when `isOAuth` is `true`.
+ privateKeyPassword:
+ type: string
+ description: The password for the RSA private key. This property is required when `isOAuth` is `true` and you set a password on your private key.
+ username:
+ type: string
+ description: The username for HTTP basic authentication. This property is required when `isOAuth` is `false`.
+ create_connector_request_servicenow:
+ title: Create ServiceNow ITSM connector request
+ description: |
+ The ServiceNow ITSM connector uses the import set API to create ServiceNow incidents. You can use the connector for rule actions and cases.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_servicenow'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .servicenow
+ example: .servicenow
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_servicenow'
+ config_properties_servicenow_itom:
+ title: Connector request properties for a ServiceNow ITSM connector
+ required:
+ - apiUrl
+ description: Defines properties for connectors when type is `.servicenow`.
+ type: object
+ properties:
+ apiUrl:
+ type: string
+ description: The ServiceNow instance URL.
+ clientId:
+ description: |
+ The client ID assigned to your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ isOAuth:
+ description: |
+ The type of authentication to use. The default value is false, which means basic authentication is used instead of open authorization (OAuth).
+ default: false
+ type: boolean
+ jwtKeyId:
+ description: |
+ The key identifier assigned to the JWT verifier map of your OAuth application. This property is required when `isOAuth` is `true`.
+ type: string
+ userIdentifierValue:
+ description: |
+ 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 `Email`, the user identifier should be the user's email address. This property is required when `isOAuth` is `true`.
+ type: string
+ create_connector_request_servicenow_itom:
+ title: Create ServiceNow ITOM connector request
+ description: |
+ The ServiceNow ITOM connector uses the event API to create ServiceNow events. You can use the connector for rule actions.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_servicenow_itom'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .servicenow-itom
+ example: .servicenow-itom
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_servicenow'
+ create_connector_request_servicenow_sir:
+ title: Create ServiceNow SecOps connector request
+ 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.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_servicenow'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .servicenow-sir
+ example: .servicenow-sir
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_servicenow'
+ secrets_properties_slack_api:
+ title: Connector secrets properties for a Web API Slack connector
+ description: Defines secrets for connectors when type is `.slack`.
+ required:
+ - token
+ type: object
+ properties:
+ token:
+ type: string
+ description: Slack bot user OAuth token.
+ create_connector_request_slack_api:
+ title: Create Slack connector request
+ description: The Slack connector uses Slack Incoming Webhooks.
+ type: object
+ required:
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .slack_api
+ example: .slack_api
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_slack_api'
+ secrets_properties_slack_webhook:
+ title: Connector secrets properties for a Webhook Slack connector
+ description: Defines secrets for connectors when type is `.slack`.
+ required:
+ - webhookUrl
+ type: object
+ properties:
+ webhookUrl:
+ type: string
+ description: Slack webhook url.
+ create_connector_request_slack_webhook:
+ title: Create Slack connector request
+ description: The Slack connector uses Slack Incoming Webhooks.
+ type: object
+ required:
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .slack
+ example: .slack
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_slack_webhook'
+ config_properties_swimlane:
+ title: Connector request properties for a Swimlane connector
+ required:
+ - apiUrl
+ - appId
+ - connectorType
+ description: Defines properties for connectors when type is `.swimlane`.
+ type: object
+ properties:
+ apiUrl:
+ description: The Swimlane instance URL.
+ type: string
+ appId:
+ description: The Swimlane application ID.
+ type: string
+ connectorType:
+ description: The type of connector. Valid values are `all`, `alerts`, and `cases`.
+ type: string
+ enum:
+ - all
+ - alerts
+ - cases
+ mappings:
+ title: Connector mappings properties for a Swimlane connector
+ description: The field mapping.
+ type: object
+ properties:
+ alertIdConfig:
+ title: Alert identifier mapping
+ description: Mapping for the alert ID.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ caseIdConfig:
+ title: Case identifier mapping
+ description: Mapping for the case ID.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ caseNameConfig:
+ title: Case name mapping
+ description: Mapping for the case name.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ commentsConfig:
+ title: Case comment mapping
+ description: Mapping for the case comments.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ descriptionConfig:
+ title: Case description mapping
+ description: Mapping for the case description.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ ruleNameConfig:
+ title: Rule name mapping
+ description: Mapping for the name of the alert's rule.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ severityConfig:
+ title: Severity mapping
+ description: Mapping for the severity.
+ type: object
+ required:
+ - fieldType
+ - id
+ - key
+ - name
+ properties:
+ fieldType:
+ type: string
+ description: The type of field in Swimlane.
+ id:
+ type: string
+ description: The identifier for the field in Swimlane.
+ key:
+ type: string
+ description: The key for the field in Swimlane.
+ name:
+ type: string
+ description: The name of the field in Swimlane.
+ secrets_properties_swimlane:
+ title: Connector secrets properties for a Swimlane connector
+ description: Defines secrets for connectors when type is `.swimlane`.
+ type: object
+ properties:
+ apiToken:
+ description: Swimlane API authentication token.
+ type: string
+ create_connector_request_swimlane:
+ title: Create Swimlane connector request
+ description: The Swimlane connector uses the Swimlane REST API to create Swimlane records.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_swimlane'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .swimlane
+ example: .swimlane
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_swimlane'
+ secrets_properties_teams:
+ title: Connector secrets properties for a Microsoft Teams connector
+ description: Defines secrets for connectors when type is `.teams`.
+ type: object
+ required:
+ - webhookUrl
+ properties:
+ webhookUrl:
+ type: string
+ description: |
+ The URL of the incoming webhook. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ create_connector_request_teams:
+ title: Create Microsoft Teams connector request
+ description: The Microsoft Teams connector uses Incoming Webhooks.
+ type: object
+ required:
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .teams
+ example: .teams
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_teams'
+ config_properties_tines:
+ title: Connector request properties for a Tines connector
+ description: Defines properties for connectors when type is `.tines`.
+ type: object
+ required:
+ - url
+ properties:
+ url:
+ description: |
+ The Tines tenant URL. If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.
+ type: string
+ secrets_properties_tines:
+ title: Connector secrets properties for a Tines connector
+ description: Defines secrets for connectors when type is `.tines`.
+ type: object
+ required:
+ - email
+ - token
+ properties:
+ email:
+ description: The email used to sign in to Tines.
+ type: string
+ token:
+ description: The Tines API token.
+ type: string
+ create_connector_request_tines:
+ title: Create Tines connector request
+ description: |
+ The Tines connector uses Tines Webhook actions to send events via POST request.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_tines'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .tines
+ example: .tines
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_tines'
+ config_properties_torq:
+ title: Connector request properties for a Torq connector
+ description: Defines properties for connectors when type is `.torq`.
+ type: object
+ required:
+ - webhookIntegrationUrl
+ properties:
+ webhookIntegrationUrl:
+ description: The endpoint URL of the Elastic Security integration in Torq.
+ type: string
+ secrets_properties_torq:
+ title: Connector secrets properties for a Torq connector
+ description: Defines secrets for connectors when type is `.torq`.
+ type: object
+ required:
+ - token
+ properties:
+ token:
+ description: The secret of the webhook authentication header.
+ type: string
+ create_connector_request_torq:
+ title: Create Torq connector request
+ description: |
+ The Torq connector uses a Torq webhook to trigger workflows with Kibana actions.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_torq'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .torq
+ example: .torq
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_torq'
+ config_properties_webhook:
+ title: Connector request properties for a Webhook connector
+ description: Defines properties for connectors when type is `.webhook`.
+ type: object
+ properties:
+ authType:
+ type: string
+ enum:
+ - webhook-authentication-basic
+ - webhook-authentication-ssl
+ - 'null'
+ description: |
+ The type of authentication to use: basic, SSL, or none.
+ ca:
+ type: string
+ description: |
+ 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.
+ certType:
+ type: string
+ description: |
+ If the `authType` is `webhook-authentication-ssl`, specifies whether the certificate authentication data is in a CRT and key file format or a PFX file format.
+ enum:
+ - ssl-crt-key
+ - ssl-pfx
+ hasAuth:
+ type: boolean
+ description: |
+ If `true`, a user name and password must be provided for login type authentication.
+ headers:
+ type: object
+ nullable: true
+ description: A set of key-value pairs sent as headers with the request.
+ method:
+ type: string
+ default: post
+ enum:
+ - post
+ - put
+ description: |
+ The HTTP request method, either `post` or `put`.
+ url:
+ type: string
+ description: |
+ The request URL. If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
+ verificationMode:
+ type: string
+ enum:
+ - certificate
+ - full
+ - none
+ default: full
+ description: |
+ Controls the verification of certificates. Use `full` to validate that the certificate has an issue date within the `not_before` and `not_after` dates, chains to a trusted certificate authority (CA), and has a hostname or IP address that matches the names within the certificate. Use `certificate` to validate the certificate and verify that it is signed by a trusted authority; this option does not check the certificate hostname. Use `none` to skip certificate validation.
+ secrets_properties_webhook:
+ title: Connector secrets properties for a Webhook connector
+ description: Defines secrets for connectors when type is `.webhook`.
+ type: object
+ properties:
+ crt:
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-crt-key`, it is a base64 encoded version of the CRT or CERT file.
+ key:
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-crt-key`, it is a base64 encoded version of the KEY file.
+ pfx:
+ type: string
+ description: If `authType` is `webhook-authentication-ssl` and `certType` is `ssl-pfx`, it is a base64 encoded version of the PFX or P12 file.
+ password:
+ type: string
+ description: |
+ The password for HTTP basic authentication or the passphrase for the SSL certificate files. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.
+ user:
+ type: string
+ description: |
+ The username for HTTP basic authentication. If `hasAuth` is set to `true` and `authType` is `webhook-authentication-basic`, this property is required.
+ create_connector_request_webhook:
+ title: Create Webhook connector request
+ description: |
+ The Webhook connector uses axios to send a POST or PUT request to a web service.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_webhook'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .webhook
+ example: .webhook
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_webhook'
+ config_properties_xmatters:
+ title: Connector request properties for an xMatters connector
+ description: Defines properties for connectors when type is `.xmatters`.
+ type: object
+ properties:
+ configUrl:
+ description: |
+ The request URL for the Elastic Alerts trigger in xMatters. It is applicable only when `usesBasic` is `true`.
+ type: string
+ nullable: true
+ usesBasic:
+ description: Specifies whether the connector uses HTTP basic authentication (`true`) or URL authentication (`false`).
+ type: boolean
+ default: true
+ secrets_properties_xmatters:
+ title: Connector secrets properties for an xMatters connector
+ description: Defines secrets for connectors when type is `.xmatters`.
+ type: object
+ properties:
+ password:
+ description: |
+ A user name for HTTP basic authentication. It is applicable only when `usesBasic` is `true`.
+ type: string
+ secretsUrl:
+ description: |
+ The request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL. It is applicable only when `usesBasic` is `false`.
+ type: string
+ user:
+ description: |
+ A password for HTTP basic authentication. It is applicable only when `usesBasic` is `true`.
+ type: string
+ create_connector_request_xmatters:
+ title: Create xMatters connector request
+ description: |
+ The xMatters connector uses the xMatters Workflow for Elastic to send actionable alerts to on-call xMatters resources.
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_xmatters'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .xmatters
+ example: .xmatters
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_xmatters'
+ create_connector_request:
+ title: Create connector request body properties
+ description: The properties vary depending on the connector type.
+ oneOf:
+ - $ref: '#/components/schemas/create_connector_request_bedrock'
+ - $ref: '#/components/schemas/create_connector_request_cases_webhook'
+ - $ref: '#/components/schemas/create_connector_request_d3security'
+ - $ref: '#/components/schemas/create_connector_request_email'
+ - $ref: '#/components/schemas/create_connector_request_genai'
+ - $ref: '#/components/schemas/create_connector_request_index'
+ - $ref: '#/components/schemas/create_connector_request_jira'
+ - $ref: '#/components/schemas/create_connector_request_opsgenie'
+ - $ref: '#/components/schemas/create_connector_request_pagerduty'
+ - $ref: '#/components/schemas/create_connector_request_resilient'
+ - $ref: '#/components/schemas/create_connector_request_serverlog'
+ - $ref: '#/components/schemas/create_connector_request_servicenow'
+ - $ref: '#/components/schemas/create_connector_request_servicenow_itom'
+ - $ref: '#/components/schemas/create_connector_request_servicenow_sir'
+ - $ref: '#/components/schemas/create_connector_request_slack_api'
+ - $ref: '#/components/schemas/create_connector_request_slack_webhook'
+ - $ref: '#/components/schemas/create_connector_request_swimlane'
+ - $ref: '#/components/schemas/create_connector_request_teams'
+ - $ref: '#/components/schemas/create_connector_request_tines'
+ - $ref: '#/components/schemas/create_connector_request_torq'
+ - $ref: '#/components/schemas/create_connector_request_webhook'
+ - $ref: '#/components/schemas/create_connector_request_xmatters'
+ discriminator:
+ propertyName: connector_type_id
+ is_deprecated:
+ type: boolean
+ description: Indicates whether the connector type is deprecated.
+ example: false
+ is_missing_secrets:
+ type: boolean
+ description: Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
+ example: false
+ is_preconfigured:
+ type: boolean
+ description: |
+ Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.
+ example: false
+ is_system_action:
+ type: boolean
+ description: Indicates whether the connector is used for system actions.
+ example: false
+ connector_response_properties_bedrock:
+ title: Connector response properties for an Amazon Bedrock connector
+ type: object
+ required:
+ - config
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_bedrock'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .bedrock
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ type: integer
+ description: |
+ Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated. This property is returned only by the get all connectors API.
+ example: 2
+ connector_response_properties_cases_webhook:
+ title: Connector request properties for a Webhook - Case Management connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_cases_webhook'
+ connector_type_id:
+ description: The type of connector.
+ type: string
+ enum:
+ - .cases-webhook
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_d3security:
+ title: Connector response properties for a D3 Security connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_d3security'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .d3security
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_email:
+ title: Connector response properties for an email connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_email'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .email
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_index:
+ title: Connector response properties for an index connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_index'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .index
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_jira:
+ title: Connector response properties for a Jira connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_jira'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .jira
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_opsgenie:
+ title: Connector response properties for an Opsgenie connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_opsgenie'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .opsgenie
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_pagerduty:
+ title: Connector response properties for a PagerDuty connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_pagerduty'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .pagerduty
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_resilient:
+ title: Connector response properties for a IBM Resilient connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_resilient'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .resilient
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_serverlog:
+ title: Connector response properties for a server log connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ type: object
+ nullable: true
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .server-log
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_servicenow:
+ title: Connector response properties for a ServiceNow ITSM connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_servicenow'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .servicenow
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_servicenow_itom:
+ title: Connector response properties for a ServiceNow ITOM connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_servicenow_itom'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .servicenow-itom
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_servicenow_sir:
+ title: Connector response properties for a ServiceNow SecOps connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_servicenow'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .servicenow-sir
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_slack_api:
+ title: Connector response properties for a Slack connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .slack_api
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_slack_webhook:
+ title: Connector response properties for a Slack connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .slack
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_swimlane:
+ title: Connector response properties for a Swimlane connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_swimlane'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .swimlane
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_teams:
+ title: Connector response properties for a Microsoft Teams connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ type: object
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .teams
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_tines:
+ title: Connector response properties for a Tines connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_tines'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .tines
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_torq:
+ title: Connector response properties for a Torq connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_torq'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .torq
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_webhook:
+ title: Connector response properties for a Webhook connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_webhook'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .webhook
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties_xmatters:
+ title: Connector response properties for an xMatters connector
+ type: object
+ required:
+ - connector_type_id
+ - id
+ - is_deprecated
+ - is_preconfigured
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_xmatters'
+ connector_type_id:
+ type: string
+ description: The type of connector.
+ enum:
+ - .xmatters
+ id:
+ type: string
+ description: The identifier for the connector.
+ is_deprecated:
+ $ref: '#/components/schemas/is_deprecated'
+ is_missing_secrets:
+ $ref: '#/components/schemas/is_missing_secrets'
+ is_preconfigured:
+ $ref: '#/components/schemas/is_preconfigured'
+ is_system_action:
+ $ref: '#/components/schemas/is_system_action'
+ name:
+ type: string
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: '#/components/schemas/referenced_by_count'
+ connector_response_properties:
+ title: Connector response properties
+ description: The properties vary depending on the connector type.
+ oneOf:
+ - $ref: '#/components/schemas/connector_response_properties_bedrock'
+ - $ref: '#/components/schemas/connector_response_properties_cases_webhook'
+ - $ref: '#/components/schemas/connector_response_properties_d3security'
+ - $ref: '#/components/schemas/connector_response_properties_email'
+ - $ref: '#/components/schemas/connector_response_properties_index'
+ - $ref: '#/components/schemas/connector_response_properties_jira'
+ - $ref: '#/components/schemas/connector_response_properties_opsgenie'
+ - $ref: '#/components/schemas/connector_response_properties_pagerduty'
+ - $ref: '#/components/schemas/connector_response_properties_resilient'
+ - $ref: '#/components/schemas/connector_response_properties_serverlog'
+ - $ref: '#/components/schemas/connector_response_properties_servicenow'
+ - $ref: '#/components/schemas/connector_response_properties_servicenow_itom'
+ - $ref: '#/components/schemas/connector_response_properties_servicenow_sir'
+ - $ref: '#/components/schemas/connector_response_properties_slack_api'
+ - $ref: '#/components/schemas/connector_response_properties_slack_webhook'
+ - $ref: '#/components/schemas/connector_response_properties_swimlane'
+ - $ref: '#/components/schemas/connector_response_properties_teams'
+ - $ref: '#/components/schemas/connector_response_properties_tines'
+ - $ref: '#/components/schemas/connector_response_properties_torq'
+ - $ref: '#/components/schemas/connector_response_properties_webhook'
+ - $ref: '#/components/schemas/connector_response_properties_xmatters'
+ discriminator:
+ propertyName: connector_type_id
+ update_connector_request_bedrock:
+ title: Update Amazon Bedrock connector request
+ type: object
+ required:
+ - config
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_bedrock'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_bedrock'
+ update_connector_request_cases_webhook:
+ title: Update Webhook - Case Managment connector request
+ type: object
+ required:
+ - config
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_cases_webhook'
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_cases_webhook'
+ update_connector_request_d3security:
+ title: Update D3 Security connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_d3security'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_d3security'
+ update_connector_request_email:
+ title: Update email connector request
+ type: object
+ required:
+ - config
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_email'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_email'
+ update_connector_request_index:
+ title: Update index connector request
+ type: object
+ required:
+ - config
+ - name
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_index'
+ name:
+ type: string
+ description: The display name for the connector.
+ update_connector_request_jira:
+ title: Update Jira connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_jira'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_jira'
+ update_connector_request_opsgenie:
+ title: Update Opsgenie connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_opsgenie'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_opsgenie'
+ update_connector_request_pagerduty:
+ title: Update PagerDuty connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_pagerduty'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_pagerduty'
+ update_connector_request_resilient:
+ title: Update IBM Resilient connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_resilient'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_resilient'
+ update_connector_request_serverlog:
+ title: Update server log connector request
+ type: object
+ required:
+ - name
+ properties:
+ name:
+ type: string
+ description: The display name for the connector.
+ update_connector_request_servicenow:
+ title: Update ServiceNow ITSM connector or ServiceNow SecOps request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_servicenow'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_servicenow'
+ update_connector_request_servicenow_itom:
+ title: Create ServiceNow ITOM connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_servicenow_itom'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_servicenow'
+ update_connector_request_slack_api:
+ title: Update Slack connector request
+ type: object
+ required:
+ - name
+ - secrets
+ properties:
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_slack_api'
+ update_connector_request_slack_webhook:
+ title: Update Slack connector request
+ type: object
+ required:
+ - name
+ - secrets
+ properties:
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_slack_webhook'
+ update_connector_request_swimlane:
+ title: Update Swimlane connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_swimlane'
+ name:
+ type: string
+ description: The display name for the connector.
+ example: my-connector
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_swimlane'
+ update_connector_request_teams:
+ title: Update Microsoft Teams connector request
+ type: object
+ required:
+ - name
+ - secrets
+ properties:
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_teams'
+ update_connector_request_tines:
+ title: Update Tines connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_tines'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_tines'
+ update_connector_request_torq:
+ title: Update Torq connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_torq'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_torq'
+ update_connector_request_webhook:
+ title: Update Webhook connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_webhook'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_webhook'
+ update_connector_request_xmatters:
+ title: Update xMatters connector request
+ type: object
+ required:
+ - config
+ - name
+ - secrets
+ properties:
+ config:
+ $ref: '#/components/schemas/config_properties_xmatters'
+ name:
+ type: string
+ description: The display name for the connector.
+ secrets:
+ $ref: '#/components/schemas/secrets_properties_xmatters'
+ update_connector_request:
+ title: Update connector request body properties
+ description: The properties vary depending on the connector type.
+ oneOf:
+ - $ref: '#/components/schemas/update_connector_request_bedrock'
+ - $ref: '#/components/schemas/update_connector_request_cases_webhook'
+ - $ref: '#/components/schemas/update_connector_request_d3security'
+ - $ref: '#/components/schemas/update_connector_request_email'
+ - $ref: '#/components/schemas/create_connector_request_genai'
+ - $ref: '#/components/schemas/update_connector_request_index'
+ - $ref: '#/components/schemas/update_connector_request_jira'
+ - $ref: '#/components/schemas/update_connector_request_opsgenie'
+ - $ref: '#/components/schemas/update_connector_request_pagerduty'
+ - $ref: '#/components/schemas/update_connector_request_resilient'
+ - $ref: '#/components/schemas/update_connector_request_serverlog'
+ - $ref: '#/components/schemas/update_connector_request_servicenow'
+ - $ref: '#/components/schemas/update_connector_request_servicenow_itom'
+ - $ref: '#/components/schemas/update_connector_request_slack_api'
+ - $ref: '#/components/schemas/update_connector_request_slack_webhook'
+ - $ref: '#/components/schemas/update_connector_request_swimlane'
+ - $ref: '#/components/schemas/update_connector_request_teams'
+ - $ref: '#/components/schemas/update_connector_request_tines'
+ - $ref: '#/components/schemas/update_connector_request_torq'
+ - $ref: '#/components/schemas/update_connector_request_webhook'
+ - $ref: '#/components/schemas/update_connector_request_xmatters'
+ features:
+ type: string
+ description: |
+ The feature that uses the connector.
+ enum:
+ - alerting
+ - cases
+ - generativeAI
+ - siem
+ - uptime
+ connector_types:
+ title: Connector types
+ type: string
+ description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.
+ enum:
+ - .bedrock
+ - .cases-webhook
+ - .d3security
+ - .email
+ - .gen-ai
+ - .index
+ - .jira
+ - .opsgenie
+ - .pagerduty
+ - .resilient
+ - .servicenow
+ - .servicenow-itom
+ - .servicenow-sir
+ - .server-log
+ - .slack
+ - .slack_api
+ - .swimlane
+ - .teams
+ - .tines
+ - .torq
+ - .webhook
+ - .xmatters
+ example: .server-log
+ examples:
+ create_email_connector_request:
+ summary: Create an email connector.
+ value:
+ name: email-connector-1
+ connector_type_id: .email
+ config:
+ from: tester@example.com
+ hasAuth: true
+ host: https://example.com
+ port: 1025
+ secure: false
+ service: other
+ secrets:
+ user: username
+ password: password
+ create_index_connector_request:
+ summary: Create an index connector.
+ value:
+ name: my-connector
+ connector_type_id: .index
+ config:
+ index: test-index
+ create_webhook_connector_request:
+ summary: Create a webhook connector with SSL authentication.
+ value:
+ name: my-webhook-connector
+ connector_type_id: .webhook
+ config:
+ method: post
+ url: https://example.com
+ authType: webhook-authentication-ssl
+ certType: ssl-crt-key
+ secrets:
+ crt: QmFnIEF0dH...
+ key: LS0tLS1CRUdJ...
+ password: my-passphrase
+ create_xmatters_connector_request:
+ summary: Create an xMatters connector with URL authentication.
+ value:
+ name: my-xmatters-connector
+ connector_type_id: .xmatters
+ config:
+ usesBasic: false
+ secrets:
+ secretsUrl: https://example.com?apiKey=xxxxx
+ create_email_connector_response:
+ summary: A new email connector.
+ value:
+ id: 90a82c60-478f-11ee-a343-f98a117c727f
+ connector_type_id: .email
+ name: email-connector-1
+ config:
+ from: tester@example.com
+ service: other
+ host: https://example.com
+ port: 1025
+ secure: false
+ hasAuth: true
+ tenantId: null
+ clientId: null
+ oauthTokenUrl: null
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ create_index_connector_response:
+ summary: A new index connector.
+ value:
+ id: c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
+ connector_type_id: .index
+ name: my-connector
+ config:
+ index: test-index
+ refresh: false
+ executionTimeField: null
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ create_webhook_connector_response:
+ summary: A new webhook connector.
+ value:
+ id: 900eb010-3b9d-11ee-a642-8ffbb94e38bd
+ name: my-webhook-connector
+ config:
+ method: post
+ url: https://example.com
+ authType: webhook-authentication-ssl
+ certType: ssl-crt-key
+ verificationMode: full
+ headers: null
+ hasAuth: true
+ connector_type_id: .webhook
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ create_xmatters_connector_response:
+ summary: A new xMatters connector.
+ value:
+ id: 4d2d8da0-4d1f-11ee-9367-577408be4681
+ name: my-xmatters-connector
+ config:
+ usesBasic: false
+ configUrl: null
+ connector_type_id: .xmatters
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ get_connector_response:
+ summary: Get connector details.
+ value:
+ id: df770e30-8b8b-11ed-a780-3b746c987a81
+ name: my_server_log_connector
+ config: {}
+ connector_type_id: .server-log
+ is_preconfigured: false
+ is_deprecated: false
+ is_missing_secrets: false
+ is_system_action: false
+ update_index_connector_request:
+ summary: Update an index connector.
+ value:
+ name: updated-connector
+ config:
+ index: updated-index
+ get_connectors_response:
+ summary: A list of connectors
+ value:
+ - id: preconfigured-email-connector
+ name: my-preconfigured-email-notification
+ connector_type_id: .email
+ is_preconfigured: true
+ is_deprecated: false
+ referenced_by_count: 0
+ is_system_action: false
+ - id: e07d0c80-8b8b-11ed-a780-3b746c987a81
+ name: my-index-connector
+ config:
+ index: test-index
+ refresh: false
+ executionTimeField: null
+ connector_type_id: .index
+ is_preconfigured: false
+ is_deprecated: false
+ referenced_by_count: 2
+ is_missing_secrets: false
+ is_system_action: false
+ get_connector_types_generativeai_response:
+ summary: A list of connector types for the `generativeAI` feature.
+ value:
+ - id: .gen-ai
+ name: OpenAI
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAI
+ is_system_action_type: false
+ - id: .bedrock
+ name: AWS Bedrock
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAI
+ is_system_action_type: false
+ responses:
+ '401':
+ description: Authorization information is missing or invalid.
+ content:
+ application/json:
+ schema:
+ type: object
+ title: Unauthorized response
+ properties:
+ error:
+ type: string
+ example: Unauthorized
+ enum:
+ - Unauthorized
+ message:
+ type: string
+ statusCode:
+ type: integer
+ example: 401
+ enum:
+ - 401
+ '404':
+ description: Object is not found.
+ content:
+ application/json:
+ schema:
+ type: object
+ title: Not found response
+ properties:
+ error:
+ type: string
+ example: Not Found
+ enum:
+ - Not Found
+ message:
+ type: string
+ example: Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found
+ statusCode:
+ type: integer
+ example: 404
+ enum:
+ - 404
diff --git a/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_response.yaml b/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_response.yaml
index 6de6a030140e6b..0c5ff80fe58842 100644
--- a/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_response.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_response.yaml
@@ -1,4 +1,4 @@
-summary: A list of connector types
+summary: Get connector details.
value:
id: df770e30-8b8b-11ed-a780-3b746c987a81
name: my_server_log_connector
diff --git a/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_types_generativeai_response.yaml b/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_types_generativeai_response.yaml
new file mode 100644
index 00000000000000..96eff6e72f2473
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_types_generativeai_response.yaml
@@ -0,0 +1,20 @@
+summary: A list of connector types for the `generativeAI` feature.
+value:
+ - id: .gen-ai
+ name: OpenAI
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAI
+ is_system_action_type: false
+ - id: .bedrock
+ name: AWS Bedrock
+ enabled: true
+ enabled_in_config: true
+ enabled_in_license: true
+ minimum_license_required: enterprise
+ supported_feature_ids:
+ - generativeAI
+ is_system_action_type: false
diff --git a/x-pack/plugins/actions/docs/openapi/components/responses/400.yaml b/x-pack/plugins/actions/docs/openapi/components/responses/400.yaml
new file mode 100644
index 00000000000000..263623dd1fb4cb
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/components/responses/400.yaml
@@ -0,0 +1,15 @@
+description: Indicates a bad request.
+content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ error:
+ type: string
+ example: Bad Request
+ message:
+ type: string
+ example: "error validating action type config: [index]: expected value of type [string] but got [undefined]"
+ statusCode:
+ type: integer
+ example: 400
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml
index edef270fd75ae5..4b4213b769e3b8 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml
@@ -1,6 +1,7 @@
title: Connector response properties
description: The properties vary depending on the connector type.
oneOf:
+ - $ref: 'connector_response_properties_bedrock.yaml'
- $ref: 'connector_response_properties_cases_webhook.yaml'
- $ref: 'connector_response_properties_d3security.yaml'
- $ref: 'connector_response_properties_email.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml
index 70e9a48910c80f..29b746e4d1f67b 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml
@@ -1,7 +1,6 @@
title: Connector request properties for a Webhook - Case Management connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_d3security.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_d3security.yaml
index 694b7c011b84a7..e089b079b9077b 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_d3security.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_d3security.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a D3 Security connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml
index b84dff4f53106b..cfe6e97fc61a91 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for an email connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_genai.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_genai.yaml
index 928147ed87a695..0d1bbb93f854d5 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_genai.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_genai.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for an OpenAI connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml
index 5e76416f252108..8e5fe0ba9b8927 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for an index connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -28,4 +27,6 @@ properties:
$ref: 'is_system_action.yaml'
name:
type: string
- description: The display name for the connector.
\ No newline at end of file
+ description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml
index f61381af963968..b822d82ba10f9b 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a Jira connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml
index f44f79f8e7013d..9ac5d91b25c804 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for an Opsgenie connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml
index 0002e684c2f5ea..f8616900b01d03 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a PagerDuty connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml
index fc2a239d29a4e1..489e5ab27abfcd 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a IBM Resilient connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml
index bd41b62a114c71..a397e668102a64 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a server log connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -30,3 +29,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml
index 104e7174467a4c..98ac4d3daf31d3 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a ServiceNow ITSM connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml
index 5651629365bbdd..27cfe9d0dca6a1 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a ServiceNow ITOM connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml
index 4b24b3c0e7a627..9d5a2b7ab2e2e2 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a ServiceNow SecOps connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_api.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_api.yaml
index 76510f2511dd2b..56c4f488a35af1 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_api.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_api.yaml
@@ -26,3 +26,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_webhook.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_webhook.yaml
index 7b0de9d2c27ca7..a9dfd3dc9e857f 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_webhook.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_webhook.yaml
@@ -26,3 +26,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml
index ea645598de5b71..4c239f21a5db57 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a Swimlane connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml
index 3e0dc777efa98d..939f4014763d92 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml
@@ -28,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml
index 1468becee8551d..5fcd24511580f6 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a Tines connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_torq.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_torq.yaml
index 135d5e9db6cb44..b22b6f0a872fc6 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_torq.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_torq.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a Torq connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml
index 8d0dfdac5fbe6d..3469f52c5965de 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for a Webhook connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,6 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
+
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml
index 3f9e35eba8d6a3..ead2e18149522b 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml
@@ -1,7 +1,6 @@
title: Connector response properties for an xMatters connector
type: object
required:
- - config
- connector_type_id
- id
- is_deprecated
@@ -29,3 +28,5 @@ properties:
name:
type: string
description: The display name for the connector.
+ referenced_by_count:
+ $ref: 'referenced_by_count.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request.yaml
new file mode 100644
index 00000000000000..3bcf6cc0c3ccb8
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request.yaml
@@ -0,0 +1,28 @@
+title: Create connector request body properties
+description: The properties vary depending on the connector type.
+oneOf:
+ - $ref: 'create_connector_request_bedrock.yaml'
+ - $ref: 'create_connector_request_cases_webhook.yaml'
+ - $ref: 'create_connector_request_d3security.yaml'
+ - $ref: 'create_connector_request_email.yaml'
+ - $ref: 'create_connector_request_genai.yaml'
+ - $ref: 'create_connector_request_index.yaml'
+ - $ref: 'create_connector_request_jira.yaml'
+ - $ref: 'create_connector_request_opsgenie.yaml'
+ - $ref: 'create_connector_request_pagerduty.yaml'
+ - $ref: 'create_connector_request_resilient.yaml'
+ - $ref: 'create_connector_request_serverlog.yaml'
+ - $ref: 'create_connector_request_servicenow.yaml'
+ - $ref: 'create_connector_request_servicenow_itom.yaml'
+ - $ref: 'create_connector_request_servicenow_sir.yaml'
+ - $ref: 'create_connector_request_slack_api.yaml'
+ - $ref: 'create_connector_request_slack_webhook.yaml'
+ - $ref: 'create_connector_request_swimlane.yaml'
+ - $ref: 'create_connector_request_teams.yaml'
+ - $ref: 'create_connector_request_tines.yaml'
+ - $ref: 'create_connector_request_torq.yaml'
+ - $ref: 'create_connector_request_webhook.yaml'
+ - $ref: 'create_connector_request_xmatters.yaml'
+discriminator:
+ propertyName: connector_type_id
+
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/features.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/features.yaml
index 059e91cd79c7e7..e75b745957552a 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/features.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/features.yaml
@@ -1,8 +1,9 @@
type: string
description: >
- The feature that uses the connector. Valid values are `alerting`, `cases`, `uptime`, and `siem`.
+ The feature that uses the connector.
enum:
- alerting
- cases
- - uptime
- - siem
\ No newline at end of file
+ - generativeAI
+ - siem
+ - uptime
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/is_preconfigured.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/is_preconfigured.yaml
index 11991d878721ad..e38741c83718eb 100644
--- a/x-pack/plugins/actions/docs/openapi/components/schemas/is_preconfigured.yaml
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/is_preconfigured.yaml
@@ -1,3 +1,5 @@
type: boolean
-description: Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.
+description: >
+ Indicates whether it is a preconfigured connector.
+ If true, the `config` and `is_missing_secrets` properties are omitted from the response.
example: false
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/referenced_by_count.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/referenced_by_count.yaml
new file mode 100644
index 00000000000000..61579fa3dc6ce3
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/referenced_by_count.yaml
@@ -0,0 +1,6 @@
+type: integer
+description: >
+ Indicates the number of saved objects that reference the connector.
+ If `is_preconfigured` is true, this value is not calculated.
+ This property is returned only by the get all connectors API.
+example: 2
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/run_connector_request.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/run_connector_request.yaml
new file mode 100644
index 00000000000000..a313de571b501b
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/run_connector_request.yaml
@@ -0,0 +1,26 @@
+title: Run connector request body properties
+description: The properties vary depending on the connector type.
+type: object
+required:
+ - params
+properties:
+ params:
+ oneOf:
+ - $ref: 'run_connector_params_documents.yaml'
+ - $ref: 'run_connector_params_level_message.yaml'
+ - title: Subaction parameters
+ description: Test an action that involves a subaction.
+ oneOf:
+ - $ref: 'run_connector_subaction_addevent.yaml'
+ - $ref: 'run_connector_subaction_closealert.yaml'
+ - $ref: 'run_connector_subaction_createalert.yaml'
+ - $ref: 'run_connector_subaction_fieldsbyissuetype.yaml'
+ - $ref: 'run_connector_subaction_getchoices.yaml'
+ - $ref: 'run_connector_subaction_getfields.yaml'
+ - $ref: 'run_connector_subaction_getincident.yaml'
+ - $ref: 'run_connector_subaction_issue.yaml'
+ - $ref: 'run_connector_subaction_issues.yaml'
+ - $ref: 'run_connector_subaction_issuetypes.yaml'
+ - $ref: 'run_connector_subaction_pushtoservice.yaml'
+ discriminator:
+ propertyName: subAction
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request.yaml
new file mode 100644
index 00000000000000..269cd798472772
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request.yaml
@@ -0,0 +1,24 @@
+title: Update connector request body properties
+description: The properties vary depending on the connector type.
+oneOf:
+ - $ref: 'update_connector_request_bedrock.yaml'
+ - $ref: 'update_connector_request_cases_webhook.yaml'
+ - $ref: 'update_connector_request_d3security.yaml'
+ - $ref: 'update_connector_request_email.yaml'
+ - $ref: 'create_connector_request_genai.yaml'
+ - $ref: 'update_connector_request_index.yaml'
+ - $ref: 'update_connector_request_jira.yaml'
+ - $ref: 'update_connector_request_opsgenie.yaml'
+ - $ref: 'update_connector_request_pagerduty.yaml'
+ - $ref: 'update_connector_request_resilient.yaml'
+ - $ref: 'update_connector_request_serverlog.yaml'
+ - $ref: 'update_connector_request_servicenow.yaml'
+ - $ref: 'update_connector_request_servicenow_itom.yaml'
+ - $ref: 'update_connector_request_slack_api.yaml'
+ - $ref: 'update_connector_request_slack_webhook.yaml'
+ - $ref: 'update_connector_request_swimlane.yaml'
+ - $ref: 'update_connector_request_teams.yaml'
+ - $ref: 'update_connector_request_tines.yaml'
+ - $ref: 'update_connector_request_torq.yaml'
+ - $ref: 'update_connector_request_webhook.yaml'
+ - $ref: 'update_connector_request_xmatters.yaml'
\ No newline at end of file
diff --git a/x-pack/plugins/actions/docs/openapi/entrypoint.yaml b/x-pack/plugins/actions/docs/openapi/entrypoint.yaml
index 04e844607f8272..1f85d4a44c37b6 100644
--- a/x-pack/plugins/actions/docs/openapi/entrypoint.yaml
+++ b/x-pack/plugins/actions/docs/openapi/entrypoint.yaml
@@ -15,24 +15,34 @@ servers:
- url: 'http://localhost:5601'
description: local
paths:
- '/s/{spaceId}/api/actions/connector':
+ '/api/actions/connector':
+ $ref: 'paths/api@actions@connector.yaml'
+ '/api/actions/connector/{connectorId}':
+ $ref: 'paths/api@actions@connector@{connectorid}.yaml'
+ '/api/actions/connector/{connectorId}/_execute':
+ $ref: paths/api@actions@connector@{connectorid}@_execute.yaml
+ '/api/actions/connectors':
+ $ref: paths/api@actions@connectors.yaml
+ '/api/actions/connector_types':
+ $ref: paths/api@actions@connector_types.yaml
+ '/s/{spaceId}/api/actions/connector':
$ref: 'paths/s@{spaceid}@api@actions@connector.yaml'
- '/s/{spaceId}/api/actions/connector/{connectorId}':
+ '/s/{spaceId}/api/actions/connector/{connectorId}':
$ref: 'paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml'
- '/s/{spaceId}/api/actions/connectors':
+ '/s/{spaceId}/api/actions/connectors':
$ref: paths/s@{spaceid}@api@actions@connectors.yaml
- '/s/{spaceId}/api/actions/connector_types':
+ '/s/{spaceId}/api/actions/connector_types':
$ref: paths/s@{spaceid}@api@actions@connector_types.yaml
- '/s/{spaceId}/api/actions/connector/{connectorId}/_execute':
+ '/s/{spaceId}/api/actions/connector/{connectorId}/_execute':
$ref: paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml
# Deprecated endpoints:
- '/s/{spaceId}/api/actions/action/{actionId}':
+ '/s/{spaceId}/api/actions/action/{actionId}':
$ref: 'paths/s@{spaceid}@api@actions@action@{actionid}.yaml'
- '/s/{spaceId}/api/actions':
+ '/s/{spaceId}/api/actions':
$ref: 'paths/s@{spaceid}@api@actions.yaml'
- '/s/{spaceId}/api/actions/list_action_types':
+ '/s/{spaceId}/api/actions/list_action_types':
$ref: 'paths/s@{spaceid}@api@actions@list_action_types.yaml'
- '/s/{spaceId}/api/actions/action/{actionId}/_execute':
+ '/s/{spaceId}/api/actions/action/{actionId}/_execute':
$ref: 'paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml'
components:
securitySchemes:
diff --git a/x-pack/plugins/actions/docs/openapi/entrypoint_serverless.yaml b/x-pack/plugins/actions/docs/openapi/entrypoint_serverless.yaml
new file mode 100644
index 00000000000000..1cfccf790903aa
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/entrypoint_serverless.yaml
@@ -0,0 +1,33 @@
+openapi: 3.0.1
+info:
+ title: Connectors
+ description: OpenAPI schema for connectors in Serverless projects
+ version: '0.1'
+ contact:
+ name: Connectors Team
+ license:
+ name: Elastic License 2.0
+ url: https://www.elastic.co/licensing/elastic-license
+tags:
+ - name: connectors
+ description: Connector APIs enable you to create and manage connectors.
+servers:
+ - url: 'http://localhost:5601'
+ description: local
+paths:
+ '/api/actions/connector':
+ $ref: 'paths/api@actions@connector.yaml'
+ '/api/actions/connector/{connectorId}':
+ $ref: 'paths/api@actions@connector@{connectorid}.yaml'
+ '/api/actions/connectors':
+ $ref: paths/api@actions@connectors.yaml
+ '/api/actions/connector_types':
+ $ref: paths/api@actions@connector_types.yaml
+components:
+ securitySchemes:
+ apiKeyAuth:
+ type: apiKey
+ in: header
+ name: ApiKey
+security:
+ - apiKeyAuth: []
diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml
new file mode 100644
index 00000000000000..9c5e69a53e24f0
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml
@@ -0,0 +1,44 @@
+post:
+ summary: Creates a connector.
+ operationId: createConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '../components/headers/kbn_xsrf.yaml'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '../components/schemas/create_connector_request.yaml'
+ examples:
+ createEmailConnectorRequest:
+ $ref: '../components/examples/create_email_connector_request.yaml'
+ createIndexConnectorRequest:
+ $ref: '../components/examples/create_index_connector_request.yaml'
+ createWebhookConnectorRequest:
+ $ref: '../components/examples/create_webhook_connector_request.yaml'
+ createXmattersConnectorRequest:
+ $ref: '../components/examples/create_xmatters_connector_request.yaml'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '../components/schemas/connector_response_properties.yaml'
+ examples:
+ createEmailConnectorResponse:
+ $ref: '../components/examples/create_email_connector_response.yaml'
+ createIndexConnectorResponse:
+ $ref: '../components/examples/create_index_connector_response.yaml'
+ createWebhookConnectorResponse:
+ $ref: '../components/examples/create_webhook_connector_response.yaml'
+ createXmattersConnectorResponse:
+ $ref: '../components/examples/create_xmatters_connector_response.yaml'
+ '401':
+ $ref: '../components/responses/401.yaml'
+ servers:
+ - url: https://localhost:5601
+servers:
+ - url: https://localhost:5601
diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml
new file mode 100644
index 00000000000000..f9f483f7476357
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml
@@ -0,0 +1,116 @@
+get:
+ summary: Retrieves a connector by ID.
+ operationId: getConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '../components/parameters/connector_id.yaml'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '../components/schemas/connector_response_properties.yaml'
+ examples:
+ getConnectorResponse:
+ $ref: '../components/examples/get_connector_response.yaml'
+ '401':
+ $ref: '../components/responses/401.yaml'
+ '404':
+ $ref: '../components/responses/404.yaml'
+ servers:
+ - url: https://localhost:5601
+
+delete:
+ summary: Deletes a connector.
+ operationId: deleteConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '../components/headers/kbn_xsrf.yaml'
+ - $ref: '../components/parameters/connector_id.yaml'
+ responses:
+ '204':
+ description: Indicates a successful call.
+ '401':
+ $ref: '../components/responses/401.yaml'
+ '404':
+ $ref: '../components/responses/404.yaml'
+ servers:
+ - url: https://localhost:5601
+
+post:
+ summary: Creates a connector.
+ operationId: createConnectorId
+ tags:
+ - connectors
+ parameters:
+ - $ref: '../components/headers/kbn_xsrf.yaml'
+ - in: path
+ name: connectorId
+ description: >
+ A UUID v1 or v4 identifier for the connector.
+ If you omit this parameter, an identifier is randomly generated.
+ required: true
+ schema:
+ type: string
+ example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '../components/schemas/create_connector_request.yaml'
+ examples:
+ createIndexConnectorRequest:
+ $ref: '../components/examples/create_index_connector_request.yaml'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '../components/schemas/connector_response_properties.yaml'
+ examples:
+ createIndexConnectorResponse:
+ $ref: '../components/examples/create_index_connector_response.yaml'
+ '401':
+ $ref: '../components/responses/401.yaml'
+ servers:
+ - url: https://localhost:5601
+
+put:
+ summary: Updates the attributes for a connector.
+ operationId: updateConnector
+ tags:
+ - connectors
+ parameters:
+ - $ref: '../components/headers/kbn_xsrf.yaml'
+ - $ref: '../components/parameters/connector_id.yaml'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '../components/schemas/update_connector_request.yaml'
+ examples:
+ updateIndexConnectorRequest:
+ $ref: '../components/examples/update_index_connector_request.yaml'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ $ref: '../components/schemas/connector_response_properties.yaml'
+ '400':
+ $ref: '../components/responses/401.yaml'
+ '401':
+ $ref: '../components/responses/401.yaml'
+ '404':
+ $ref: '../components/responses/404.yaml'
+ servers:
+ - url: https://localhost:5601
+servers:
+ - url: https://localhost:5601
diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}@_execute.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}@_execute.yaml
new file mode 100644
index 00000000000000..a876584ca4e8ef
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}@_execute.yaml
@@ -0,0 +1,75 @@
+post:
+ summary: Runs a connector.
+ operationId: runConnector
+ description: >
+ You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.
+ You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
+ If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges.
+ tags:
+ - connectors
+ parameters:
+ - $ref: '../components/headers/kbn_xsrf.yaml'
+ - $ref: '../components/parameters/connector_id.yaml'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '../components/schemas/run_connector_request.yaml'
+ examples:
+ runIndexConnectorRequest:
+ $ref: '../components/examples/run_index_connector_request.yaml'
+ runJiraConnectorRequest:
+ $ref: '../components/examples/run_jira_connector_request.yaml'
+ runServerLogConnectorRequest:
+ $ref: '../components/examples/run_server_log_connector_request.yaml'
+ runServiceNowITOMConnectorRequest:
+ $ref: '../components/examples/run_servicenow_itom_connector_request.yaml'
+ runSwimlaneConnectorRequest:
+ $ref: '../components/examples/run_swimlane_connector_request.yaml'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - connector_id
+ - status
+ properties:
+ connector_id:
+ type: string
+ description: The identifier for the connector.
+ data:
+ oneOf:
+ - type: object
+ description: Information returned from the action.
+ additionalProperties: true
+ - type: array
+ description: An array of information returned from the action.
+ items:
+ type: object
+ status:
+ type: string
+ description: The status of the action.
+ enum:
+ - error
+ - ok
+ examples:
+ runIndexConnectorResponse:
+ $ref: '../components/examples/run_index_connector_response.yaml'
+ runJiraConnectorResponse:
+ $ref: '../components/examples/run_jira_connector_response.yaml'
+ runServerLogConnectorResponse:
+ $ref: '../components/examples/run_server_log_connector_response.yaml'
+ runServiceNowITOMConnectorResponse:
+ $ref: '../components/examples/run_servicenow_itom_connector_response.yaml'
+ runSwimlaneConnectorResponse:
+ $ref: '../components/examples/run_swimlane_connector_response.yaml'
+ '401':
+ $ref: '../components/responses/401.yaml'
+ servers:
+ - url: https://localhost:5601
+servers:
+ - url: https://localhost:5601
diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector_types.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector_types.yaml
new file mode 100644
index 00000000000000..30247d47b24c9b
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector_types.yaml
@@ -0,0 +1,66 @@
+get:
+ summary: Retrieves a list of all connector types.
+ operationId: getConnectorTypes
+ tags:
+ - connectors
+ parameters:
+ - in: query
+ name: feature_id
+ description: A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).
+ schema:
+ $ref: '../components/schemas/features.yaml'
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ title: Get connector types response body properties
+ description: The properties vary for each connector type.
+ type: array
+ items:
+ type: object
+ properties:
+ enabled:
+ type: boolean
+ description: Indicates whether the connector type is enabled in Kibana.
+ example: true
+ enabled_in_config:
+ type: boolean
+ description: Indicates whether the connector type is enabled in the Kibana configuration file.
+ example: true
+ enabled_in_license:
+ type: boolean
+ description: Indicates whether the connector is enabled in the license.
+ example: true
+ id:
+ $ref: '../components/schemas/connector_types.yaml'
+ is_system_action_type:
+ type: boolean
+ example: false
+ minimum_license_required:
+ type: string
+ description: The license that is required to use the connector type.
+ example: basic
+ name:
+ type: string
+ description: The name of the connector type.
+ example: Index
+ supported_feature_ids:
+ type: array
+ description: The features that are supported by the connector type.
+ items:
+ $ref: '../components/schemas/features.yaml'
+ example:
+ - alerting
+ - cases
+ - siem
+ examples:
+ getConnectorTypesServerlessResponse:
+ $ref: '../components/examples/get_connector_types_generativeai_response.yaml'
+ '401':
+ $ref: '../components/responses/401.yaml'
+ servers:
+ - url: https://localhost:5601
+servers:
+ - url: https://localhost:5601
diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml
new file mode 100644
index 00000000000000..b350251dde206a
--- /dev/null
+++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml
@@ -0,0 +1,23 @@
+get:
+ summary: Retrieves all connectors.
+ operationId: getConnectors
+ tags:
+ - connectors
+ responses:
+ '200':
+ description: Indicates a successful call.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '../components/schemas/connector_response_properties.yaml'
+ examples:
+ getConnectorsResponse:
+ $ref: '../components/examples/get_connectors_response.yaml'
+ '401':
+ $ref: '../components/responses/401.yaml'
+ servers:
+ - url: https://localhost:5601
+servers:
+ - url: https://localhost:5601
diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector.yaml
index 64712858fa8a09..86e8cc1d0bfe0f 100644
--- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector.yaml
+++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector.yaml
@@ -1,6 +1,6 @@
post:
summary: Creates a connector.
- operationId: createConnector
+ operationId: createConnectorWithSpaceId
description: >
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
@@ -13,33 +13,7 @@ post:
content:
application/json:
schema:
- title: Create connector request body properties
- description: The properties vary depending on the connector type.
- oneOf:
- - $ref: '../components/schemas/create_connector_request_bedrock.yaml'
- - $ref: '../components/schemas/create_connector_request_cases_webhook.yaml'
- - $ref: '../components/schemas/create_connector_request_d3security.yaml'
- - $ref: '../components/schemas/create_connector_request_email.yaml'
- - $ref: '../components/schemas/create_connector_request_genai.yaml'
- - $ref: '../components/schemas/create_connector_request_index.yaml'
- - $ref: '../components/schemas/create_connector_request_jira.yaml'
- - $ref: '../components/schemas/create_connector_request_opsgenie.yaml'
- - $ref: '../components/schemas/create_connector_request_pagerduty.yaml'
- - $ref: '../components/schemas/create_connector_request_resilient.yaml'
- - $ref: '../components/schemas/create_connector_request_serverlog.yaml'
- - $ref: '../components/schemas/create_connector_request_servicenow.yaml'
- - $ref: '../components/schemas/create_connector_request_servicenow_itom.yaml'
- - $ref: '../components/schemas/create_connector_request_servicenow_sir.yaml'
- - $ref: '../components/schemas/create_connector_request_slack_api.yaml'
- - $ref: '../components/schemas/create_connector_request_slack_webhook.yaml'
- - $ref: '../components/schemas/create_connector_request_swimlane.yaml'
- - $ref: '../components/schemas/create_connector_request_teams.yaml'
- - $ref: '../components/schemas/create_connector_request_tines.yaml'
- - $ref: '../components/schemas/create_connector_request_torq.yaml'
- - $ref: '../components/schemas/create_connector_request_webhook.yaml'
- - $ref: '../components/schemas/create_connector_request_xmatters.yaml'
- discriminator:
- propertyName: connector_type_id
+ $ref: '../components/schemas/create_connector_request.yaml'
examples:
createEmailConnectorRequest:
$ref: '../components/examples/create_email_connector_request.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml
index 7c1d402efaca49..0edbd0a0ed2d1a 100644
--- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml
+++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml
@@ -1,6 +1,6 @@
get:
summary: Retrieves a connector by ID.
- operationId: getConnector
+ operationId: getConnectorWithSpaceId
description: >
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
@@ -21,27 +21,13 @@ get:
'401':
$ref: '../components/responses/401.yaml'
'404':
- description: Object is not found.
- content:
- application/json:
- schema:
- type: object
- properties:
- error:
- type: string
- example: Not Found
- message:
- type: string
- example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
- statusCode:
- type: integer
- example: 404
+ $ref: '../components/responses/404.yaml'
servers:
- url: https://localhost:5601
delete:
summary: Deletes a connector.
- operationId: deleteConnector
+ operationId: deleteConnectorWithSpaceId
description: >
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
WARNING: When you delete a connector, it cannot be recovered.
@@ -57,27 +43,13 @@ delete:
'401':
$ref: '../components/responses/401.yaml'
'404':
- description: Object is not found.
- content:
- application/json:
- schema:
- type: object
- properties:
- error:
- type: string
- example: Not Found
- message:
- type: string
- example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
- statusCode:
- type: integer
- example: 404
+ $ref: '../components/responses/404.yaml'
servers:
- url: https://localhost:5601
post:
summary: Creates a connector.
- operationId: createConnectorId
+ operationId: createConnectorIdWithSpaceId
description: >
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
@@ -97,33 +69,7 @@ post:
content:
application/json:
schema:
- title: Create connector request body properties
- description: The properties vary depending on the connector type.
- oneOf:
- - $ref: '../components/schemas/create_connector_request_bedrock.yaml'
- - $ref: '../components/schemas/create_connector_request_cases_webhook.yaml'
- - $ref: '../components/schemas/create_connector_request_d3security.yaml'
- - $ref: '../components/schemas/create_connector_request_email.yaml'
- - $ref: '../components/schemas/create_connector_request_genai.yaml'
- - $ref: '../components/schemas/create_connector_request_index.yaml'
- - $ref: '../components/schemas/create_connector_request_jira.yaml'
- - $ref: '../components/schemas/create_connector_request_opsgenie.yaml'
- - $ref: '../components/schemas/create_connector_request_pagerduty.yaml'
- - $ref: '../components/schemas/create_connector_request_resilient.yaml'
- - $ref: '../components/schemas/create_connector_request_serverlog.yaml'
- - $ref: '../components/schemas/create_connector_request_servicenow.yaml'
- - $ref: '../components/schemas/create_connector_request_servicenow_itom.yaml'
- - $ref: '../components/schemas/create_connector_request_servicenow_sir.yaml'
- - $ref: '../components/schemas/create_connector_request_slack_api.yaml'
- - $ref: '../components/schemas/create_connector_request_slack_webhook.yaml'
- - $ref: '../components/schemas/create_connector_request_swimlane.yaml'
- - $ref: '../components/schemas/create_connector_request_teams.yaml'
- - $ref: '../components/schemas/create_connector_request_tines.yaml'
- - $ref: '../components/schemas/create_connector_request_torq.yaml'
- - $ref: '../components/schemas/create_connector_request_webhook.yaml'
- - $ref: '../components/schemas/create_connector_request_xmatters.yaml'
- discriminator:
- propertyName: connector_type_id
+ $ref: '../components/schemas/create_connector_request.yaml'
examples:
createIndexConnectorRequest:
$ref: '../components/examples/create_index_connector_request.yaml'
@@ -144,7 +90,7 @@ post:
put:
summary: Updates the attributes for a connector.
- operationId: updateConnector
+ operationId: updateConnectorWithSpaceId
description: >
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
@@ -158,30 +104,7 @@ put:
content:
application/json:
schema:
- title: Update connector request body properties
- description: The properties vary depending on the connector type.
- oneOf:
- - $ref: '../components/schemas/create_connector_request_bedrock.yaml'
- - $ref: '../components/schemas/update_connector_request_cases_webhook.yaml'
- - $ref: '../components/schemas/update_connector_request_d3security.yaml'
- - $ref: '../components/schemas/update_connector_request_email.yaml'
- - $ref: '../components/schemas/create_connector_request_genai.yaml'
- - $ref: '../components/schemas/update_connector_request_index.yaml'
- - $ref: '../components/schemas/update_connector_request_jira.yaml'
- - $ref: '../components/schemas/update_connector_request_opsgenie.yaml'
- - $ref: '../components/schemas/update_connector_request_pagerduty.yaml'
- - $ref: '../components/schemas/update_connector_request_resilient.yaml'
- - $ref: '../components/schemas/update_connector_request_serverlog.yaml'
- - $ref: '../components/schemas/update_connector_request_servicenow.yaml'
- - $ref: '../components/schemas/update_connector_request_servicenow_itom.yaml'
- - $ref: '../components/schemas/update_connector_request_slack_api.yaml'
- - $ref: '../components/schemas/update_connector_request_slack_webhook.yaml'
- - $ref: '../components/schemas/update_connector_request_swimlane.yaml'
- - $ref: '../components/schemas/update_connector_request_teams.yaml'
- - $ref: '../components/schemas/update_connector_request_tines.yaml'
- - $ref: '../components/schemas/update_connector_request_torq.yaml'
- - $ref: '../components/schemas/update_connector_request_webhook.yaml'
- - $ref: '../components/schemas/update_connector_request_xmatters.yaml'
+ $ref: '../components/schemas/update_connector_request.yaml'
examples:
updateIndexConnectorRequest:
$ref: '../components/examples/update_index_connector_request.yaml'
@@ -193,21 +116,7 @@ put:
schema:
$ref: '../components/schemas/connector_response_properties.yaml'
'400':
- description: Indicates a bad request.
- content:
- application/json:
- schema:
- type: object
- properties:
- error:
- type: string
- example: Bad Request
- message:
- type: string
- example: "error validating action type config: [index]: expected value of type [string] but got [undefined]"
- statusCode:
- type: integer
- example: 400
+ $ref: '../components/responses/401.yaml'
'401':
$ref: '../components/responses/401.yaml'
'404':
diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml
index 9301b563bd9587..f94419bcae81d8 100644
--- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml
+++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml
@@ -1,6 +1,6 @@
post:
summary: Runs a connector.
- operationId: runConnector
+ operationId: runConnectorWithSpaceId
description: >
You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
@@ -16,32 +16,7 @@ post:
content:
application/json:
schema:
- title: Run connector request body properties
- description: The properties vary depending on the connector type.
- type: object
- required:
- - params
- properties:
- params:
- oneOf:
- - $ref: '../components/schemas/run_connector_params_documents.yaml'
- - $ref: '../components/schemas/run_connector_params_level_message.yaml'
- - title: Subaction parameters
- description: Test an action that involves a subaction.
- oneOf:
- - $ref: '../components/schemas/run_connector_subaction_addevent.yaml'
- - $ref: '../components/schemas/run_connector_subaction_closealert.yaml'
- - $ref: '../components/schemas/run_connector_subaction_createalert.yaml'
- - $ref: '../components/schemas/run_connector_subaction_fieldsbyissuetype.yaml'
- - $ref: '../components/schemas/run_connector_subaction_getchoices.yaml'
- - $ref: '../components/schemas/run_connector_subaction_getfields.yaml'
- - $ref: '../components/schemas/run_connector_subaction_getincident.yaml'
- - $ref: '../components/schemas/run_connector_subaction_issue.yaml'
- - $ref: '../components/schemas/run_connector_subaction_issues.yaml'
- - $ref: '../components/schemas/run_connector_subaction_issuetypes.yaml'
- - $ref: '../components/schemas/run_connector_subaction_pushtoservice.yaml'
- discriminator:
- propertyName: subAction
+ $ref: '../components/schemas/run_connector_request.yaml'
examples:
runIndexConnectorRequest:
$ref: '../components/examples/run_index_connector_request.yaml'
diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml
index c1001023067478..1dfdfe775a2928 100644
--- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml
+++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml
@@ -1,6 +1,6 @@
get:
summary: Retrieves a list of all connector types.
- operationId: getConnectorTypes
+ operationId: getConnectorTypesWithSpaceId
description: >
You do not need any Kibana feature privileges to run this API.
tags:
diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml
index caec98d7bf5e3c..7f5d5944ba520e 100644
--- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml
+++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml
@@ -1,6 +1,6 @@
get:
summary: Retrieves all connectors.
- operationId: getConnectors
+ operationId: getConnectorsWithSpaceId
description: >
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
tags:
@@ -15,45 +15,7 @@ get:
schema:
type: array
items:
- title: Get connectors response body properties
- description: The properties vary for each connector type.
- type: object
- required:
- - connector_type_id
- - id
- - is_deprecated
- - is_preconfigured
- - name
- - referenced_by_count
- properties:
- connector_type_id:
- $ref: '../components/schemas/connector_types.yaml'
- config:
- type: object
- description: The configuration for the connector. Configuration properties vary depending on the connector type.
- additionalProperties: true
- nullable: true
- id:
- type: string
- description: The identifier for the connector.
- example: b0766e10-d190-11ec-b04c-776c77d14fca
- is_deprecated:
- $ref: '../components/schemas/is_deprecated.yaml'
- is_missing_secrets:
- $ref: '../components/schemas/is_missing_secrets.yaml'
- is_preconfigured:
- $ref: '../components/schemas/is_preconfigured.yaml'
- is_system_action:
- $ref: '../components/schemas/is_system_action.yaml'
- name:
- type: string
- description: The display name for the connector.
- example: my-connector
- referenced_by_count:
- type: integer
- description: Indicates the number of saved objects that reference the connector. If `is_preconfigured` is true, this value is not calculated.
- example: 2
- default: 0
+ $ref: '../components/schemas/connector_response_properties.yaml'
examples:
getConnectorsResponse:
$ref: '../components/examples/get_connectors_response.yaml'
diff --git a/x-pack/plugins/enterprise_search/common/types/error_codes.ts b/x-pack/plugins/enterprise_search/common/types/error_codes.ts
index de38fa1d24f163..1492dc4e763b31 100644
--- a/x-pack/plugins/enterprise_search/common/types/error_codes.ts
+++ b/x-pack/plugins/enterprise_search/common/types/error_codes.ts
@@ -6,6 +6,7 @@
*/
export enum ErrorCode {
+ ACCESS_CONTROL_DISABLED = 'access_control_disabled',
ANALYTICS_COLLECTION_ALREADY_EXISTS = 'analytics_collection_already_exists',
ANALYTICS_COLLECTION_NOT_FOUND = 'analytics_collection_not_found',
CONNECTOR_DOCUMENT_ALREADY_EXISTS = 'connector_document_already_exists',
diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/components/header_actions/syncs_context_menu.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/components/header_actions/syncs_context_menu.tsx
index 0e1ddbf3e84ae0..d49df5e74ef03d 100644
--- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/components/header_actions/syncs_context_menu.tsx
+++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/components/header_actions/syncs_context_menu.tsx
@@ -27,6 +27,7 @@ import { KibanaLogic } from '../../../../../shared/kibana';
import { CancelSyncsApiLogic } from '../../../../api/connector/cancel_syncs_api_logic';
import { IngestionStatus } from '../../../../types';
import { CancelSyncsLogic } from '../../connector/cancel_syncs_logic';
+import { ConnectorConfigurationLogic } from '../../connector/connector_configuration_logic';
import { IndexViewLogic } from '../../index_view_logic';
export const SyncsContextMenu: React.FC = () => {
@@ -43,6 +44,7 @@ export const SyncsContextMenu: React.FC = () => {
const { cancelSyncs } = useActions(CancelSyncsLogic);
const { status } = useValues(CancelSyncsApiLogic);
const { startSync, startIncrementalSync, startAccessControlSync } = useActions(IndexViewLogic);
+ const { configState } = useValues(ConnectorConfigurationLogic);
const [isPopoverOpen, setPopover] = useState(false);
const togglePopover = () => setPopover(!isPopoverOpen);
@@ -124,7 +126,9 @@ export const SyncsContextMenu: React.FC = () => {
'entSearchContent-${ingestionMethod}-header-sync-more-accessControlSync',
'data-test-subj':
'entSearchContent-${ingestionMethod}-header-sync-more-accessControlSync',
- disabled: ingestionStatus === IngestionStatus.INCOMPLETE,
+ disabled:
+ ingestionStatus === IngestionStatus.INCOMPLETE ||
+ !configState.use_document_level_security?.value,
icon: 'play',
name: i18n.translate('xpack.enterpriseSearch.index.header.more.accessControlSync', {
defaultMessage: 'Access Control',
diff --git a/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.test.ts b/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.test.ts
index 6498d3f4d1a030..978896289763f3 100644
--- a/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.test.ts
+++ b/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.test.ts
@@ -299,7 +299,11 @@ describe('startSync lib function', () => {
_id: 'connectorId',
_source: {
api_key_id: null,
- configuration: {},
+ configuration: {
+ use_document_level_security: {
+ value: true,
+ },
+ },
created_at: null,
custom_scheduling: {},
error: null,
@@ -334,7 +338,11 @@ describe('startSync lib function', () => {
canceled_at: null,
completed_at: null,
connector: {
- configuration: {},
+ configuration: {
+ use_document_level_security: {
+ value: true,
+ },
+ },
filtering: null,
id: 'connectorId',
index_name: `${CONNECTORS_ACCESS_CONTROL_INDEX_PREFIX}index_name`,
diff --git a/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.ts b/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.ts
index 808fd2fc0d40e2..ab58fd1417b731 100644
--- a/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.ts
+++ b/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.ts
@@ -50,6 +50,12 @@ export const startSync = async (
}
: config;
const { index_name } = connector;
+ if (
+ jobType === SyncJobType.ACCESS_CONTROL &&
+ !configuration.use_document_level_security?.value
+ ) {
+ throw new Error(ErrorCode.ACCESS_CONTROL_DISABLED);
+ }
if (connector.service_type === ENTERPRISE_SEARCH_CONNECTOR_CRAWLER_SERVICE_TYPE) {
return await client.asCurrentUser.update({
diff --git a/x-pack/plugins/enterprise_search/server/routes/enterprise_search/connectors.ts b/x-pack/plugins/enterprise_search/server/routes/enterprise_search/connectors.ts
index fea646d9d726e4..a224babe332925 100644
--- a/x-pack/plugins/enterprise_search/server/routes/enterprise_search/connectors.ts
+++ b/x-pack/plugins/enterprise_search/server/routes/enterprise_search/connectors.ts
@@ -38,6 +38,7 @@ import { updateConnectorPipeline } from '../../lib/pipelines/update_pipeline';
import { RouteDependencies } from '../../plugin';
import { createError } from '../../utils/create_error';
import { elasticsearchErrorHandler } from '../../utils/elasticsearch_error_handler';
+import { isAccessControlDisabledException } from '../../utils/identify_exceptions';
import { validateEnum } from '../../utils/validate_enum';
export function registerConnectorRoutes({ router, log }: RouteDependencies) {
@@ -203,9 +204,27 @@ export function registerConnectorRoutes({ router, log }: RouteDependencies) {
},
},
elasticsearchErrorHandler(log, async (context, request, response) => {
- const { client } = (await context.core).elasticsearch;
- await startSync(client, request.params.connectorId, SyncJobType.ACCESS_CONTROL);
- return response.ok();
+ try {
+ const { client } = (await context.core).elasticsearch;
+ await startSync(client, request.params.connectorId, SyncJobType.ACCESS_CONTROL);
+ return response.ok();
+ } catch (error) {
+ if (isAccessControlDisabledException(error)) {
+ return createError({
+ errorCode: ErrorCode.ACCESS_CONTROL_DISABLED,
+ message: i18n.translate(
+ 'xpack.enterpriseSearch.server.connectors.accessControlSync.accessControlDisabledError',
+ {
+ defaultMessage:
+ 'Access control sync cannot be created. You must first enable Document Level Security.',
+ }
+ ),
+ response,
+ statusCode: 400,
+ });
+ }
+ throw error;
+ }
})
);
diff --git a/x-pack/plugins/enterprise_search/server/utils/identify_exceptions.ts b/x-pack/plugins/enterprise_search/server/utils/identify_exceptions.ts
index 415d81ee8cec7d..a1688520bb593e 100644
--- a/x-pack/plugins/enterprise_search/server/utils/identify_exceptions.ts
+++ b/x-pack/plugins/enterprise_search/server/utils/identify_exceptions.ts
@@ -52,3 +52,7 @@ export const isMissingAliasException = (error: ElasticsearchResponseError) =>
error.meta?.statusCode === 404 &&
typeof error.meta?.body?.error === 'string' &&
MISSING_ALIAS_ERROR.test(error.meta?.body?.error);
+
+export const isAccessControlDisabledException = (error: Error) => {
+ return error.message === ErrorCode.ACCESS_CONTROL_DISABLED;
+};
diff --git a/x-pack/plugins/ml/public/application/components/ml_inference/add_inference_pipeline_flyout.tsx b/x-pack/plugins/ml/public/application/components/ml_inference/add_inference_pipeline_flyout.tsx
index 592df6079603dc..c1e612e3b08d12 100644
--- a/x-pack/plugins/ml/public/application/components/ml_inference/add_inference_pipeline_flyout.tsx
+++ b/x-pack/plugins/ml/public/application/components/ml_inference/add_inference_pipeline_flyout.tsx
@@ -33,7 +33,7 @@ import { ReviewAndCreatePipeline } from './components/review_and_create_pipeline
import { useMlApiContext } from '../../contexts/kibana';
import { getPipelineConfig } from './get_pipeline_config';
import { validateInferencePipelineConfigurationStep } from './validation';
-import type { MlInferenceState, InferenceModelTypes } from './types';
+import { type MlInferenceState, type InferenceModelTypes, TEST_PIPELINE_MODE } from './types';
import { useFetchPipelines } from './hooks/use_fetch_pipelines';
export interface AddInferencePipelineFlyoutProps {
@@ -157,7 +157,11 @@ export const AddInferencePipelineFlyout: FC = (
/>
)}
{step === ADD_INFERENCE_PIPELINE_STEPS.TEST && (
- = memo(({ state, sourceIndex }) => {
+export const TestPipeline: FC = memo(({ state, sourceIndex, mode }) => {
const [simulatePipelineResult, setSimulatePipelineResult] = useState<
undefined | estypes.IngestSimulateResponse
>();
const [simulatePipelineError, setSimulatePipelineError] = useState();
+ const [sourceIndexMissingError, setSourceIndexMissingError] = useState();
const [sampleDocsString, setSampleDocsString] = useState('');
+ const [lastFetchedSampleDocsString, setLastFetchedSampleDocsString] = useState('');
const [isValid, setIsValid] = useState(true);
+ const [showCallOut, setShowCallOut] = useState(true);
const {
esSearch,
trainedModels: { trainedModelPipelineSimulate },
} = useMlApiContext();
const {
notifications: { toasts },
+ services: {
+ docLinks: { links },
+ },
} = useMlKibana();
const isSmallerViewport = useIsWithinMaxBreakpoint('s');
+ const accordionId = useMemo(() => htmlIdGenerator()(), []);
+ const pipelineConfig = useMemo(() => getPipelineConfig(state), [state]);
+ const requestBody = useMemo(() => {
+ const body = { pipeline: pipelineConfig, docs: [] };
+ if (isValidJson(sampleDocsString)) {
+ body.docs = JSON.parse(sampleDocsString);
+ }
+ return body;
+ }, [pipelineConfig, sampleDocsString]);
const simulatePipeline = async () => {
try {
- const pipelineConfig = getPipelineConfig(state);
const result = await trainedModelPipelineSimulate(
pipelineConfig,
JSON.parse(sampleDocsString) as IngestSimulateDocument[]
@@ -95,36 +124,79 @@ export const TestPipeline: FC = memo(({ state, sourceIndex }) => {
setIsValid(valid);
};
- const getSampleDocs = useCallback(async () => {
- let records: IngestSimulateDocument[] = [];
- let resp;
+ const getDocs = useCallback(
+ async (body: any) => {
+ let records: IngestSimulateDocument[] = [];
+ let resp;
+ try {
+ resp = await esSearch(body);
- try {
- resp = await esSearch({
- index: sourceIndex,
- body: {
- size: 1,
- },
- });
+ if (resp && resp.hits.total.value > 0) {
+ records = resp.hits.hits;
+ }
+ } catch (error) {
+ // eslint-disable-next-line no-console
+ console.error(error);
+ }
+ setSampleDocsString(JSON.stringify(records, null, 2));
+ setSimulatePipelineResult(undefined);
+ setLastFetchedSampleDocsString(JSON.stringify(records, null, 2));
+ setIsValid(true);
+ },
+ [esSearch]
+ );
+
+ const { getSampleDoc, getRandomSampleDoc } = useMemo(
+ () => ({
+ getSampleDoc: async () => {
+ getDocs({
+ index: sourceIndex,
+ body: {
+ size: 1,
+ },
+ });
+ },
+ getRandomSampleDoc: async () => {
+ getDocs({
+ index: sourceIndex,
+ body: {
+ size: 1,
+ query: {
+ function_score: {
+ query: { match_all: {} },
+ random_score: {},
+ },
+ },
+ },
+ });
+ },
+ }),
+ [getDocs, sourceIndex]
+ );
- if (resp && resp.hits.total.value > 0) {
- records = resp.hits.hits;
+ useEffect(
+ function checkSourceIndexExists() {
+ async function ensureSourceIndexExists() {
+ const resp = await checkIndexExists(sourceIndex!);
+ const indexExists = resp.resp && resp.resp[sourceIndex!] && resp.resp[sourceIndex!].exists;
+ if (indexExists === false) {
+ setSourceIndexMissingError(sourceIndexMissingMessage);
+ }
}
- } catch (error) {
- // eslint-disable-next-line no-console
- console.error(error);
- }
- setSampleDocsString(JSON.stringify(records, null, 2));
- setIsValid(true);
- }, [sourceIndex, esSearch]);
+ if (sourceIndex) {
+ ensureSourceIndexExists();
+ }
+ },
+ [sourceIndex, sourceIndexMissingError]
+ );
useEffect(
function fetchSampleDocsFromSource() {
- if (sourceIndex) {
- getSampleDocs();
+ if (sourceIndex && sourceIndexMissingError === undefined) {
+ getSampleDoc();
}
},
- [sourceIndex, getSampleDocs]
+ [sourceIndex, getSampleDoc, sourceIndexMissingError]
);
return (
@@ -147,27 +219,88 @@ export const TestPipeline: FC = memo(({ state, sourceIndex }) => {
+
+ {
+ setShowCallOut(false);
+ }}
+ size="s"
+ title={sourceIndexMissingError}
+ iconType="warning"
+ />
+
+ ) : null}
+ {mode === TEST_PIPELINE_MODE.STAND_ALONE ? (
+
+
+ {JSON.stringify(requestBody, null, 2)}
+
+
+
+ ) : null}
@@ -202,12 +335,26 @@ export const TestPipeline: FC = memo(({ state, sourceIndex }) => {
setSampleDocsString(lastFetchedSampleDocsString)}
+ disabled={
+ sampleDocsString === '' || sampleDocsString === lastFetchedSampleDocsString
+ }
>
{i18n.translate(
'xpack.ml.trainedModels.content.indices.pipelines.addInferencePipelineModal.steps.test.resetSampleDocsButton',
- { defaultMessage: 'Reset sample docs' }
+ { defaultMessage: 'Reset' }
+ )}
+
+
+
+
+ {i18n.translate(
+ 'xpack.ml.trainedModels.content.indices.pipelines.addInferencePipelineModal.steps.test.reloadSampleDocsButton',
+ { defaultMessage: 'Reload' }
)}
@@ -261,8 +408,6 @@ export const TestPipeline: FC = memo(({ state, sourceIndex }) => {
/>
-
void;
onTestAction: (model: ModelItem) => void;
onModelsDeleteRequest: (models: ModelItem[]) => void;
onModelDeployRequest: (model: ModelItem) => void;
@@ -463,13 +465,8 @@ export function useModelActions({
onModelDeployRequest(model);
},
available: (item) => {
- const isDfaTrainedModel =
- item.metadata?.analytics_config !== undefined ||
- item.inference_config?.regression !== undefined ||
- item.inference_config?.classification !== undefined;
-
return (
- isDfaTrainedModel &&
+ isDfaTrainedModel(item) &&
!isBuiltInModel(item) &&
!item.putModelConfig &&
canManageIngestPipelines
@@ -540,7 +537,13 @@ export function useModelActions({
type: 'icon',
isPrimary: true,
available: isTestable,
- onClick: (item) => onTestAction(item),
+ onClick: (item) => {
+ if (isDfaTrainedModel(item) && !isBuiltInModel(item)) {
+ onDfaTestAction(item);
+ } else {
+ onTestAction(item);
+ }
+ },
enabled: (item) => {
return canTestTrainedModels && isTestable(item, true) && !isLoading;
},
@@ -599,6 +602,7 @@ export function useModelActions({
canDeleteTrainedModels,
isBuiltInModel,
onTestAction,
+ onDfaTestAction,
canTestTrainedModels,
canManageIngestPipelines,
]
diff --git a/x-pack/plugins/ml/public/application/model_management/models_list.tsx b/x-pack/plugins/ml/public/application/model_management/models_list.tsx
index af9b9ba3015e73..56486d1bbbd4f8 100644
--- a/x-pack/plugins/ml/public/application/model_management/models_list.tsx
+++ b/x-pack/plugins/ml/public/application/model_management/models_list.tsx
@@ -69,6 +69,7 @@ import { useFieldFormatter } from '../contexts/kibana/use_field_formatter';
import { useRefresh } from '../routing/use_refresh';
import { SavedObjectsWarning } from '../components/saved_objects_warning';
import { TestTrainedModelFlyout } from './test_models';
+import { TestDfaModelsFlyout } from './test_dfa_models_flyout';
import { AddInferencePipelineFlyout } from '../components/ml_inference';
import { useEnabledFeatures } from '../contexts/ml';
@@ -163,6 +164,7 @@ export const ModelsList: FC = ({
{}
);
const [modelToTest, setModelToTest] = useState(null);
+ const [dfaModelToTest, setDfaModelToTest] = useState(null);
const isBuiltInModel = useCallback(
(item: ModelItem) => item.tags.includes(BUILT_IN_MODEL_TAG),
@@ -410,6 +412,7 @@ export const ModelsList: FC = ({
isLoading,
fetchModels: fetchModelsData,
onTestAction: setModelToTest,
+ onDfaTestAction: setDfaModelToTest,
onModelsDeleteRequest: setModelsToDelete,
onModelDeployRequest: setModelToDeploy,
onLoading: setIsLoading,
@@ -763,6 +766,9 @@ export const ModelsList: FC = ({
{modelToTest === null ? null : (
void;
+}
+
+export const TestDfaModelsFlyout: FC = ({ model, onClose }) => {
+ const sourceIndex = useMemo(
+ () =>
+ Array.isArray(model.metadata?.analytics_config.source.index)
+ ? model.metadata?.analytics_config.source.index.join()
+ : model.metadata?.analytics_config.source.index,
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ [model?.model_id]
+ );
+
+ const state = useMemo(
+ () => getInitialState(model),
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ [model?.model_id]
+ );
+ return (
+
+
+
+
+
+
+
+
+
+
+
+
+ );
+};
diff --git a/x-pack/plugins/ml/public/application/model_management/test_models/index.ts b/x-pack/plugins/ml/public/application/model_management/test_models/index.ts
index da7c12c1c0c584..25078a40d42063 100644
--- a/x-pack/plugins/ml/public/application/model_management/test_models/index.ts
+++ b/x-pack/plugins/ml/public/application/model_management/test_models/index.ts
@@ -6,4 +6,4 @@
*/
export { TestTrainedModelFlyout } from './test_flyout';
-export { isTestable } from './utils';
+export { isTestable, isDfaTrainedModel } from './utils';
diff --git a/x-pack/plugins/ml/public/application/model_management/test_models/utils.ts b/x-pack/plugins/ml/public/application/model_management/test_models/utils.ts
index 3adecb767f2802..f21d535fddc587 100644
--- a/x-pack/plugins/ml/public/application/model_management/test_models/utils.ts
+++ b/x-pack/plugins/ml/public/application/model_management/test_models/utils.ts
@@ -15,6 +15,14 @@ import type { ModelItem } from '../models_list';
const PYTORCH_TYPES = Object.values(SUPPORTED_PYTORCH_TASKS);
+export function isDfaTrainedModel(modelItem: ModelItem) {
+ return (
+ modelItem.metadata?.analytics_config !== undefined ||
+ modelItem.inference_config?.regression !== undefined ||
+ modelItem.inference_config?.classification !== undefined
+ );
+}
+
export function isTestable(modelItem: ModelItem, checkForState = false) {
if (
modelItem.model_type === TRAINED_MODEL_TYPE.PYTORCH &&
@@ -31,5 +39,5 @@ export function isTestable(modelItem: ModelItem, checkForState = false) {
return true;
}
- return false;
+ return isDfaTrainedModel(modelItem);
}
diff --git a/x-pack/plugins/observability_shared/dev_docs/how_we_manage_dependencies.md b/x-pack/plugins/observability_shared/dev_docs/how_we_manage_dependencies.md
new file mode 100644
index 00000000000000..5cd525e97954f9
--- /dev/null
+++ b/x-pack/plugins/observability_shared/dev_docs/how_we_manage_dependencies.md
@@ -0,0 +1,70 @@
+# Dependency Management in Observability Kibana
+
+Our goal in observability is to provide as seamless of an experience as possible for our observability users, especially when it comes to navigating between areas owned by different teams. In Kibana, these different teams each own their own experiences inside of a Kibana plugin that provides a public UI interface and, optionally, a back-end server interface. As these plugins begin to share more components, utilities, data clients, and more, the Kibana architecture requires them to depend on each other using runtime dependencies. These dependencies can only be single-direction, which severely limits the types of sharing our plugins can do with one another.
+
+## Problem summary
+
+For years, the APM plugin has declared a single-direction runtime dependency on the Infra plugin, allowing APM to make use of components and utilities made available by Infra. Because of this existing dependency, the infra plugin can never make use of similar shared items that could be made available from APM. As Logs+ grows and evolves, Synthetics and Profiling both continue to grow beyond GA, and Elastic begins to fully embrace a unified Observability user experience, we expect this problem to multiply quickly.
+
+To solve this problem, we need a clear approach for how to organize plugins, packages, and the dependencies between them.
+
+## Plan summary
+
+This is the plan we aim to follow, summarized. More details about this plan are found below.
+
+1. **Resist over-abstraction, but abstract when needed.** If something doesn't need to be shared yet, it's not necessarily good to break it out into its own plugin _or_ package. That said, we will need to break items out of our end user plugins and/or rearrange them, and we shouldn't be scared of doing this because of longtime technical limitations.
+ - TODO: Add information about possible Kibana event system to consider as a first sharing step, prior to abstraction.
+1. **Prefer packages to plugins.** A stateless package is easier to bootstrap, test, and maintain in most cases. If you don't need access to stateful dependencies from core or other plugins, or if you can accept a reasonable number of injected dependencies, make a package.
+ - TODO: Add link to docs/examples of how to make a Kibana package
+ - TODO: Add more clarity on the trade-offs between plugin vs package
+1. **If you need to make a new plugin, be sure to carefully consider the plugin tiers and how your new plugin will fit.**. In most cases, we should avoid new plugins (with the exception of data access plugins which should only depend on Kibana core.)
+1. **Never introduce or add to existing dependencies between plugins in the same tier.** This is the main problem we need to avoid, especially between end user plugins.
+
+## Plugin tier system
+
+The system we'll embrace revolves around a "tier system" to help us organize different types of plugins. The plugin tiers look like this:
+
+
+
+Within this system, a plugin in any tier may ONLY introduce dependencies on other plugins that are in a tier below theirs. They may NOT depend on plugins in the same tier or in tiers above their own. Packages, on the other hand, may be depended on from _any_ plugin, as well as from _any other_ package.
+
+**Note:** Tiers are NOT currently enforced by any lint rule or other rule. Tiers are a convention that allow us to structure our code in such a way as to avoid the circular dependency problem, but they require manual enforcement via code review. In the near future, we should explore simple ways to codify and enforce this system, either in linting rules, Kibana bundling enforcement, precommit hooks, etc.
+
+### Tier 1: End user tier
+
+End user plugins are the plugins that provide visible sections of the Observability UI in Kibana. Each of these plugins may provide one or more navigational areas inside of the Observability product, and they each may provide one or more Kibana server APIs as well.
+
+These plugins should stop introducing dependencies on each other immediately, and should also stop introducing new functionality that relies on existing dependencies immediately, as well. As soon as possible, existing dependencies between these plugins should be removed and replaced with extracted functionality.
+
+
+
+### Tier 2: Share tier
+
+"Share plugins" provide shared functionality (UI components, utility functions, shared logic, etc.) that can be used by multiple end user plugins. Being plugins, they still take advantage of the Kibana runtime lifecycle (setup, start, stop) and have access to Kibana's core functionality and core plugin system.
+
+This tier is where we would move any shared items, business logic, and stateful dependencies that need access to the plugin lifecycle and, for whatever reason, can't or don't want to accept runtime dependencies as injected parameters. These share plugins can make use of the core-only plugins that typically provide encapsulated access to observability data of other kinds.
+
+
+
+### Tier 3: Core-only tier (aka data access tier)
+
+This tier is for plugins that ONLY depend on Kibana core functionality such as scoped ES clients, saved object clients, etc. The main examples of these for now are the new "data access client" plugins which encapsulate the logic for accessing our various types of signal data in observability. By keeping this tier isolated from the other code and only allowing for it to depend on Kibana core, we make data access safely available to any other plugin in the end user or share tiers.
+
+
+
+### Core: Kibana core
+
+Anything made available by Kibana core, either in the CoreSetup, CoreStart, or one of the core-maintained plugins such as saved objects, etc. is fair game as a dependency of any observability plugin in any tier.
+
+### Packages
+
+Kibana packages are stateless and therefore can be imported into any plugin in any tier. If your shareable item is stateless, or if it can be simply built to accept strongly-typed items using dependency injection, using a package is almost always the best choice.
+
+## Putting it all together
+
+
+
+With the exception of package dependencies, all plugin-to-plugin dependencies may only flow _downward_ in the tier diagram.
+
+
+
diff --git a/x-pack/plugins/serverless_search/common/doc_links.ts b/x-pack/plugins/serverless_search/common/doc_links.ts
index 0c816e3c7a3899..6d97c6aed5bede 100644
--- a/x-pack/plugins/serverless_search/common/doc_links.ts
+++ b/x-pack/plugins/serverless_search/common/doc_links.ts
@@ -76,7 +76,7 @@ class ESDocLinks {
this.phpClient = newDocLinks.serverlessClients.phpGettingStarted;
// Python
this.pythonApiReference = newDocLinks.serverlessClients.pythonGettingStarted;
- this.pythonBasicConfig = newDocLinks.clients.pythonConnecting;
+ this.pythonBasicConfig = newDocLinks.serverlessClients.pythonGettingStarted;
this.pythonClient = newDocLinks.serverlessClients.pythonGettingStarted;
// Python
this.rubyBasicConfig = newDocLinks.serverlessClients.rubyGettingStarted;
diff --git a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types_project.ts b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types_project.ts
index 23e39660842fae..99082a43f09b31 100644
--- a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types_project.ts
+++ b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types_project.ts
@@ -43,7 +43,7 @@ export const ProjectMonitorCodec = t.intersection([
alert: AlertConfigsCodec,
urls: t.union([t.string, t.array(t.string)]),
hosts: t.union([t.string, t.array(t.string)]),
- max_redirects: t.string,
+ max_redirects: t.union([t.string, t.number]),
wait: t.string,
hash: t.string,
namespace: t.string,
diff --git a/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.test.ts b/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.test.ts
index 44678ad3b7688c..6db69ae3eebf2e 100644
--- a/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.test.ts
+++ b/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.test.ts
@@ -78,6 +78,7 @@ describe('http normalizers', () => {
supported_protocols: ['TLSv1.2', 'TLSv1.3'],
},
hash: testHash,
+ max_redirects: 2,
},
{
locations: ['localhost'],
@@ -160,7 +161,7 @@ describe('http normalizers', () => {
form_monitor_type: 'http',
journey_id: 'my-monitor-2',
locations: [],
- max_redirects: '0',
+ max_redirects: '2',
name: 'My Monitor 2',
namespace: 'test_space',
origin: 'project',
@@ -300,7 +301,7 @@ describe('http normalizers', () => {
form_monitor_type: 'http',
journey_id: 'my-monitor-2',
locations: [],
- max_redirects: '0',
+ max_redirects: '2',
name: 'My Monitor 2',
namespace: 'test_space',
origin: 'project',
diff --git a/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.ts b/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.ts
index 892fbd53617a14..c79db2433cb807 100644
--- a/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.ts
+++ b/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/normalizers/http_monitor.ts
@@ -64,8 +64,7 @@ export const getNormalizeHTTPFields = ({
[ConfigKey.MONITOR_TYPE]: DataStream.HTTP,
[ConfigKey.FORM_MONITOR_TYPE]: FormMonitorType.HTTP,
[ConfigKey.URLS]: getOptionalArrayField(monitor.urls) || defaultFields[ConfigKey.URLS],
- [ConfigKey.MAX_REDIRECTS]:
- monitor[ConfigKey.MAX_REDIRECTS] || defaultFields[ConfigKey.MAX_REDIRECTS],
+ [ConfigKey.MAX_REDIRECTS]: formatMaxRedirects(monitor[ConfigKey.MAX_REDIRECTS]),
[ConfigKey.REQUEST_BODY_CHECK]: getRequestBodyField(
(yamlConfig as Record)[ConfigKey.REQUEST_BODY_CHECK] as string,
defaultFields[ConfigKey.REQUEST_BODY_CHECK]
@@ -113,3 +112,13 @@ export const getRequestBodyField = (
value: parsedValue || defaultValue.value,
};
};
+
+export const formatMaxRedirects = (value?: string | number): string => {
+ if (typeof value === 'number') {
+ return `${value}`;
+ }
+
+ const defaultFields = DEFAULT_FIELDS[DataStream.HTTP];
+
+ return value ?? defaultFields[ConfigKey.MAX_REDIRECTS];
+};
diff --git a/x-pack/plugins/translations/translations/fr-FR.json b/x-pack/plugins/translations/translations/fr-FR.json
index 861c6ddbca41bd..ec61fc696fd779 100644
--- a/x-pack/plugins/translations/translations/fr-FR.json
+++ b/x-pack/plugins/translations/translations/fr-FR.json
@@ -4792,8 +4792,6 @@
"presentationUtil.labs.components.titleLabel": "Ateliers",
"presentationUtil.labs.enableByValueEmbeddableDescription": "Active la prise en charge pour les éléments d'incorporation by-value dans Canvas",
"presentationUtil.labs.enableByValueEmbeddableName": "Éléments d'incorporation By-Value",
- "presentationUtil.labs.enableDashboardControlsProjectDescription": "Active le système de contrôles pour le tableau de bord, ce qui permet à ses auteurs de créer plus facilement des éléments interactifs pour leurs utilisateurs.",
- "presentationUtil.labs.enableDashboardControlsProjectName": "Activer les contrôles pour le tableau de bord",
"presentationUtil.labs.enableDeferBelowFoldProjectDescription": "Les panneaux sous \"le pli\" (la zone masquée en dessous de la fenêtre accessible en faisant défiler), ne se chargeront pas immédiatement, mais seulement lorsqu'ils entreront dans la fenêtre d'affichage.",
"presentationUtil.labs.enableDeferBelowFoldProjectName": "Différer le chargement des panneaux sous \"le pli\"",
"presentationUtil.saveModalDashboard.addToDashboardLabel": "Ajouter au tableau de bord",
diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json
index ea24659866ab8b..ecf2b3716ddec2 100644
--- a/x-pack/plugins/translations/translations/ja-JP.json
+++ b/x-pack/plugins/translations/translations/ja-JP.json
@@ -4808,8 +4808,6 @@
"presentationUtil.labs.components.titleLabel": "ラボ",
"presentationUtil.labs.enableByValueEmbeddableDescription": "キャンバスでby-value埋め込み可能オブジェクトのサポートを有効にします",
"presentationUtil.labs.enableByValueEmbeddableName": "By-Value埋め込み可能オブジェクト",
- "presentationUtil.labs.enableDashboardControlsProjectDescription": "ダッシュボードのコントロールシステムを有効にします。これにより、ダッシュボードの作成者は、ユーザー向けのインタラクティブな要素をより簡単に構築できます。",
- "presentationUtil.labs.enableDashboardControlsProjectName": "ダッシュボードコントロールを有効にする",
"presentationUtil.labs.enableDeferBelowFoldProjectDescription": "「区切り」の下のすべてのパネル（ウィンドウ下部の下にある非表示の領域）はすぐに読み込まれません。ビューポートを入力するときにのみ読み込まれます",
"presentationUtil.labs.enableDeferBelowFoldProjectName": "「区切り」の下のパネルの読み込みを延期",
"presentationUtil.saveModalDashboard.addToDashboardLabel": "ダッシュボードに追加",
diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json
index 1ba93d83b83df7..65c962b7db7f1e 100644
--- a/x-pack/plugins/translations/translations/zh-CN.json
+++ b/x-pack/plugins/translations/translations/zh-CN.json
@@ -4807,8 +4807,6 @@
"presentationUtil.labs.components.titleLabel": "实验",
"presentationUtil.labs.enableByValueEmbeddableDescription": "在 Canvas 中启用按值嵌入的支持",
"presentationUtil.labs.enableByValueEmbeddableName": "按值嵌入",
- "presentationUtil.labs.enableDashboardControlsProjectDescription": "为仪表板启用控件系统，这允许仪表板作者更轻松地为其用户构建交互式元素。",
- "presentationUtil.labs.enableDashboardControlsProjectName": "启用仪表板控件",
"presentationUtil.labs.enableDeferBelowFoldProjectDescription": "“折叠”下的任何面板即可通过滚动访问的窗口底部隐藏的区域，将不会立即加载，而仅在进入视区时加载",
"presentationUtil.labs.enableDeferBelowFoldProjectName": "推迟加载“折叠”下的面板",
"presentationUtil.saveModalDashboard.addToDashboardLabel": "添加到仪表板",
diff --git a/x-pack/plugins/watcher/public/application/sections/watch_edit_page/components/json_watch_edit/simulate_watch_results_flyout.tsx b/x-pack/plugins/watcher/public/application/sections/watch_edit_page/components/json_watch_edit/simulate_watch_results_flyout.tsx
index e48202e80c3047..a4f156afcc14cb 100644
--- a/x-pack/plugins/watcher/public/application/sections/watch_edit_page/components/json_watch_edit/simulate_watch_results_flyout.tsx
+++ b/x-pack/plugins/watcher/public/application/sections/watch_edit_page/components/json_watch_edit/simulate_watch_results_flyout.tsx
@@ -81,6 +81,7 @@ export const SimulateWatchResultsFlyout = ({
return Object.keys(actions).map((actionKey) => {
const actionStatus = actionStatuses.find((status) => status.id === actionKey);
const isConditionMet = executeResults.details?.result?.condition.met;
+
return {
actionId: actionKey,
actionType: getTypeFromAction(actions[actionKey]),
@@ -90,7 +91,7 @@ export const SimulateWatchResultsFlyout = ({
actionStatus:
(isConditionMet &&
executeResults.details.result.actions.find((action: any) => action.id === actionKey)
- .status) ||
+ ?.status) ||
conditionNotMetActionStatus(actionModes[actionKey]),
};
});
diff --git a/x-pack/test/functional/apps/dashboard/group2/migration_smoke_tests/controls_migration_smoke_test.ts b/x-pack/test/functional/apps/dashboard/group2/migration_smoke_tests/controls_migration_smoke_test.ts
index f2c8d67d16b7e0..848be6a7838492 100644
--- a/x-pack/test/functional/apps/dashboard/group2/migration_smoke_tests/controls_migration_smoke_test.ts
+++ b/x-pack/test/functional/apps/dashboard/group2/migration_smoke_tests/controls_migration_smoke_test.ts
@@ -55,7 +55,6 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
});
it('should render all panels on the dashboard', async () => {
- await dashboardControls.enableControlsLab();
await dashboard.navigateToApp();
await dashboard.loadSavedDashboard('[8.0.0] Controls Dashboard');
diff --git a/x-pack/test/functional/apps/ml/short_tests/model_management/model_list.ts b/x-pack/test/functional/apps/ml/short_tests/model_management/model_list.ts
index 7d3cf599558f4c..5a50a34b4ee17d 100644
--- a/x-pack/test/functional/apps/ml/short_tests/model_management/model_list.ts
+++ b/x-pack/test/functional/apps/ml/short_tests/model_management/model_list.ts
@@ -192,21 +192,19 @@ export default function ({ getService }: FtrProviderContext) {
await ml.testExecution.logTestStep('should display the trained model in the table');
await ml.trainedModelsTable.filterWithSearchString(modelWithoutPipelineData.modelId, 1);
await ml.testExecution.logTestStep(
- 'should not show collapsed actions menu for the model in the table'
+ 'should show collapsed actions menu for the model in the table'
);
await ml.trainedModelsTable.assertModelCollapsedActionsButtonExists(
modelWithoutPipelineData.modelId,
- false
+ true
);
await ml.testExecution.logTestStep('should show deploy action for the model in the table');
- await ml.trainedModelsTable.assertModelDeployActionButtonExists(
+ await ml.trainedModelsTable.assertModelDeployActionButtonEnabled(
modelWithoutPipelineData.modelId,
true
);
await ml.testExecution.logTestStep('should open the deploy model flyout');
- await ml.trainedModelsTable.openTrainedModelsInferenceFlyout(
- modelWithoutPipelineData.modelId
- );
+ await ml.trainedModelsTable.clickDeployAction(modelWithoutPipelineData.modelId);
await ml.testExecution.logTestStep('should complete the deploy model Details step');
await ml.deployDFAModelFlyout.completeTrainedModelsInferenceFlyoutDetails({
name: modelWithoutPipelineDataExpectedValues.name,
@@ -251,17 +249,15 @@ export default function ({ getService }: FtrProviderContext) {
);
await ml.trainedModelsTable.assertModelCollapsedActionsButtonExists(
modelWithoutPipelineData.modelId,
- false
+ true
);
await ml.testExecution.logTestStep('should show deploy action for the model in the table');
await ml.trainedModelsTable.assertModelDeployActionButtonExists(
modelWithoutPipelineData.modelId,
- true
+ false
);
await ml.testExecution.logTestStep('should open the deploy model flyout');
- await ml.trainedModelsTable.openTrainedModelsInferenceFlyout(
- modelWithoutPipelineData.modelId
- );
+ await ml.trainedModelsTable.clickDeployAction(modelWithoutPipelineData.modelId);
await ml.testExecution.logTestStep('should complete the deploy model Details step');
await ml.deployDFAModelFlyout.completeTrainedModelsInferenceFlyoutDetails(
{
diff --git a/x-pack/test/functional/services/ml/trained_models_table.ts b/x-pack/test/functional/services/ml/trained_models_table.ts
index 878d1a0d8d1d1f..1053d8a990e445 100644
--- a/x-pack/test/functional/services/ml/trained_models_table.ts
+++ b/x-pack/test/functional/services/ml/trained_models_table.ts
@@ -319,15 +319,6 @@ export function TrainedModelsTableProvider(
await trainedModelsActions.testModelOutput(modelType, inputParams, expectedResult);
}
- public async openTrainedModelsInferenceFlyout(modelId: string) {
- await mlCommonUI.invokeTableRowAction(
- this.rowSelector(modelId),
- 'mlModelsTableRowDeployAction',
- false
- );
- await this.assertDeployModelFlyoutExists();
- }
-
public async deleteModel(modelId: string) {
const fromContextMenu = await this.doesModelCollapsedActionsButtonExist(modelId);
await mlCommonUI.invokeTableRowAction(
@@ -341,6 +332,33 @@ export function TrainedModelsTableProvider(
await this.assertModelDisplayedInTable(modelId, false);
}
+ public async assertModelDeployActionButtonEnabled(modelId: string, expectedValue: boolean) {
+ const actionsButtonExists = await this.doesModelCollapsedActionsButtonExist(modelId);
+
+ let isEnabled = null;
+
+ if (actionsButtonExists) {
+ await this.toggleActionsContextMenu(modelId, true);
+ const panelElement = await find.byCssSelector('.euiContextMenuPanel');
+ const actionButton = await panelElement.findByTestSubject('mlModelsTableRowDeployAction');
+ isEnabled = await actionButton.isEnabled();
+ // escape popover
+ await browser.pressKeys(browser.keys.ESCAPE);
+ } else {
+ await this.assertModelDeployActionButtonExists(modelId, true);
+ isEnabled = await testSubjects.isEnabled(
+ this.rowSelector(modelId, 'mlModelsTableRowDeployAction')
+ );
+ }
+
+ expect(isEnabled).to.eql(
+ expectedValue,
+ `Expected row deploy action button for trained model '${modelId}' to be '${
+ expectedValue ? 'enabled' : 'disabled'
+ }' (got '${isEnabled ? 'enabled' : 'disabled'}')`
+ );
+ }
+
public async assertModelDeleteActionButtonEnabled(modelId: string, expectedValue: boolean) {
const actionsButtonExists = await this.doesModelCollapsedActionsButtonExist(modelId);
@@ -458,6 +476,21 @@ export function TrainedModelsTableProvider(
await this.assertDeleteModalExists();
}
+ public async clickDeployAction(modelId: string) {
+ const actionsButtonExists = await this.doesModelCollapsedActionsButtonExist(modelId);
+
+ if (actionsButtonExists) {
+ await this.toggleActionsContextMenu(modelId, true);
+ const panelElement = await find.byCssSelector('.euiContextMenuPanel');
+ const actionButton = await panelElement.findByTestSubject('mlModelsTableRowDeployAction');
+ await actionButton.click();
+ } else {
+ await testSubjects.click(this.rowSelector(modelId, 'mlModelsTableRowDeployAction'));
+ }
+
+ await this.assertDeployModelFlyoutExists();
+ }
+
async assertNumOfAllocations(expectedValue: number) {
const actualValue = await testSubjects.getAttribute(
'mlModelsStartDeploymentModalNumOfAllocations',
diff --git a/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/index_threshold_rule.ts b/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/index_threshold_rule.ts
index a09333154bc0e6..9ca11a5a2dc450 100644
--- a/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/index_threshold_rule.ts
+++ b/x-pack/test/screenshot_creation/apps/response_ops_docs/stack_alerting/index_threshold_rule.ts
@@ -79,7 +79,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
await testSubjects.click('overExpressionSelect');
await testSubjects.setValue('overExpressionSelect', 'top');
await testSubjects.setValue('fieldsNumberSelect', '4');
- await testSubjects.setValue('fieldsExpressionSelect', 'host.keyword');
+ await comboBox.set('fieldsExpressionSelect', 'host.keyword');
await commonScreenshots.takeScreenshot(
'rule-types-index-threshold-example-grouping',
screenshotDirectories,
@@ -128,6 +128,23 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
1024
);
+ const actionFrequency = await testSubjects.find('summaryOrPerRuleSelect');
+ await actionFrequency.click();
+ const actionSummary = await testSubjects.find('actionNotifyWhen-option-summary');
+ await actionSummary.click();
+ const notifyWhen = await testSubjects.find('notifyWhenSelect');
+ await notifyWhen.click();
+ const customInterval = await testSubjects.find('onThrottleInterval');
+ await customInterval.click();
+ await testSubjects.setValue('throttleInput', '24');
+ await testSubjects.scrollIntoView('addAlertActionButton');
+ await commonScreenshots.takeScreenshot(
+ 'rule-types-index-threshold-example-action-summary',
+ screenshotDirectories,
+ 1400,
+ 1024
+ );
+
const saveButton = await testSubjects.find('saveRuleButton');
await saveButton.click();
const flyOutCancelButton = await testSubjects.find('euiFlyoutCloseButton');
-
- {i18n.translate(
- 'xpack.ml.trainedModels.content.indices.pipelines.addInferencePipelineModal.steps.test.optionalCallout',
- { defaultMessage: 'This is an optional step.' }
- )}
-
-
-
+
+ {state.targetField && (
+ <>
+
+
)}
+ {sampleDocsString && sourceIndexMissingError === undefined ? (
+