Sign in
connectors

Run a connector

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/actions/connector/{id}/_execute</span></div>

Refer to Spaces for more information.

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

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

Path parameters

idstring required

An identifier for the connector.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

Example request

{
  "params": {
    "class": "cpu load",
    "component": "eth0",
    "group": "app-stack"
  }
}

Response

Indicates a successful call.

auth_mode'shared' | 'per-user'

The authentication mode used for the connector.

configobject
connector_type_idstring required

The connector type identifier.

idstring required

The identifier for the connector.

is_connector_type_deprecatedboolean required

Indicates whether the connector type is deprecated.

is_deprecatedboolean required

Indicates whether the connector is deprecated.

is_missing_secretsboolean

Indicates whether the connector is missing secrets.

is_preconfiguredboolean required

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

is_system_actionboolean required

Indicates whether the connector is used for system actions.

namestring required

The name of the connector.

Changes

No changes recorded. 20 of the 176 revisions have no diff computed, so they could not be searched.