Find connectors API

edit

Retrieves information about connectors.

In particular, only the connectors that are supported for use in cases are returned. Refer to the list of supported external incident management systems in Add connectors.

For the most up-to-date API details, refer to the open API specification.

Request

edit

GET <kibana host>:<port>/api/cases/configure/connectors/_find

GET <kibana host>:<port>/s/<space_id>/api/cases/configure/connectors/_find

Prerequisites

edit

You must have read privileges for the Actions and Connectors feature in the Management section of the Kibana feature privileges.

Path parameters

edit
<space_id>
(Optional, string) An identifier for the space. If it is not specified, the default space is used.

Response codes

edit
200
Indicates a successful call.

Examples

edit
GET api/cases/configure/connectors/_find

The API returns a JSON object describing the connectors and their settings:

[{
  "id":"61787f53-4eee-4741-8df6-8fe84fa616f7",
  "actionTypeId": ".jira",
  "name":"my-Jira",
  "isMissingSecrets":false,
  "config": {
    "apiUrl":"https://elastic.atlassian.net/",
    "projectKey":"ES"
  },
  "isPreconfigured":false,
  "isDeprecated": false,
  "referencedByCount":0
}]