POST /api/actions/connector/{id}
Api key auth

Spaces method and path for this operation:

post /s/{space_id}/api/actions/connector/{id}

Refer to Spaces for more information.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

Path parameters

  • id string Required

    An identifier for the connector.

application/json

Body

  • connector_type_id string Required

    The type of connector.

  • name string Required

    The display name for the connector.

  • config object

    The connector configuration details.

    One of:
    Connector request properties for an Amazon Bedrock connector object Connector request config properties for a Crowdstrike connector object Connector request properties for a D3 Security connector object Connector request properties for an email connector object Connector request properties for an Google Gemini connector object Connector request properties for a IBM Resilient connector object Connector request properties for an index connector object Connector request properties for a Jira connector object Connector request properties for an OpenAI connector that uses Azure OpenAI object Connector request properties for an OpenAI connector object Connector request properties for an OpenAI connector with Other provider object Connector request properties for an Opsgenie connector object Connector request properties for a PagerDuty connector object Connector request properties for a SentinelOne connector object Connector request properties for a ServiceNow ITSM connector object Connector request properties for a ServiceNow ITOM connector object Connector request properties for a Slack connector object Connector request properties for a Swimlane connector object Connector request properties for a TheHive connector object Connector request properties for a Tines connector object Connector request properties for a Torq connector object Connector request properties for a Webhook connector object Connector request properties for Webhook - Case Management connector object Connector request properties for an xMatters connector object

  • secrets object

    One of:
    Connector secrets properties for an Amazon Bedrock connector object Connector secrets properties for a Crowdstrike connector object Connector secrets properties for a D3 Security connector object Connector secrets properties for an email connector object Connector secrets properties for a Google Gemini connector object Connector secrets properties for IBM Resilient connector object Connector secrets properties for a Jira connector object Connector secrets properties for a Microsoft Defender for Endpoint connector object Connector secrets properties for a Microsoft Teams connector object Connector secrets properties for an OpenAI connector object Connector secrets properties for an Opsgenie connector object Connector secrets properties for a PagerDuty connector object Connector secrets properties for a SentinelOne connector object Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors object Connector secrets properties for a Web API Slack connector object Connector secrets properties for a Swimlane connector object Connector secrets properties for a TheHive connector object Connector secrets properties for a Tines connector object Connector secrets properties for a Torq connector object Connector secrets properties for a Webhook connector object Connector secrets properties for Webhook - Case Management connector object Connector secrets properties for an xMatters connector object

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • config object

      Additional properties are allowed.

    • connector_type_id string Required

      The connector type identifier.

    • id string Required

      The identifier for the connector.

    • is_connector_type_deprecated boolean Required

      Indicates whether the connector type is deprecated.

    • is_deprecated boolean Required

      Indicates whether the connector is deprecated.

    • is_missing_secrets boolean

      Indicates whether the connector is missing secrets.

    • is_preconfigured boolean Required

      Indicates whether the connector is preconfigured. If true, the config and is_missing_secrets properties are omitted from the response.

    • is_system_action boolean Required

      Indicates whether the connector is used for system actions.

    • name string Required

      The name of the connector.
  • 403

    Indicates that this call is forbidden.

POST /api/actions/connector/{id} 
curl \
 --request POST 'https://<KIBANA_URL>/api/actions/connector/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"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"}'
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": "df770e30-8b8b-11ed-a780-3b746c987a81",
  "name": "my_server_log_connector",
  "config": {},
  "is_deprecated": false,
  "is_preconfigured": false,
  "is_system_action": false,
  "connector_type_id": ".server-log",
  "is_missing_secrets": false
}