Kibana connectors API
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems. Alerting rules can use connectors to run actions when rule conditions are met.
Kibana connectors API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include connectors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 8 operations across 5 paths, and defines 77 schemas. It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
8 operations
5 paths
77 schemas
1 DELETE4 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Kibana connectors API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKeyAuth).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
apiKeyAuth— These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
connectors 8
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems. Alerting rules can use connectors to run acti…
GET
/api/actions/connector_types
Get connector types
GET
/api/actions/connector/_oauth_callback
Handle OAuth callback
DELETE
/api/actions/connector/{id}
Delete a connector
GET
/api/actions/connector/{id}
Get connector information
POST
/api/actions/connector/{id}
Create a connector
PUT
/api/actions/connector/{id}
Update a connector
POST
/api/actions/connector/{id}/_execute
Run a connector
GET
/api/actions/connectors
Get all connectors
Schemas 77
The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are cases_webhook_config (19 properties), run_trigger_pagerduty (11 properties), email_config (9 properties), genai_openai_other_config (8 properties). Each schema is shown below with its type and property counts.
run_fieldsbyissuetype
object
The fieldsByIssueType subaction for Jira connectors.
2 properties
2 required
genai_openai_config
object
Defines properties for connectors when type is .gen-ai and the API provider is OpenAI.
3 properties
2 required
pagerduty_secrets
object
Defines secrets for connectors when type is .pagerduty.
1 property
1 required
opsgenie_secrets
object
Defines secrets for connectors when type is .opsgenie.
1 property
1 required
run_getagentdetails
object
The getAgentDetails subaction for CrowdStrike connectors.
2 properties
2 required
run_issuetypes
object
The issueTypes subaction for Jira connectors.
1 property
1 required
auth_type
string
The type of authentication to use: basic, SSL, or none.
index_config
object
Defines properties for connectors when type is .index.
3 properties
1 required
run_pushtoservice
object
The pushToService subaction for Jira, ServiceNow ITSM, ServiceNow SecOps, Swimlane, TheHive, and Webhook - Case Management connectors.
2 properties
2 required
tines_secrets
object
Defines secrets for connectors when type is .tines.
2 properties
2 required
genai_azure_config
object
Defines properties for connectors when type is .gen-ai and the API provider is Azure OpenAI.
2 properties
2 required
thehive_secrets
object
Defines secrets for connectors when type is .thehive.
1 property
1 required
gemini_secrets
object
Defines secrets for connectors when type is .gemini.
1 property
1 required
run_closealert
object
The closeAlert subaction for Opsgenie connectors.
2 properties
2 required
email_secrets
object
Defines secrets for connectors when type is .email.
3 properties
run_addevent
object
The addEvent subaction for ServiceNow ITOM connectors.
2 properties
1 required
has_auth
boolean
If true, a username and password for login type authentication must be provided.
bedrock_config
object
Defines properties for connectors when type is .bedrock.
3 properties
1 required
run_issues
object
The issues subaction for Jira connectors.
2 properties
2 required
sentinelone_config
object
Defines properties for connectors when type is .sentinelone.
1 property
1 required
xmatters_secrets
object
Defines secrets for connectors when type is .xmatters.
3 properties
genai_secrets
object
Defines secrets for connectors when type is .gen-ai. Supports both API key authentication (OpenAI, Azure OpenAI, and Other) and PKI authentication (Other provi…
4 properties
teams_secrets
object
Defines secrets for connectors when type is .teams.
1 property
1 required
run_validchannelid
object
Retrieves information about a valid Slack channel identifier. It is applicable only when the connector type is .slackapi.
2 properties
2 required
run_trigger_pagerduty
object
Test an action that triggers a PagerDuty alert.
11 properties
1 required
webhook_secrets
object
Defines secrets for connectors when type is .webhook.
5 properties
run_getagents
object
The getAgents subaction for SentinelOne connectors.
1 property
1 required
gemini_config
object
Defines properties for connectors when type is .gemini.
4 properties
3 required
torq_secrets
object
Defines secrets for connectors when type is .torq.
1 property
1 required
torq_config
object
Defines properties for connectors when type is .torq.
1 property
1 required
jira_secrets
object
Defines secrets for connectors when type is .jira.
2 properties
2 required
slack_api_config
object
Defines properties for connectors when type is .slackapi.
1 property
run_getchoices
object
The getChoices subaction for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors.
2 properties
2 required
cases_webhook_config
object
Defines properties for connectors when type is .cases-webhook.
19 properties
8 required
servicenow_itom_config
object
Defines properties for connectors when type is .servicenow-itom.
5 properties
1 required
crowdstrike_config
object
Defines config properties for connectors when type is .crowdstrike.
1 property
1 required
run_acknowledge_resolve_pagerduty
object
Test an action that acknowledges or resolves a PagerDuty alert.
2 properties
2 required
pfx
string
If authType is webhook-authentication-ssl and certType is ssl-pfx, it is a base64 encoded version of the PFX or P12 file.
crt
string
If authType is webhook-authentication-ssl and certType is ssl-crt-key, it is a base64 encoded version of the CRT or CERT file.
key
string
If authType is webhook-authentication-ssl and certType is ssl-crt-key, it is a base64 encoded version of the KEY file.
run_message_slack
object
Test an action that sends a message to Slack. It is applicable only when the connector type is .slack.
1 property
1 required
sentinelone_secrets
object
Defines secrets for connectors when type is .sentinelone.
1 property
1 required
d3security_config
object
Defines properties for connectors when type is .d3security.
1 property
1 required
cases_webhook_secrets
object
5 properties
run_message_email
object
Test an action that sends an email message. There must be at least one recipient in to, cc, or bcc.
5 properties
2 required
verification_mode
string
Controls the verification of certificates. Use full to validate that the certificate has an issue date within the notbefore and notafter dates, chains to a tru…
tines_config
object
Defines properties for connectors when type is .tines.
1 property
1 required
ca
string
A base64 encoded version of the certificate authority file that the connector can trust to sign and validate certificates. This option is available for all aut…
jira_config
object
Defines properties for connectors when type is .jira.
2 properties
2 required
swimlane_config
object
Defines properties for connectors when type is .swimlane.
4 properties
3 required
bedrock_secrets
object
Defines secrets for connectors when type is .bedrock.
2 properties
2 required
email_config
object
Defines properties for connectors when type is .email.
9 properties
1 required
swimlane_secrets
object
Defines secrets for connectors when type is .swimlane.
1 property
d3security_secrets
object
Defines secrets for connectors when type is .d3security.
1 property
1 required
genai_openai_other_config
object
Defines properties for connectors when type is .gen-ai and the API provider is Other (OpenAI-compatible service), including optional PKI authentication.
8 properties
3 required
servicenow_config
object
Defines properties for connectors when type is .servicenow.
6 properties
1 required
run_message_serverlog
object
Test an action that writes an entry to the Kibana server log.
2 properties
1 required
webhook_config
object
Defines properties for connectors when type is .webhook.
8 properties
run_closeincident
object
The closeIncident subaction for ServiceNow ITSM connectors.
2 properties
2 required
crowdstrike_secrets
object
Defines secrets for connectors when type is .crowdstrike.
2 properties
2 required
xmatters_config
object
Defines properties for connectors when type is .xmatters.
2 properties
run_getfields
object
The getFields subaction for Jira, ServiceNow ITSM, and ServiceNow SecOps connectors.
1 property
1 required
cert_type
string
If the authType is webhook-authentication-ssl, specifies whether the certificate authentication data is in a CRT and key file format or a PFX file format.
run_issue
object
The issue subaction for Jira connectors.
2 properties
1 required
defender_secrets
object
Defines secrets for connectors when type is ..microsoftdefenderendpoint.
1 property
1 required
resilient_secrets
object
Defines secrets for connectors when type is .resilient.
2 properties
2 required
run_documents
object
Test an action that indexes a document into Elasticsearch.
1 property
1 required
resilient_config
object
Defines properties for connectors when type is .resilient.
2 properties
2 required
pagerduty_config
object
Defines properties for connectors when type is .pagerduty.
1 property
slack_api_secrets
object
Defines secrets for connectors when type is .slack.
1 property
1 required
run_createalert
object
The createAlert subaction for Opsgenie and TheHive connectors.
2 properties
2 required
opsgenie_config
object
Defines properties for connectors when type is .opsgenie.
1 property
1 required
run_postmessage
object
Test an action that sends a message to Slack. It is applicable only when the connector type is .slackapi.
2 properties
2 required
defender_config
object
Defines properties for connectors when type is .microsoftdefenderendpoint.
5 properties
2 required
run_getincident
object
The getIncident subaction for Jira, ServiceNow ITSM, and ServiceNow SecOps connectors.
2 properties
2 required
thehive_config
object
Defines configuration properties for connectors when type is .thehive.
2 properties
1 required
servicenow_secrets
object
Defines secrets for connectors when type is .servicenow, .servicenow-sir, or .servicenow-itom.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kibana 12
Other APIs Kibana publishes across the network.
Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana Data streams API
Kibana data views API
Kibana Elastic Agent actions API
#connectors