Create a connector with a random ID

POST /api/actions/connector

The connector identifier is randomly generated.

Headers

  • kbn-xsrf string Required

    Cross-site request forgery protection

application/json; Elastic-Api-Version=2023-10-31

Body object Required

The properties vary depending on the connector type.

One of:
Connectors_create_connector_request_bedrock object Connectors_create_connector_request_gemini object Connectors_create_connector_request_cases_webhook object Connectors_create_connector_request_d3security object Connectors_create_connector_request_email object Connectors_create_connector_request_genai object Connectors_create_connector_request_index object Connectors_create_connector_request_jira object Connectors_create_connector_request_opsgenie object Connectors_create_connector_request_pagerduty object Connectors_create_connector_request_resilient object Connectors_create_connector_request_sentinelone object Connectors_create_connector_request_serverlog object Connectors_create_connector_request_servicenow object Connectors_create_connector_request_servicenow_itom object Connectors_create_connector_request_servicenow_sir object Connectors_create_connector_request_slack_api object Connectors_create_connector_request_slack_webhook object Connectors_create_connector_request_swimlane object Connectors_create_connector_request_teams object Connectors_create_connector_request_tines object Connectors_create_connector_request_torq object Connectors_create_connector_request_webhook object Connectors_create_connector_request_xmatters object

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31

    Indicates a successful call.

    The properties vary depending on the connector type.

    One of:
    Connectors_connector_response_properties_bedrock object Connectors_connector_response_properties_gemini object Connectors_connector_response_properties_cases_webhook object Connectors_connector_response_properties_d3security object Connectors_connector_response_properties_email object Connectors_connector_response_properties_genai object Connectors_connector_response_properties_index object Connectors_connector_response_properties_jira object Connectors_connector_response_properties_opsgenie object Connectors_connector_response_properties_pagerduty object Connectors_connector_response_properties_resilient object Connectors_connector_response_properties_sentinelone object Connectors_connector_response_properties_serverlog object Connectors_connector_response_properties_servicenow object Connectors_connector_response_properties_servicenow_itom object Connectors_connector_response_properties_servicenow_sir object Connectors_connector_response_properties_slack_api object Connectors_connector_response_properties_slack_webhook object Connectors_connector_response_properties_swimlane object Connectors_connector_response_properties_teams object Connectors_connector_response_properties_tines object Connectors_connector_response_properties_torq object Connectors_connector_response_properties_webhook object Connectors_connector_response_properties_xmatters object
  • 401 application/json; Elastic-Api-Version=2023-10-31

    Authorization information is missing or invalid.

    Hide response attributes Show response attributes object
POST /api/actions/connector 
curl \
 -X POST https://localhost:5601/api/actions/connector \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "kbn-xsrf: string"
Request examples 
{
  "name": "email-connector-1",
  "config": {
    "from": "tester@example.com",
    "host": "https://example.com",
    "port": 1025,
    "secure": false,
    "hasAuth": true,
    "service": "other"
  },
  "secrets": {
    "user": "username",
    "password": "password"
  },
  "connector_type_id": ".email"
}
{
  "name": "my-connector",
  "config": {
    "index": "test-index"
  },
  "connector_type_id": ".index"
}
{
  "name": "my-webhook-connector",
  "config": {
    "url": "https://example.com",
    "method": "post",
    "authType": "webhook-authentication-ssl",
    "certType": "ssl-crt-key"
  },
  "secrets": {
    "crt": "QmFnIEF0dH...",
    "key": "LS0tLS1CRUdJ...",
    "password": "my-passphrase"
  },
  "connector_type_id": ".webhook"
}
{
  "name": "my-xmatters-connector",
  "config": {
    "usesBasic": false
  },
  "secrets": {
    "secretsUrl": "https://example.com?apiKey=xxxxx"
  },
  "connector_type_id": ".xmatters"
}
Response examples (200) 
{
  "id": "90a82c60-478f-11ee-a343-f98a117c727f",
  "name": "email-connector-1",
  "config": {
    "from": "tester@example.com",
    "host": "https://example.com",
    "port": 1025,
    "secure": false,
    "hasAuth": true,
    "service": "other",
    "clientId": null,
    "tenantId": null,
    "oauthTokenUrl": null
  },
  "is_deprecated": false,
  "is_preconfigured": false,
  "is_system_action": false,
  "connector_type_id": ".email",
  "is_missing_secrets": false
}
{
  "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
  "name": "my-connector",
  "config": {
    "index": "test-index",
    "refresh": false,
    "executionTimeField": null
  },
  "is_deprecated": false,
  "is_preconfigured": false,
  "is_system_action": false,
  "connector_type_id": ".index",
  "is_missing_secrets": false
}
{
  "id": "900eb010-3b9d-11ee-a642-8ffbb94e38bd",
  "name": "my-webhook-connector",
  "config": {
    "url": "https://example.com",
    "method": "post",
    "hasAuth": true,
    "headers": null,
    "authType": "webhook-authentication-ssl",
    "certType": "ssl-crt-key",
    "verificationMode": "full"
  },
  "is_deprecated": false,
  "is_preconfigured": false,
  "is_system_action": false,
  "connector_type_id": ".webhook",
  "is_missing_secrets": false
}
{
  "id": "4d2d8da0-4d1f-11ee-9367-577408be4681",
  "name": "my-xmatters-connector",
  "config": {
    "configUrl": null,
    "usesBasic": false
  },
  "is_deprecated": false,
  "is_preconfigured": false,
  "is_system_action": false,
  "connector_type_id": ".xmatters",
  "is_missing_secrets": false
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "string",
  "statusCode": 401
}