Run a connector

Base URL: https://{kibana_url}

POST /api/actions/connector/{id}/_execute

Auth

You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.

Path parameters

id string required: An identifier for the connector.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

params union oneOf required: One of:

Responses

Indicates a successful call.

application/json

auth_mode enum: The authentication mode used for the connector.; Values: shared per-user
config map string to object
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.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/actions/connector/ID/_execute
{
  "params": {
    "documents": [
      {
        "id": "my_doc_id",
        "name": "my_doc_name",
        "message": "hello, world"
      }
    ]
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/actions/connector/${ID}/_execute" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "documents": [
        {
          "id": "my_doc_id",
          "name": "my_doc_name",
          "message": "hello, world"
        }
      ]
    }
  }'

Generated from the API spec

Response

{
  "connector_id": "fd38c600-96a5-11ed-bb79-353b74189cba",
  "data": {
    "errors": false,
    "items": [
      {
        "create": {
          "_id": "4JtvwYUBrcyxt2NnfW3y",
          "_index": "my-index",
          "_primary_term": 1,
          "_seq_no": 0,
          "_shards": {
            "failed": 0,
            "successful": 1,
            "total": 2
          },
          "_version": 1,
          "result": "created",
          "status": 201
        }
      }
    ],
    "took": 135
  },
  "status": "ok"
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/actions/connector/ID/_execute
{
  "params": {
    "subAction": "issueTypes"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/actions/connector/${ID}/_execute" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "subAction": "issueTypes"
    }
  }'

Generated from the API spec

Response

{
  "connector_id": "fd38c600-96a5-11ed-bb79-353b74189cba",
  "data": {
    "errors": false,
    "items": [
      {
        "create": {
          "_id": "4JtvwYUBrcyxt2NnfW3y",
          "_index": "my-index",
          "_primary_term": 1,
          "_seq_no": 0,
          "_shards": {
            "failed": 0,
            "successful": 1,
            "total": 2
          },
          "_version": 1,
          "result": "created",
          "status": 201
        }
      }
    ],
    "took": 135
  },
  "status": "ok"
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/actions/connector/ID/_execute
{
  "params": {
    "subAction": "getChoices",
    "subActionParams": {
      "fields": [
        "severity",
        "urgency"
      ]
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/actions/connector/${ID}/_execute" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "subAction": "getChoices",
      "subActionParams": {
        "fields": [
          "severity",
          "urgency"
        ]
      }
    }
  }'

Generated from the API spec

Response

{
  "connector_id": "fd38c600-96a5-11ed-bb79-353b74189cba",
  "data": {
    "errors": false,
    "items": [
      {
        "create": {
          "_id": "4JtvwYUBrcyxt2NnfW3y",
          "_index": "my-index",
          "_primary_term": 1,
          "_seq_no": 0,
          "_shards": {
            "failed": 0,
            "successful": 1,
            "total": 2
          },
          "_version": 1,
          "result": "created",
          "status": 201
        }
      }
    ],
    "took": 135
  },
  "status": "ok"
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/actions/connector/ID/_execute
{
  "params": {
    "subAction": "postMessage",
    "subActionParams": {
      "channelIds": [
        "C123ABC456"
      ],
      "text": "A test message."
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/actions/connector/${ID}/_execute" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "subAction": "postMessage",
      "subActionParams": {
        "channelIds": [
          "C123ABC456"
        ],
        "text": "A test message."
      }
    }
  }'

Generated from the API spec

Response

{
  "connector_id": "fd38c600-96a5-11ed-bb79-353b74189cba",
  "data": {
    "errors": false,
    "items": [
      {
        "create": {
          "_id": "4JtvwYUBrcyxt2NnfW3y",
          "_index": "my-index",
          "_primary_term": 1,
          "_seq_no": 0,
          "_shards": {
            "failed": 0,
            "successful": 1,
            "total": 2
          },
          "_version": 1,
          "result": "created",
          "status": 201
        }
      }
    ],
    "took": 135
  },
  "status": "ok"
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/actions/connector/ID/_execute
{
  "params": {
    "subAction": "pushToService",
    "subActionParams": {
      "comments": [
        {
          "commentId": 1,
          "comment": "A comment about the incident."
        }
      ],
      "incident": {
        "caseId": "1000",
        "caseName": "Case name",
        "description": "Description of the incident."
      }
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/actions/connector/${ID}/_execute" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "params": {
      "subAction": "pushToService",
      "subActionParams": {
        "comments": [
          {
            "commentId": 1,
            "comment": "A comment about the incident."
          }
        ],
        "incident": {
          "caseId": "1000",
          "caseName": "Case name",
          "description": "Description of the incident."
        }
      }
    }
  }'

Generated from the API spec

Response

{
  "connector_id": "fd38c600-96a5-11ed-bb79-353b74189cba",
  "data": {
    "errors": false,
    "items": [
      {
        "create": {
          "_id": "4JtvwYUBrcyxt2NnfW3y",
          "_index": "my-index",
          "_primary_term": 1,
          "_seq_no": 0,
          "_shards": {
            "failed": 0,
            "successful": 1,
            "total": 2
          },
          "_version": 1,
          "result": "created",
          "status": 201
        }
      }
    ],
    "took": 135
  },
  "status": "ok"
}