mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[OAS] Refresh connectors API document (#186141)
This commit is contained in:
Lisa Cawley
GitHub
parent
5a88e4cc37
commit
a021e48e2b
71 changed files with 1903 additions and 2571 deletions
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"openapi": "3.1.0",
|
||||
"openapi": "3.0.3",
|
||||
"info": {
|
||||
"title": "Connectors",
|
||||
"description": "OpenAPI schema for connectors in Serverless projects",
|
||||
|
|
@ -36,7 +36,7 @@
|
|||
"paths": {
|
||||
"/api/actions/connector": {
|
||||
"post": {
|
||||
"summary": "Creates a connector.",
|
||||
"summary": "Create a connector",
|
||||
"operationId": "createConnector",
|
||||
"tags": [
|
||||
"connectors"
|
||||
|
|
@ -103,7 +103,7 @@
|
|||
},
|
||||
"/api/actions/connector/{connectorId}": {
|
||||
"get": {
|
||||
"summary": "Retrieves a connector by ID.",
|
||||
"summary": "Get a connector information",
|
||||
"operationId": "getConnector",
|
||||
"tags": [
|
||||
"connectors"
|
||||
|
|
@ -138,7 +138,7 @@
|
|||
}
|
||||
},
|
||||
"delete": {
|
||||
"summary": "Deletes a connector.",
|
||||
"summary": "Delete a connector",
|
||||
"operationId": "deleteConnector",
|
||||
"tags": [
|
||||
"connectors"
|
||||
|
|
@ -164,7 +164,7 @@
|
|||
}
|
||||
},
|
||||
"post": {
|
||||
"summary": "Creates a connector.",
|
||||
"summary": "Create a connector",
|
||||
"operationId": "createConnectorId",
|
||||
"tags": [
|
||||
"connectors"
|
||||
|
|
@ -180,9 +180,7 @@
|
|||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74"
|
||||
]
|
||||
"example": "ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74"
|
||||
}
|
||||
}
|
||||
],
|
||||
|
|
@ -223,7 +221,7 @@
|
|||
}
|
||||
},
|
||||
"put": {
|
||||
"summary": "Updates the attributes for a connector.",
|
||||
"summary": "Update a connector",
|
||||
"operationId": "updateConnector",
|
||||
"tags": [
|
||||
"connectors"
|
||||
|
|
@ -276,7 +274,7 @@
|
|||
},
|
||||
"/api/actions/connectors": {
|
||||
"get": {
|
||||
"summary": "Retrieves all connectors.",
|
||||
"summary": "Get all connectors",
|
||||
"operationId": "getConnectors",
|
||||
"tags": [
|
||||
"connectors"
|
||||
|
|
@ -308,7 +306,7 @@
|
|||
},
|
||||
"/api/actions/connector_types": {
|
||||
"get": {
|
||||
"summary": "Retrieves a list of all connector types.",
|
||||
"summary": "Get all connector types",
|
||||
"operationId": "getConnectorTypes",
|
||||
"tags": [
|
||||
"connectors"
|
||||
|
|
@ -338,46 +336,34 @@
|
|||
"enabled": {
|
||||
"type": "boolean",
|
||||
"description": "Indicates whether the connector type is enabled in Kibana.",
|
||||
"examples": [
|
||||
true
|
||||
]
|
||||
"example": true
|
||||
},
|
||||
"enabled_in_config": {
|
||||
"type": "boolean",
|
||||
"description": "Indicates whether the connector type is enabled in the Kibana configuration file.",
|
||||
"examples": [
|
||||
true
|
||||
]
|
||||
"example": true
|
||||
},
|
||||
"enabled_in_license": {
|
||||
"type": "boolean",
|
||||
"description": "Indicates whether the connector is enabled in the license.",
|
||||
"examples": [
|
||||
true
|
||||
]
|
||||
"example": true
|
||||
},
|
||||
"id": {
|
||||
"$ref": "#/components/schemas/connector_types"
|
||||
},
|
||||
"is_system_action_type": {
|
||||
"type": "boolean",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
"example": false
|
||||
},
|
||||
"minimum_license_required": {
|
||||
"type": "string",
|
||||
"description": "The license that is required to use the connector type.",
|
||||
"examples": [
|
||||
"basic"
|
||||
]
|
||||
"example": "basic"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the connector type.",
|
||||
"examples": [
|
||||
"Index"
|
||||
]
|
||||
"example": "Index"
|
||||
},
|
||||
"supported_feature_ids": {
|
||||
"type": "array",
|
||||
|
|
@ -385,12 +371,10 @@
|
|||
"items": {
|
||||
"$ref": "#/components/schemas/features"
|
||||
},
|
||||
"examples": [
|
||||
[
|
||||
"alerting",
|
||||
"cases",
|
||||
"siem"
|
||||
]
|
||||
"example": [
|
||||
"alerting",
|
||||
"cases",
|
||||
"siem"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -417,7 +401,7 @@
|
|||
"type": "apiKey",
|
||||
"in": "header",
|
||||
"name": "Authorization",
|
||||
"description": "e.g. Authorization: ApiKey base64AccessApiKey"
|
||||
"description": "Serverless APIs support only key-based authentication. You must create an API key and use the encoded value in the request header. For example: 'Authorization: ApiKey base64AccessApiKey'.\n"
|
||||
}
|
||||
},
|
||||
"parameters": {
|
||||
|
|
@ -437,9 +421,7 @@
|
|||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"df770e30-8b8b-11ed-a780-3b746c987a81"
|
||||
]
|
||||
"example": "df770e30-8b8b-11ed-a780-3b746c987a81"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -464,16 +446,12 @@
|
|||
"enum": [
|
||||
".bedrock"
|
||||
],
|
||||
"examples": [
|
||||
".bedrock"
|
||||
]
|
||||
"example": ".bedrock"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_bedrock"
|
||||
|
|
@ -500,16 +478,12 @@
|
|||
"enum": [
|
||||
".gemini"
|
||||
],
|
||||
"examples": [
|
||||
".gemini"
|
||||
]
|
||||
"example": ".gemini"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_gemini"
|
||||
|
|
@ -535,16 +509,12 @@
|
|||
"enum": [
|
||||
".cases-webhook"
|
||||
],
|
||||
"examples": [
|
||||
".cases-webhook"
|
||||
]
|
||||
"example": ".cases-webhook"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_cases_webhook"
|
||||
|
|
@ -571,16 +541,12 @@
|
|||
"enum": [
|
||||
".d3security"
|
||||
],
|
||||
"examples": [
|
||||
".d3security"
|
||||
]
|
||||
"example": ".d3security"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_d3security"
|
||||
|
|
@ -607,16 +573,12 @@
|
|||
"enum": [
|
||||
".email"
|
||||
],
|
||||
"examples": [
|
||||
".email"
|
||||
]
|
||||
"example": ".email"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_email"
|
||||
|
|
@ -643,16 +605,12 @@
|
|||
"enum": [
|
||||
".gen-ai"
|
||||
],
|
||||
"examples": [
|
||||
".gen-ai"
|
||||
]
|
||||
"example": ".gen-ai"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_genai"
|
||||
|
|
@ -678,16 +636,12 @@
|
|||
"enum": [
|
||||
".index"
|
||||
],
|
||||
"examples": [
|
||||
".index"
|
||||
]
|
||||
"example": ".index"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -711,16 +665,12 @@
|
|||
"enum": [
|
||||
".jira"
|
||||
],
|
||||
"examples": [
|
||||
".jira"
|
||||
]
|
||||
"example": ".jira"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_jira"
|
||||
|
|
@ -747,16 +697,12 @@
|
|||
"enum": [
|
||||
".opsgenie"
|
||||
],
|
||||
"examples": [
|
||||
".opsgenie"
|
||||
]
|
||||
"example": ".opsgenie"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_opsgenie"
|
||||
|
|
@ -783,16 +729,12 @@
|
|||
"enum": [
|
||||
".pagerduty"
|
||||
],
|
||||
"examples": [
|
||||
".pagerduty"
|
||||
]
|
||||
"example": ".pagerduty"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_pagerduty"
|
||||
|
|
@ -816,9 +758,7 @@
|
|||
"connector_type_id": {
|
||||
"description": "The type of connector.",
|
||||
"type": "string",
|
||||
"examples": [
|
||||
".resilient"
|
||||
],
|
||||
"example": ".resilient",
|
||||
"enum": [
|
||||
".resilient"
|
||||
]
|
||||
|
|
@ -826,9 +766,7 @@
|
|||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_resilient"
|
||||
|
|
@ -856,16 +794,12 @@
|
|||
"enum": [
|
||||
".sentinelone"
|
||||
],
|
||||
"examples": [
|
||||
".sentinelone"
|
||||
]
|
||||
"example": ".sentinelone"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_sentinelone"
|
||||
|
|
@ -887,16 +821,12 @@
|
|||
"enum": [
|
||||
".server-log"
|
||||
],
|
||||
"examples": [
|
||||
".server-log"
|
||||
]
|
||||
"example": ".server-log"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -920,16 +850,12 @@
|
|||
"enum": [
|
||||
".servicenow"
|
||||
],
|
||||
"examples": [
|
||||
".servicenow"
|
||||
]
|
||||
"example": ".servicenow"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_servicenow"
|
||||
|
|
@ -956,16 +882,12 @@
|
|||
"enum": [
|
||||
".servicenow-itom"
|
||||
],
|
||||
"examples": [
|
||||
".servicenow-itom"
|
||||
]
|
||||
"example": ".servicenow-itom"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_servicenow"
|
||||
|
|
@ -992,16 +914,12 @@
|
|||
"enum": [
|
||||
".servicenow-sir"
|
||||
],
|
||||
"examples": [
|
||||
".servicenow-sir"
|
||||
]
|
||||
"example": ".servicenow-sir"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_servicenow"
|
||||
|
|
@ -1027,16 +945,12 @@
|
|||
"enum": [
|
||||
".slack_api"
|
||||
],
|
||||
"examples": [
|
||||
".slack_api"
|
||||
]
|
||||
"example": ".slack_api"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_slack_api"
|
||||
|
|
@ -1059,16 +973,12 @@
|
|||
"enum": [
|
||||
".slack"
|
||||
],
|
||||
"examples": [
|
||||
".slack"
|
||||
]
|
||||
"example": ".slack"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_slack_webhook"
|
||||
|
|
@ -1095,16 +1005,12 @@
|
|||
"enum": [
|
||||
".swimlane"
|
||||
],
|
||||
"examples": [
|
||||
".swimlane"
|
||||
]
|
||||
"example": ".swimlane"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_swimlane"
|
||||
|
|
@ -1127,16 +1033,12 @@
|
|||
"enum": [
|
||||
".teams"
|
||||
],
|
||||
"examples": [
|
||||
".teams"
|
||||
]
|
||||
"example": ".teams"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_teams"
|
||||
|
|
@ -1163,16 +1065,12 @@
|
|||
"enum": [
|
||||
".tines"
|
||||
],
|
||||
"examples": [
|
||||
".tines"
|
||||
]
|
||||
"example": ".tines"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_tines"
|
||||
|
|
@ -1199,16 +1097,12 @@
|
|||
"enum": [
|
||||
".torq"
|
||||
],
|
||||
"examples": [
|
||||
".torq"
|
||||
]
|
||||
"example": ".torq"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_torq"
|
||||
|
|
@ -1235,16 +1129,12 @@
|
|||
"enum": [
|
||||
".webhook"
|
||||
],
|
||||
"examples": [
|
||||
".webhook"
|
||||
]
|
||||
"example": ".webhook"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_webhook"
|
||||
|
|
@ -1271,16 +1161,12 @@
|
|||
"enum": [
|
||||
".xmatters"
|
||||
],
|
||||
"examples": [
|
||||
".xmatters"
|
||||
]
|
||||
"example": ".xmatters"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_xmatters"
|
||||
|
|
@ -1386,9 +1272,7 @@
|
|||
"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",
|
||||
"examples": [
|
||||
"{\"body\": {{{case.comment}}}}"
|
||||
]
|
||||
"example": "{\"body\": {{{case.comment}}}}"
|
||||
},
|
||||
"createCommentMethod": {
|
||||
"type": "string",
|
||||
|
|
@ -1403,16 +1287,12 @@
|
|||
"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",
|
||||
"examples": [
|
||||
"https://example.com/issue/{{{external.system.id}}}/comment"
|
||||
]
|
||||
"example": "https://example.com/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",
|
||||
"examples": [
|
||||
"{\"fields\": {\"summary\": {{{case.title}}},\"description\": {{{case.description}}},\"labels\": {{{case.tags}}}}}"
|
||||
]
|
||||
"example": "{\"fields\": {\"summary\": {{{case.title}}},\"description\": {{{case.description}}},\"labels\": {{{case.tags}}}}}"
|
||||
},
|
||||
"createIncidentMethod": {
|
||||
"type": "string",
|
||||
|
|
@ -1439,9 +1319,7 @@
|
|||
"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",
|
||||
"examples": [
|
||||
"https://example.com/issue/{{{external.system.id}}}"
|
||||
]
|
||||
"example": "https://example.com/issue/{{{external.system.id}}}"
|
||||
},
|
||||
"hasAuth": {
|
||||
"type": "boolean",
|
||||
|
|
@ -1455,9 +1333,7 @@
|
|||
"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",
|
||||
"examples": [
|
||||
"{\"fields\": {\"summary\": {{{case.title}}},\"description\": {{{case.description}}},\"labels\": {{{case.tags}}}}}"
|
||||
]
|
||||
"example": "{\"fields\": {\"summary\": {{{case.title}}},\"description\": {{{case.description}}},\"labels\": {{{case.tags}}}}}"
|
||||
},
|
||||
"updateIncidentMethod": {
|
||||
"type": "string",
|
||||
|
|
@ -1472,16 +1348,12 @@
|
|||
"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",
|
||||
"examples": [
|
||||
"https://example.com/issue/{{{external.system.ID}}}"
|
||||
]
|
||||
"example": "https://example.com/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",
|
||||
"examples": [
|
||||
"https://testing-jira.atlassian.net/browse/{{{external.system.title}}}"
|
||||
]
|
||||
"example": "https://testing-jira.atlassian.net/browse/{{{external.system.title}}}"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1537,10 +1409,8 @@
|
|||
"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",
|
||||
"null"
|
||||
]
|
||||
"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",
|
||||
|
|
@ -1556,10 +1426,8 @@
|
|||
"type": "string"
|
||||
},
|
||||
"oauthTokenUrl": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
"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",
|
||||
|
|
@ -1583,10 +1451,8 @@
|
|||
},
|
||||
"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",
|
||||
"null"
|
||||
]
|
||||
"type": "string",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1698,10 +1564,8 @@
|
|||
"executionTimeField": {
|
||||
"description": "A field that indicates when the document was indexed.",
|
||||
"default": null,
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
"type": "string",
|
||||
"nullable": true
|
||||
},
|
||||
"index": {
|
||||
"description": "The Elasticsearch index to be written to.",
|
||||
|
|
@ -1787,13 +1651,9 @@
|
|||
"properties": {
|
||||
"apiUrl": {
|
||||
"description": "The PagerDuty event URL.",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"examples": [
|
||||
"https://events.pagerduty.com/v2/enqueue"
|
||||
]
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"example": "https://events.pagerduty.com/v2/enqueue"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2363,10 +2223,10 @@
|
|||
"properties": {
|
||||
"authType": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"enum": [
|
||||
"webhook-authentication-basic",
|
||||
"webhook-authentication-ssl",
|
||||
"null"
|
||||
"webhook-authentication-ssl"
|
||||
],
|
||||
"description": "The type of authentication to use: basic, SSL, or none.\n"
|
||||
},
|
||||
|
|
@ -2387,10 +2247,8 @@
|
|||
"description": "If `true`, a user name and password must be provided for login type authentication.\n"
|
||||
},
|
||||
"headers": {
|
||||
"type": [
|
||||
"object",
|
||||
"null"
|
||||
],
|
||||
"type": "object",
|
||||
"nullable": true,
|
||||
"description": "A set of key-value pairs sent as headers with the request."
|
||||
},
|
||||
"method": {
|
||||
|
|
@ -2452,10 +2310,8 @@
|
|||
"properties": {
|
||||
"configUrl": {
|
||||
"description": "The request URL for the Elastic Alerts trigger in xMatters. It is applicable only when `usesBasic` is `true`.\n",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
"type": "string",
|
||||
"nullable": true
|
||||
},
|
||||
"usesBasic": {
|
||||
"description": "Specifies whether the connector uses HTTP basic authentication (`true`) or URL authentication (`false`).",
|
||||
|
|
@ -3152,10 +3008,8 @@
|
|||
],
|
||||
"properties": {
|
||||
"config": {
|
||||
"type": [
|
||||
"object",
|
||||
"null"
|
||||
]
|
||||
"type": "object",
|
||||
"nullable": true
|
||||
},
|
||||
"connector_type_id": {
|
||||
"type": "string",
|
||||
|
|
@ -3695,37 +3549,27 @@
|
|||
"is_deprecated": {
|
||||
"type": "boolean",
|
||||
"description": "Indicates whether the connector type is deprecated.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
"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.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
"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",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
"example": false
|
||||
},
|
||||
"is_system_action": {
|
||||
"type": "boolean",
|
||||
"description": "Indicates whether the connector is used for system actions.",
|
||||
"examples": [
|
||||
false
|
||||
]
|
||||
"example": false
|
||||
},
|
||||
"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",
|
||||
"examples": [
|
||||
2
|
||||
]
|
||||
"example": 2
|
||||
},
|
||||
"connector_response_properties": {
|
||||
"title": "Connector response properties",
|
||||
|
|
@ -3888,9 +3732,7 @@
|
|||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_cases_webhook"
|
||||
|
|
@ -4167,9 +4009,7 @@
|
|||
"name": {
|
||||
"type": "string",
|
||||
"description": "The display name for the connector.",
|
||||
"examples": [
|
||||
"my-connector"
|
||||
]
|
||||
"example": "my-connector"
|
||||
},
|
||||
"secrets": {
|
||||
"$ref": "#/components/schemas/secrets_properties_swimlane"
|
||||
|
|
@ -4395,9 +4235,7 @@
|
|||
".webhook",
|
||||
".xmatters"
|
||||
],
|
||||
"examples": [
|
||||
".server-log"
|
||||
]
|
||||
"example": ".server-log"
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
|
|
@ -4646,9 +4484,7 @@
|
|||
"properties": {
|
||||
"error": {
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"Unauthorized"
|
||||
],
|
||||
"example": "Unauthorized",
|
||||
"enum": [
|
||||
"Unauthorized"
|
||||
]
|
||||
|
|
@ -4658,9 +4494,7 @@
|
|||
},
|
||||
"statusCode": {
|
||||
"type": "integer",
|
||||
"examples": [
|
||||
401
|
||||
],
|
||||
"example": 401,
|
||||
"enum": [
|
||||
401
|
||||
]
|
||||
|
|
@ -4680,24 +4514,18 @@
|
|||
"properties": {
|
||||
"error": {
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"Not Found"
|
||||
],
|
||||
"example": "Not Found",
|
||||
"enum": [
|
||||
"Not Found"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
|
||||
]
|
||||
"example": "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
|
||||
},
|
||||
"statusCode": {
|
||||
"type": "integer",
|
||||
"examples": [
|
||||
404
|
||||
],
|
||||
"example": 404,
|
||||
"enum": [
|
||||
404
|
||||
]
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
openapi: 3.1.0
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: Connectors
|
||||
description: OpenAPI schema for connectors in Serverless projects
|
||||
|
|
@ -21,7 +21,7 @@ tags:
|
|||
paths:
|
||||
/api/actions/connector:
|
||||
post:
|
||||
summary: Creates a connector.
|
||||
summary: Create a connector
|
||||
operationId: createConnector
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -62,7 +62,7 @@ paths:
|
|||
$ref: '#/components/responses/401'
|
||||
/api/actions/connector/{connectorId}:
|
||||
get:
|
||||
summary: Retrieves a connector by ID.
|
||||
summary: Get a connector information
|
||||
operationId: getConnector
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -83,7 +83,7 @@ paths:
|
|||
'404':
|
||||
$ref: '#/components/responses/404'
|
||||
delete:
|
||||
summary: Deletes a connector.
|
||||
summary: Delete a connector
|
||||
operationId: deleteConnector
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -98,7 +98,7 @@ paths:
|
|||
'404':
|
||||
$ref: '#/components/responses/404'
|
||||
post:
|
||||
summary: Creates a connector.
|
||||
summary: Create a connector
|
||||
operationId: createConnectorId
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -111,8 +111,7 @@ paths:
|
|||
required: true
|
||||
schema:
|
||||
type: string
|
||||
examples:
|
||||
- ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
|
||||
example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
|
|
@ -135,7 +134,7 @@ paths:
|
|||
'401':
|
||||
$ref: '#/components/responses/401'
|
||||
put:
|
||||
summary: Updates the attributes for a connector.
|
||||
summary: Update a connector
|
||||
operationId: updateConnector
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -166,7 +165,7 @@ paths:
|
|||
$ref: '#/components/responses/404'
|
||||
/api/actions/connectors:
|
||||
get:
|
||||
summary: Retrieves all connectors.
|
||||
summary: Get all connectors
|
||||
operationId: getConnectors
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -186,7 +185,7 @@ paths:
|
|||
$ref: '#/components/responses/401'
|
||||
/api/actions/connector_types:
|
||||
get:
|
||||
summary: Retrieves a list of all connector types.
|
||||
summary: Get all connector types
|
||||
operationId: getConnectorTypes
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -211,43 +210,37 @@ paths:
|
|||
enabled:
|
||||
type: boolean
|
||||
description: Indicates whether the connector type is enabled in Kibana.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
enabled_in_config:
|
||||
type: boolean
|
||||
description: Indicates whether the connector type is enabled in the Kibana configuration file.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
enabled_in_license:
|
||||
type: boolean
|
||||
description: Indicates whether the connector is enabled in the license.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
id:
|
||||
$ref: '#/components/schemas/connector_types'
|
||||
is_system_action_type:
|
||||
type: boolean
|
||||
examples:
|
||||
- false
|
||||
example: false
|
||||
minimum_license_required:
|
||||
type: string
|
||||
description: The license that is required to use the connector type.
|
||||
examples:
|
||||
- basic
|
||||
example: basic
|
||||
name:
|
||||
type: string
|
||||
description: The name of the connector type.
|
||||
examples:
|
||||
- Index
|
||||
example: Index
|
||||
supported_feature_ids:
|
||||
type: array
|
||||
description: The features that are supported by the connector type.
|
||||
items:
|
||||
$ref: '#/components/schemas/features'
|
||||
examples:
|
||||
- - alerting
|
||||
- cases
|
||||
- siem
|
||||
example:
|
||||
- alerting
|
||||
- cases
|
||||
- siem
|
||||
examples:
|
||||
getConnectorTypesServerlessResponse:
|
||||
$ref: '#/components/examples/get_connector_types_generativeai_response'
|
||||
|
|
@ -259,7 +252,8 @@ components:
|
|||
type: apiKey
|
||||
in: header
|
||||
name: Authorization
|
||||
description: 'e.g. Authorization: ApiKey base64AccessApiKey'
|
||||
description: |
|
||||
Serverless APIs support only key-based authentication. You must create an API key and use the encoded value in the request header. For example: 'Authorization: ApiKey base64AccessApiKey'.
|
||||
parameters:
|
||||
kbn_xsrf:
|
||||
schema:
|
||||
|
|
@ -275,8 +269,7 @@ components:
|
|||
required: true
|
||||
schema:
|
||||
type: string
|
||||
examples:
|
||||
- df770e30-8b8b-11ed-a780-3b746c987a81
|
||||
example: df770e30-8b8b-11ed-a780-3b746c987a81
|
||||
schemas:
|
||||
create_connector_request_bedrock:
|
||||
title: Create Amazon Bedrock connector request
|
||||
|
|
@ -295,13 +288,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .bedrock
|
||||
examples:
|
||||
- .bedrock
|
||||
example: .bedrock
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_bedrock'
|
||||
create_connector_request_gemini:
|
||||
|
|
@ -321,13 +312,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .gemini
|
||||
examples:
|
||||
- .gemini
|
||||
example: .gemini
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_gemini'
|
||||
create_connector_request_cases_webhook:
|
||||
|
|
@ -347,13 +336,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .cases-webhook
|
||||
examples:
|
||||
- .cases-webhook
|
||||
example: .cases-webhook
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_cases_webhook'
|
||||
create_connector_request_d3security:
|
||||
|
|
@ -374,13 +361,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .d3security
|
||||
examples:
|
||||
- .d3security
|
||||
example: .d3security
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_d3security'
|
||||
create_connector_request_email:
|
||||
|
|
@ -401,13 +386,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .email
|
||||
examples:
|
||||
- .email
|
||||
example: .email
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_email'
|
||||
create_connector_request_genai:
|
||||
|
|
@ -428,13 +411,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .gen-ai
|
||||
examples:
|
||||
- .gen-ai
|
||||
example: .gen-ai
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_genai'
|
||||
create_connector_request_index:
|
||||
|
|
@ -453,13 +434,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .index
|
||||
examples:
|
||||
- .index
|
||||
example: .index
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
create_connector_request_jira:
|
||||
title: Create Jira connector request
|
||||
description: The Jira connector uses the REST API v2 to create Jira issues.
|
||||
|
|
@ -477,13 +456,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .jira
|
||||
examples:
|
||||
- .jira
|
||||
example: .jira
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_jira'
|
||||
create_connector_request_opsgenie:
|
||||
|
|
@ -503,13 +480,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .opsgenie
|
||||
examples:
|
||||
- .opsgenie
|
||||
example: .opsgenie
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_opsgenie'
|
||||
create_connector_request_pagerduty:
|
||||
|
|
@ -530,13 +505,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .pagerduty
|
||||
examples:
|
||||
- .pagerduty
|
||||
example: .pagerduty
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_pagerduty'
|
||||
create_connector_request_resilient:
|
||||
|
|
@ -554,15 +527,13 @@ components:
|
|||
connector_type_id:
|
||||
description: The type of connector.
|
||||
type: string
|
||||
examples:
|
||||
- .resilient
|
||||
example: .resilient
|
||||
enum:
|
||||
- .resilient
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_resilient'
|
||||
create_connector_request_sentinelone:
|
||||
|
|
@ -584,13 +555,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .sentinelone
|
||||
examples:
|
||||
- .sentinelone
|
||||
example: .sentinelone
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_sentinelone'
|
||||
create_connector_request_serverlog:
|
||||
|
|
@ -606,13 +575,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .server-log
|
||||
examples:
|
||||
- .server-log
|
||||
example: .server-log
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
create_connector_request_servicenow:
|
||||
title: Create ServiceNow ITSM connector request
|
||||
description: |
|
||||
|
|
@ -631,13 +598,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .servicenow
|
||||
examples:
|
||||
- .servicenow
|
||||
example: .servicenow
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_servicenow'
|
||||
create_connector_request_servicenow_itom:
|
||||
|
|
@ -658,13 +623,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .servicenow-itom
|
||||
examples:
|
||||
- .servicenow-itom
|
||||
example: .servicenow-itom
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_servicenow'
|
||||
create_connector_request_servicenow_sir:
|
||||
|
|
@ -685,13 +648,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .servicenow-sir
|
||||
examples:
|
||||
- .servicenow-sir
|
||||
example: .servicenow-sir
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_servicenow'
|
||||
create_connector_request_slack_api:
|
||||
|
|
@ -710,13 +671,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .slack_api
|
||||
examples:
|
||||
- .slack_api
|
||||
example: .slack_api
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_slack_api'
|
||||
create_connector_request_slack_webhook:
|
||||
|
|
@ -733,13 +692,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .slack
|
||||
examples:
|
||||
- .slack
|
||||
example: .slack
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_slack_webhook'
|
||||
create_connector_request_swimlane:
|
||||
|
|
@ -759,13 +716,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .swimlane
|
||||
examples:
|
||||
- .swimlane
|
||||
example: .swimlane
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_swimlane'
|
||||
create_connector_request_teams:
|
||||
|
|
@ -782,13 +737,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .teams
|
||||
examples:
|
||||
- .teams
|
||||
example: .teams
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_teams'
|
||||
create_connector_request_tines:
|
||||
|
|
@ -809,13 +762,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .tines
|
||||
examples:
|
||||
- .tines
|
||||
example: .tines
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_tines'
|
||||
create_connector_request_torq:
|
||||
|
|
@ -836,13 +787,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .torq
|
||||
examples:
|
||||
- .torq
|
||||
example: .torq
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_torq'
|
||||
create_connector_request_webhook:
|
||||
|
|
@ -863,13 +812,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .webhook
|
||||
examples:
|
||||
- .webhook
|
||||
example: .webhook
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_webhook'
|
||||
create_connector_request_xmatters:
|
||||
|
|
@ -890,13 +837,11 @@ components:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .xmatters
|
||||
examples:
|
||||
- .xmatters
|
||||
example: .xmatters
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_xmatters'
|
||||
config_properties_bedrock:
|
||||
|
|
@ -978,8 +923,7 @@ components:
|
|||
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.
|
||||
examples:
|
||||
- '{"body": {{{case.comment}}}}'
|
||||
example: '{"body": {{{case.comment}}}}'
|
||||
createCommentMethod:
|
||||
type: string
|
||||
description: |
|
||||
|
|
@ -993,14 +937,12 @@ components:
|
|||
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.
|
||||
examples:
|
||||
- https://example.com/issue/{{{external.system.id}}}/comment
|
||||
example: https://example.com/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.
|
||||
examples:
|
||||
- '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
|
||||
example: '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
|
||||
createIncidentMethod:
|
||||
type: string
|
||||
description: |
|
||||
|
|
@ -1024,8 +966,7 @@ components:
|
|||
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.
|
||||
examples:
|
||||
- https://example.com/issue/{{{external.system.id}}}
|
||||
example: https://example.com/issue/{{{external.system.id}}}
|
||||
hasAuth:
|
||||
type: boolean
|
||||
description: If true, a username and password for login type authentication must be provided.
|
||||
|
|
@ -1038,8 +979,7 @@ components:
|
|||
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.
|
||||
examples:
|
||||
- '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
|
||||
example: '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
|
||||
updateIncidentMethod:
|
||||
type: string
|
||||
description: |
|
||||
|
|
@ -1053,14 +993,12 @@ components:
|
|||
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.
|
||||
examples:
|
||||
- https://example.com/issue/{{{external.system.ID}}}
|
||||
example: https://example.com/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.
|
||||
examples:
|
||||
- https://testing-jira.atlassian.net/browse/{{{external.system.title}}}
|
||||
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
|
||||
|
|
@ -1102,9 +1040,8 @@ components:
|
|||
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
|
||||
- 'null'
|
||||
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.
|
||||
|
|
@ -1119,9 +1056,8 @@ components:
|
|||
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
|
||||
- 'null'
|
||||
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.
|
||||
|
|
@ -1144,9 +1080,8 @@ components:
|
|||
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
|
||||
- 'null'
|
||||
type: string
|
||||
nullable: true
|
||||
secrets_properties_email:
|
||||
title: Connector secrets properties for an email connector
|
||||
description: Defines secrets for connectors when type is `.email`.
|
||||
|
|
@ -1230,9 +1165,8 @@ components:
|
|||
executionTimeField:
|
||||
description: A field that indicates when the document was indexed.
|
||||
default: null
|
||||
type:
|
||||
- string
|
||||
- 'null'
|
||||
type: string
|
||||
nullable: true
|
||||
index:
|
||||
description: The Elasticsearch index to be written to.
|
||||
type: string
|
||||
|
|
@ -1297,11 +1231,9 @@ components:
|
|||
properties:
|
||||
apiUrl:
|
||||
description: The PagerDuty event URL.
|
||||
type:
|
||||
- string
|
||||
- 'null'
|
||||
examples:
|
||||
- https://events.pagerduty.com/v2/enqueue
|
||||
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`.
|
||||
|
|
@ -1737,10 +1669,10 @@ components:
|
|||
properties:
|
||||
authType:
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
- webhook-authentication-basic
|
||||
- webhook-authentication-ssl
|
||||
- 'null'
|
||||
description: |
|
||||
The type of authentication to use: basic, SSL, or none.
|
||||
ca:
|
||||
|
|
@ -1759,9 +1691,8 @@ components:
|
|||
description: |
|
||||
If `true`, a user name and password must be provided for login type authentication.
|
||||
headers:
|
||||
type:
|
||||
- object
|
||||
- 'null'
|
||||
type: object
|
||||
nullable: true
|
||||
description: A set of key-value pairs sent as headers with the request.
|
||||
method:
|
||||
type: string
|
||||
|
|
@ -1814,9 +1745,8 @@ components:
|
|||
configUrl:
|
||||
description: |
|
||||
The request URL for the Elastic Alerts trigger in xMatters. It is applicable only when `usesBasic` is `true`.
|
||||
type:
|
||||
- string
|
||||
- 'null'
|
||||
type: string
|
||||
nullable: true
|
||||
usesBasic:
|
||||
description: Specifies whether the connector uses HTTP basic authentication (`true`) or URL authentication (`false`).
|
||||
type: boolean
|
||||
|
|
@ -2299,9 +2229,8 @@ components:
|
|||
- name
|
||||
properties:
|
||||
config:
|
||||
type:
|
||||
- object
|
||||
- 'null'
|
||||
type: object
|
||||
nullable: true
|
||||
connector_type_id:
|
||||
type: string
|
||||
description: The type of connector.
|
||||
|
|
@ -2687,30 +2616,25 @@ components:
|
|||
is_deprecated:
|
||||
type: boolean
|
||||
description: Indicates whether the connector type is deprecated.
|
||||
examples:
|
||||
- false
|
||||
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.
|
||||
examples:
|
||||
- false
|
||||
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.
|
||||
examples:
|
||||
- false
|
||||
example: false
|
||||
is_system_action:
|
||||
type: boolean
|
||||
description: Indicates whether the connector is used for system actions.
|
||||
examples:
|
||||
- false
|
||||
example: false
|
||||
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.
|
||||
examples:
|
||||
- 2
|
||||
example: 2
|
||||
connector_response_properties:
|
||||
title: Connector response properties
|
||||
description: The properties vary depending on the connector type.
|
||||
|
|
@ -2806,8 +2730,7 @@ components:
|
|||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_cases_webhook'
|
||||
update_connector_request_d3security:
|
||||
|
|
@ -3004,8 +2927,7 @@ components:
|
|||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: '#/components/schemas/secrets_properties_swimlane'
|
||||
update_connector_request_teams:
|
||||
|
|
@ -3148,8 +3070,7 @@ components:
|
|||
- .torq
|
||||
- .webhook
|
||||
- .xmatters
|
||||
examples:
|
||||
- .server-log
|
||||
example: .server-log
|
||||
examples:
|
||||
create_email_connector_request:
|
||||
summary: Create an email connector.
|
||||
|
|
@ -3345,16 +3266,14 @@ components:
|
|||
properties:
|
||||
error:
|
||||
type: string
|
||||
examples:
|
||||
- Unauthorized
|
||||
example: Unauthorized
|
||||
enum:
|
||||
- Unauthorized
|
||||
message:
|
||||
type: string
|
||||
statusCode:
|
||||
type: integer
|
||||
examples:
|
||||
- 401
|
||||
example: 401
|
||||
enum:
|
||||
- 401
|
||||
'404':
|
||||
|
|
@ -3367,17 +3286,14 @@ components:
|
|||
properties:
|
||||
error:
|
||||
type: string
|
||||
examples:
|
||||
- Not Found
|
||||
example: Not Found
|
||||
enum:
|
||||
- Not Found
|
||||
message:
|
||||
type: string
|
||||
examples:
|
||||
- Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found
|
||||
example: Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found
|
||||
statusCode:
|
||||
type: integer
|
||||
examples:
|
||||
- 404
|
||||
example: 404
|
||||
enum:
|
||||
- 404
|
||||
|
|
|
|||
|
|
@ -4,5 +4,4 @@ description: An identifier for the action.
|
|||
required: true
|
||||
schema:
|
||||
type: string
|
||||
examples:
|
||||
- c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
|
||||
example: c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
|
||||
|
|
|
|||
|
|
@ -4,5 +4,4 @@ description: An identifier for the connector.
|
|||
required: true
|
||||
schema:
|
||||
type: string
|
||||
examples:
|
||||
- df770e30-8b8b-11ed-a780-3b746c987a81
|
||||
example: df770e30-8b8b-11ed-a780-3b746c987a81
|
||||
|
|
|
|||
|
|
@ -4,5 +4,4 @@ description: An identifier for the space. If `/s/` and the identifier are omitte
|
|||
required: true
|
||||
schema:
|
||||
type: string
|
||||
examples:
|
||||
- default
|
||||
example: default
|
||||
|
|
|
|||
|
|
@ -6,13 +6,10 @@ content:
|
|||
properties:
|
||||
error:
|
||||
type: string
|
||||
examples:
|
||||
- Bad Request
|
||||
example: Bad Request
|
||||
message:
|
||||
type: string
|
||||
examples:
|
||||
- "error validating action type config: [index]: expected value of type [string] but got [undefined]"
|
||||
example: "error validating action type config: [index]: expected value of type [string] but got [undefined]"
|
||||
statusCode:
|
||||
type: integer
|
||||
examples:
|
||||
- 400
|
||||
example: 400
|
||||
|
|
@ -7,15 +7,13 @@ content:
|
|||
properties:
|
||||
error:
|
||||
type: string
|
||||
examples:
|
||||
- Unauthorized
|
||||
example: Unauthorized
|
||||
enum:
|
||||
- Unauthorized
|
||||
message:
|
||||
type: string
|
||||
statusCode:
|
||||
type: integer
|
||||
examples:
|
||||
- 401
|
||||
example: 401
|
||||
enum:
|
||||
- 401
|
||||
|
|
@ -7,17 +7,14 @@ content:
|
|||
properties:
|
||||
error:
|
||||
type: string
|
||||
examples:
|
||||
- Not Found
|
||||
example: Not Found
|
||||
enum:
|
||||
- Not Found
|
||||
message:
|
||||
type: string
|
||||
examples:
|
||||
- "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
|
||||
example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
|
||||
statusCode:
|
||||
type: integer
|
||||
examples:
|
||||
- 404
|
||||
example: 404
|
||||
enum:
|
||||
- 404
|
||||
|
|
@ -22,8 +22,7 @@ properties:
|
|||
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.
|
||||
examples:
|
||||
- '{"body": {{{case.comment}}}}'
|
||||
example: '{"body": {{{case.comment}}}}'
|
||||
createCommentMethod:
|
||||
type: string
|
||||
description: >
|
||||
|
|
@ -41,8 +40,7 @@ properties:
|
|||
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.
|
||||
examples:
|
||||
- https://example.com/issue/{{{external.system.id}}}/comment
|
||||
example: https://example.com/issue/{{{external.system.id}}}/comment
|
||||
createIncidentJson:
|
||||
type: string
|
||||
description: >
|
||||
|
|
@ -54,8 +52,7 @@ properties:
|
|||
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.
|
||||
examples:
|
||||
- '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
|
||||
example: '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
|
||||
createIncidentMethod:
|
||||
type: string
|
||||
description: >
|
||||
|
|
@ -89,8 +86,7 @@ properties:
|
|||
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.
|
||||
examples:
|
||||
- https://example.com/issue/{{{external.system.id}}}
|
||||
example: https://example.com/issue/{{{external.system.id}}}
|
||||
hasAuth:
|
||||
type: boolean
|
||||
description: If true, a username and password for login type authentication must be provided.
|
||||
|
|
@ -111,8 +107,7 @@ properties:
|
|||
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.
|
||||
examples:
|
||||
- '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
|
||||
example: '{"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}'
|
||||
updateIncidentMethod:
|
||||
type: string
|
||||
description: >
|
||||
|
|
@ -129,14 +124,12 @@ properties:
|
|||
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.
|
||||
examples:
|
||||
- https://example.com/issue/{{{external.system.ID}}}
|
||||
example: https://example.com/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.
|
||||
examples:
|
||||
- https://testing-jira.atlassian.net/browse/{{{external.system.title}}}
|
||||
example: https://testing-jira.atlassian.net/browse/{{{external.system.title}}}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,9 +8,8 @@ properties:
|
|||
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"
|
||||
- "null"
|
||||
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.
|
||||
|
|
@ -28,9 +27,8 @@ properties:
|
|||
type: string
|
||||
oauthTokenUrl:
|
||||
# description: TBD
|
||||
type:
|
||||
- "string"
|
||||
- "null"
|
||||
type: string
|
||||
nullable: true
|
||||
port:
|
||||
description: >
|
||||
The port to connect to on the service provider.
|
||||
|
|
@ -57,6 +55,5 @@ properties:
|
|||
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"
|
||||
- "null"
|
||||
type: string
|
||||
nullable: true
|
||||
|
|
@ -7,9 +7,8 @@ properties:
|
|||
executionTimeField:
|
||||
description: A field that indicates when the document was indexed.
|
||||
default: null
|
||||
type:
|
||||
- "string"
|
||||
- "null"
|
||||
type: string
|
||||
nullable: true
|
||||
index:
|
||||
description: The Elasticsearch index to be written to.
|
||||
type: string
|
||||
|
|
|
|||
|
|
@ -4,8 +4,6 @@ type: object
|
|||
properties:
|
||||
apiUrl:
|
||||
description: The PagerDuty event URL.
|
||||
type:
|
||||
- "string"
|
||||
- "null"
|
||||
examples:
|
||||
- https://events.pagerduty.com/v2/enqueue
|
||||
type: string
|
||||
nullable: true
|
||||
example: https://events.pagerduty.com/v2/enqueue
|
||||
|
|
@ -4,10 +4,10 @@ type: object
|
|||
properties:
|
||||
authType:
|
||||
type: string
|
||||
nullable: true
|
||||
enum:
|
||||
- webhook-authentication-basic
|
||||
- webhook-authentication-ssl
|
||||
- "null"
|
||||
description: >
|
||||
The type of authentication to use: basic, SSL, or none.
|
||||
ca:
|
||||
|
|
@ -27,9 +27,8 @@ properties:
|
|||
description: >
|
||||
If `true`, a user name and password must be provided for login type authentication.
|
||||
headers:
|
||||
type:
|
||||
- "object"
|
||||
- "null"
|
||||
type: object
|
||||
nullable: true
|
||||
description: A set of key-value pairs sent as headers with the request.
|
||||
method:
|
||||
type: string
|
||||
|
|
|
|||
|
|
@ -6,9 +6,8 @@ properties:
|
|||
description: >
|
||||
The request URL for the Elastic Alerts trigger in xMatters.
|
||||
It is applicable only when `usesBasic` is `true`.
|
||||
type:
|
||||
- "string"
|
||||
- "null"
|
||||
type: string
|
||||
nullable: true
|
||||
usesBasic:
|
||||
description: Specifies whether the connector uses HTTP basic authentication (`true`) or URL authentication (`false`).
|
||||
type: boolean
|
||||
|
|
|
|||
|
|
@ -8,9 +8,8 @@ required:
|
|||
- name
|
||||
properties:
|
||||
config:
|
||||
type:
|
||||
- "object"
|
||||
- "null"
|
||||
type: object
|
||||
nullable: true
|
||||
connector_type_id:
|
||||
type: string
|
||||
description: The type of connector.
|
||||
|
|
|
|||
|
|
@ -26,5 +26,4 @@ enum:
|
|||
- .torq
|
||||
- .webhook
|
||||
- .xmatters
|
||||
examples:
|
||||
- .server-log
|
||||
example: .server-log
|
||||
|
|
@ -14,12 +14,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .bedrock
|
||||
examples:
|
||||
- .bedrock
|
||||
example: .bedrock
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_bedrock.yaml'
|
||||
|
|
|
|||
|
|
@ -15,12 +15,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .cases-webhook
|
||||
examples:
|
||||
- .cases-webhook
|
||||
example: .cases-webhook
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_cases_webhook.yaml'
|
||||
|
|
@ -15,12 +15,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .d3security
|
||||
examples:
|
||||
- .d3security
|
||||
example: .d3security
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_d3security.yaml'
|
||||
|
|
|
|||
|
|
@ -18,12 +18,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .email
|
||||
examples:
|
||||
- .email
|
||||
example: .email
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_email.yaml'
|
||||
|
|
@ -14,12 +14,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .gemini
|
||||
examples:
|
||||
- .gemini
|
||||
example: .gemini
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_gemini.yaml'
|
||||
|
|
|
|||
|
|
@ -16,12 +16,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .gen-ai
|
||||
examples:
|
||||
- .gen-ai
|
||||
example: .gen-ai
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_genai.yaml'
|
||||
|
|
|
|||
|
|
@ -13,10 +13,8 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .index
|
||||
examples:
|
||||
- .index
|
||||
example: .index
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
|
|
@ -14,12 +14,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .jira
|
||||
examples:
|
||||
- .jira
|
||||
example: .jira
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_jira.yaml'
|
||||
|
|
@ -14,12 +14,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .opsgenie
|
||||
examples:
|
||||
- .opsgenie
|
||||
example: .opsgenie
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_opsgenie.yaml'
|
||||
|
|
@ -16,12 +16,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .pagerduty
|
||||
examples:
|
||||
- .pagerduty
|
||||
example: .pagerduty
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_pagerduty.yaml'
|
||||
|
|
@ -12,14 +12,12 @@ properties:
|
|||
connector_type_id:
|
||||
description: The type of connector.
|
||||
type: string
|
||||
examples:
|
||||
- .resilient
|
||||
example: .resilient
|
||||
enum:
|
||||
- .resilient
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_resilient.yaml'
|
||||
|
|
@ -18,12 +18,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .sentinelone
|
||||
examples:
|
||||
- .sentinelone
|
||||
example: .sentinelone
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_sentinelone.yaml'
|
||||
|
|
|
|||
|
|
@ -10,10 +10,8 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .server-log
|
||||
examples:
|
||||
- .server-log
|
||||
example: .server-log
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
|
|
@ -16,12 +16,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .servicenow
|
||||
examples:
|
||||
- .servicenow
|
||||
example: .servicenow
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_servicenow.yaml'
|
||||
|
|
@ -16,12 +16,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .servicenow-itom
|
||||
examples:
|
||||
- .servicenow-itom
|
||||
example: .servicenow-itom
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_servicenow.yaml'
|
||||
|
|
@ -16,12 +16,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .servicenow-sir
|
||||
examples:
|
||||
- .servicenow-sir
|
||||
example: .servicenow-sir
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_servicenow.yaml'
|
||||
|
|
@ -13,12 +13,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .slack_api
|
||||
examples:
|
||||
- .slack_api
|
||||
example: .slack_api
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_slack_api.yaml'
|
||||
|
|
|
|||
|
|
@ -11,12 +11,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .slack
|
||||
examples:
|
||||
- .slack
|
||||
example: .slack
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_slack_webhook.yaml'
|
||||
|
|
|
|||
|
|
@ -14,12 +14,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .swimlane
|
||||
examples:
|
||||
- .swimlane
|
||||
example: .swimlane
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_swimlane.yaml'
|
||||
|
|
@ -11,12 +11,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .teams
|
||||
examples:
|
||||
- .teams
|
||||
example: .teams
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_teams.yaml'
|
||||
|
|
@ -15,12 +15,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .tines
|
||||
examples:
|
||||
- .tines
|
||||
example: .tines
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_tines.yaml'
|
||||
|
|
@ -15,12 +15,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .torq
|
||||
examples:
|
||||
- .torq
|
||||
example: .torq
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_torq.yaml'
|
||||
|
|
@ -15,12 +15,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .webhook
|
||||
examples:
|
||||
- .webhook
|
||||
example: .webhook
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_webhook.yaml'
|
||||
|
|
@ -16,12 +16,10 @@ properties:
|
|||
description: The type of connector.
|
||||
enum:
|
||||
- .xmatters
|
||||
examples:
|
||||
- .xmatters
|
||||
example: .xmatters
|
||||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_xmatters.yaml'
|
||||
|
|
@ -1,4 +1,3 @@
|
|||
type: boolean
|
||||
description: Indicates whether the connector type is deprecated.
|
||||
examples:
|
||||
- false
|
||||
example: false
|
||||
|
|
@ -1,4 +1,3 @@
|
|||
type: boolean
|
||||
description: Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
|
||||
examples:
|
||||
- false
|
||||
example: false
|
||||
|
|
@ -2,5 +2,4 @@ type: boolean
|
|||
description: >
|
||||
Indicates whether it is a preconfigured connector.
|
||||
If true, the `config` and `is_missing_secrets` properties are omitted from the response.
|
||||
examples:
|
||||
- false
|
||||
example: false
|
||||
|
|
@ -1,4 +1,3 @@
|
|||
type: boolean
|
||||
description: Indicates whether the connector is used for system actions.
|
||||
examples:
|
||||
- false
|
||||
example: false
|
||||
|
|
@ -3,5 +3,4 @@ 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.
|
||||
examples:
|
||||
- 2
|
||||
example: 2
|
||||
|
|
@ -7,13 +7,11 @@ properties:
|
|||
class:
|
||||
description: The class or type of the event.
|
||||
type: string
|
||||
examples:
|
||||
- cpu load
|
||||
example: cpu load
|
||||
component:
|
||||
description: The component of the source machine that is responsible for the event.
|
||||
type: string
|
||||
examples:
|
||||
- eth0
|
||||
example: eth0
|
||||
customDetails:
|
||||
description: Additional details to add to the event.
|
||||
type: object
|
||||
|
|
@ -31,8 +29,7 @@ properties:
|
|||
group:
|
||||
description: The logical grouping of components of a service.
|
||||
type: string
|
||||
examples:
|
||||
- app-stack
|
||||
example: app-stack
|
||||
links:
|
||||
description: A list of links to add to the event.
|
||||
type: array
|
||||
|
|
|
|||
|
|
@ -22,13 +22,15 @@ properties:
|
|||
- required: [externalId]
|
||||
properties:
|
||||
correlation_id:
|
||||
type: ['null', string]
|
||||
type: string
|
||||
nullable: true
|
||||
description: >
|
||||
An identifier that is assigned to the incident when it is created by the connector.
|
||||
NOTE: If you use the default value and the rule generates multiple alerts that use the same alert IDs, the latest open incident for this correlation ID is closed unless you specify the external ID.
|
||||
maxLength: 100
|
||||
default: '{{rule.id}}:{{alert.id}}'
|
||||
externalId:
|
||||
type: ['null', string]
|
||||
type: string
|
||||
nullable: true
|
||||
description: The unique identifier (`incidentId`) for the incident in ServiceNow.
|
||||
|
||||
|
|
@ -30,8 +30,7 @@ properties:
|
|||
type: object
|
||||
description: The custom properties of the alert.
|
||||
additionalProperties: true
|
||||
examples:
|
||||
- {"key1":"value1","key2":"value2"}
|
||||
example: {"key1":"value1","key2":"value2"}
|
||||
entity:
|
||||
type: string
|
||||
description: The domain of the alert. For example, the application or server name.
|
||||
|
|
|
|||
|
|
@ -18,6 +18,5 @@ properties:
|
|||
id:
|
||||
type: string
|
||||
description: The Jira issue type identifier.
|
||||
examples:
|
||||
- 10024
|
||||
example: 10024
|
||||
|
||||
|
|
@ -18,5 +18,4 @@ properties:
|
|||
externalId:
|
||||
type: string
|
||||
description: The Jira, ServiceNow ITSM, or ServiceNow SecOps issue identifier.
|
||||
examples:
|
||||
- 71778
|
||||
example: 71778
|
||||
|
|
|
|||
|
|
@ -17,5 +17,4 @@ properties:
|
|||
id:
|
||||
type: string
|
||||
description: The Jira issue identifier.
|
||||
examples:
|
||||
- 71778
|
||||
example: 71778
|
||||
|
|
@ -9,7 +9,6 @@ properties:
|
|||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_cases_webhook.yaml'
|
||||
|
|
@ -10,7 +10,6 @@ properties:
|
|||
name:
|
||||
type: string
|
||||
description: The display name for the connector.
|
||||
examples:
|
||||
- my-connector
|
||||
example: my-connector
|
||||
secrets:
|
||||
$ref: 'secrets_properties_swimlane.yaml'
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
openapi: 3.1.0
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: Connectors
|
||||
description: OpenAPI schema for Connectors endpoints
|
||||
|
|
@ -14,16 +14,6 @@ tags:
|
|||
servers:
|
||||
- url: /
|
||||
paths:
|
||||
'/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}':
|
||||
|
|
@ -34,6 +24,17 @@ paths:
|
|||
$ref: paths/s@{spaceid}@api@actions@connector_types.yaml
|
||||
'/s/{spaceId}/api/actions/connector/{connectorId}/_execute':
|
||||
$ref: paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml
|
||||
# Default space
|
||||
'/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
|
||||
# Deprecated endpoints:
|
||||
'/s/{spaceId}/api/actions/action/{actionId}':
|
||||
$ref: 'paths/s@{spaceid}@api@actions@action@{actionid}.yaml'
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
openapi: 3.1.0
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: Connectors
|
||||
description: OpenAPI schema for connectors in Serverless projects
|
||||
|
|
@ -31,6 +31,9 @@ components:
|
|||
type: apiKey
|
||||
in: header
|
||||
name: Authorization
|
||||
description: 'e.g. Authorization: ApiKey base64AccessApiKey'
|
||||
description: >
|
||||
Serverless APIs support only key-based authentication.
|
||||
You must create an API key and use the encoded value in the request header.
|
||||
For example: 'Authorization: ApiKey base64AccessApiKey'.
|
||||
security:
|
||||
- apiKeyAuth: []
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
post:
|
||||
summary: Creates a connector.
|
||||
summary: Create a connector
|
||||
operationId: createConnector
|
||||
tags:
|
||||
- connectors
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
get:
|
||||
summary: Retrieves a connector by ID.
|
||||
summary: Get a connector information
|
||||
operationId: getConnector
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -21,7 +21,7 @@ get:
|
|||
$ref: '../components/responses/404.yaml'
|
||||
|
||||
delete:
|
||||
summary: Deletes a connector.
|
||||
summary: Delete a connector
|
||||
operationId: deleteConnector
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -37,7 +37,7 @@ delete:
|
|||
$ref: '../components/responses/404.yaml'
|
||||
|
||||
post:
|
||||
summary: Creates a connector.
|
||||
summary: Create a connector
|
||||
operationId: createConnectorId
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -51,8 +51,7 @@ post:
|
|||
required: true
|
||||
schema:
|
||||
type: string
|
||||
examples:
|
||||
- ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
|
||||
example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
|
|
@ -76,7 +75,7 @@ post:
|
|||
$ref: '../components/responses/401.yaml'
|
||||
|
||||
put:
|
||||
summary: Updates the attributes for a connector.
|
||||
summary: Update a connector
|
||||
operationId: updateConnector
|
||||
tags:
|
||||
- connectors
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
post:
|
||||
summary: Runs a connector.
|
||||
summary: Run 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.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
get:
|
||||
summary: Retrieves a list of all connector types.
|
||||
summary: Get all connector types
|
||||
operationId: getConnectorTypes
|
||||
tags:
|
||||
- connectors
|
||||
|
|
@ -24,41 +24,34 @@ get:
|
|||
enabled:
|
||||
type: boolean
|
||||
description: Indicates whether the connector type is enabled in Kibana.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
enabled_in_config:
|
||||
type: boolean
|
||||
description: Indicates whether the connector type is enabled in the Kibana configuration file.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
enabled_in_license:
|
||||
type: boolean
|
||||
description: Indicates whether the connector is enabled in the license.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
id:
|
||||
$ref: '../components/schemas/connector_types.yaml'
|
||||
is_system_action_type:
|
||||
type: boolean
|
||||
examples:
|
||||
- false
|
||||
example: false
|
||||
minimum_license_required:
|
||||
type: string
|
||||
description: The license that is required to use the connector type.
|
||||
examples:
|
||||
- basic
|
||||
example: basic
|
||||
name:
|
||||
type: string
|
||||
description: The name of the connector type.
|
||||
examples:
|
||||
- Index
|
||||
example: Index
|
||||
supported_feature_ids:
|
||||
type: array
|
||||
description: The features that are supported by the connector type.
|
||||
items:
|
||||
$ref: '../components/schemas/features.yaml'
|
||||
examples:
|
||||
- [alerting, cases, siem]
|
||||
example: [alerting, cases, siem]
|
||||
examples:
|
||||
getConnectorTypesServerlessResponse:
|
||||
$ref: '../components/examples/get_connector_types_generativeai_response.yaml'
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
get:
|
||||
summary: Retrieves all connectors.
|
||||
summary: Get all connectors
|
||||
operationId: getConnectors
|
||||
tags:
|
||||
- connectors
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
get:
|
||||
summary: Retrieves all connectors.
|
||||
summary: Get all connectors
|
||||
operationId: legacyGetConnectors
|
||||
deprecated: true
|
||||
description: Deprecated in 7.13.0. Use the get all connectors API instead.
|
||||
|
|
@ -20,7 +20,7 @@ get:
|
|||
$ref: '../components/responses/401.yaml'
|
||||
|
||||
post:
|
||||
summary: Creates a connector.
|
||||
summary: Create a connector
|
||||
operationId: legacyCreateConnector
|
||||
deprecated: true
|
||||
description: Deprecated in 7.13.0. Use the create connector API instead.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
delete:
|
||||
summary: Deletes a connector.
|
||||
summary: Delete a connector
|
||||
operationId: legacyDeleteConnector
|
||||
deprecated: true
|
||||
description: >
|
||||
|
|
@ -18,7 +18,7 @@ delete:
|
|||
$ref: '../components/responses/401.yaml'
|
||||
|
||||
get:
|
||||
summary: Retrieves a connector by ID.
|
||||
summary: Get connector information
|
||||
operationId: legacyGetConnector
|
||||
description: Deprecated in 7.13.0. Use the get connector API instead.
|
||||
deprecated: true
|
||||
|
|
@ -34,7 +34,7 @@ get:
|
|||
$ref: '../components/responses/401.yaml'
|
||||
|
||||
put:
|
||||
summary: Updates the attributes for a connector.
|
||||
summary: Update a connector
|
||||
operationId: legacyUpdateConnector
|
||||
deprecated: true
|
||||
description: Deprecated in 7.13.0. Use the update connector API instead.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
post:
|
||||
summary: Runs a connector.
|
||||
summary: Run a connector
|
||||
operationId: legacyRunConnector
|
||||
deprecated: true
|
||||
description: Deprecated in 7.13.0. Use the run connector API instead.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
post:
|
||||
summary: Creates a connector.
|
||||
summary: Create 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.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
get:
|
||||
summary: Retrieves a connector by ID.
|
||||
summary: Get connector information
|
||||
operationId: getConnectorWithSpaceId
|
||||
description: >
|
||||
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
|
|
@ -24,7 +24,7 @@ get:
|
|||
$ref: '../components/responses/404.yaml'
|
||||
|
||||
delete:
|
||||
summary: Deletes a connector.
|
||||
summary: Delete a connector
|
||||
operationId: deleteConnectorWithSpaceId
|
||||
description: >
|
||||
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
|
|
@ -44,7 +44,7 @@ delete:
|
|||
$ref: '../components/responses/404.yaml'
|
||||
|
||||
post:
|
||||
summary: Creates a connector.
|
||||
summary: Create a connector
|
||||
operationId: createConnectorIdWithSpaceId
|
||||
description: >
|
||||
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
|
|
@ -59,8 +59,7 @@ post:
|
|||
required: true
|
||||
schema:
|
||||
type: string
|
||||
examples:
|
||||
- ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
|
||||
example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
|
|
@ -84,7 +83,7 @@ post:
|
|||
$ref: '../components/responses/401.yaml'
|
||||
|
||||
put:
|
||||
summary: Updates the attributes for a connector.
|
||||
summary: Update a connector
|
||||
operationId: updateConnectorWithSpaceId
|
||||
description: >
|
||||
You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
post:
|
||||
summary: Runs a connector.
|
||||
summary: Run a connector
|
||||
operationId: runConnectorWithSpaceId
|
||||
description: >
|
||||
You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
get:
|
||||
summary: Retrieves a list of all connector types.
|
||||
summary: Get all connector types
|
||||
operationId: getConnectorTypesWithSpaceId
|
||||
description: >
|
||||
You do not need any Kibana feature privileges to run this API.
|
||||
|
|
@ -27,37 +27,31 @@ get:
|
|||
enabled:
|
||||
type: boolean
|
||||
description: Indicates whether the connector type is enabled in Kibana.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
enabled_in_config:
|
||||
type: boolean
|
||||
description: Indicates whether the connector type is enabled in the Kibana `.yml` file.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
enabled_in_license:
|
||||
type: boolean
|
||||
description: Indicates whether the connector is enabled in the license.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
id:
|
||||
$ref: '../components/schemas/connector_types.yaml'
|
||||
minimum_license_required:
|
||||
type: string
|
||||
description: The license that is required to use the connector type.
|
||||
examples:
|
||||
- basic
|
||||
example: basic
|
||||
name:
|
||||
type: string
|
||||
description: The name of the connector type.
|
||||
examples:
|
||||
- Index
|
||||
example: Index
|
||||
supported_feature_ids:
|
||||
type: array
|
||||
description: The Kibana features that are supported by the connector type.
|
||||
items:
|
||||
$ref: '../components/schemas/features.yaml'
|
||||
examples:
|
||||
- [alerting, uptime, siem]
|
||||
example: [alerting, uptime, siem]
|
||||
examples:
|
||||
getConnectorTypesResponse:
|
||||
$ref: '../components/examples/get_connector_types_response.yaml'
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
get:
|
||||
summary: Retrieves all connectors.
|
||||
summary: Get all connectors
|
||||
operationId: getConnectorsWithSpaceId
|
||||
description: >
|
||||
You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
get:
|
||||
summary: Retrieves a list of all connector types.
|
||||
summary: Get connector types
|
||||
operationId: legacyGetConnectorTypes
|
||||
deprecated: true
|
||||
description: Deprecated in 7.13.0. Use the get all connector types API instead.
|
||||
|
|
@ -28,8 +28,7 @@ get:
|
|||
enabledInLicense:
|
||||
type: boolean
|
||||
description: Indicates whether the connector is enabled in the license.
|
||||
examples:
|
||||
- true
|
||||
example: true
|
||||
id:
|
||||
type: string
|
||||
description: The unique identifier for the connector type.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue