Create a connector Deprecated

POST /api/actions/action
Api key auth Basic auth

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

application/json

Body

  • actionTypeId string Required

    The connector type identifier.

  • config object

    Default value is {} (empty). Additional properties are allowed.

  • name string Required

    The display name for the connector.

  • secrets object

    Default value is {} (empty). Additional properties are allowed.

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_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 rule.
POST /api/actions/action 
curl \
 --request POST 'https://localhost:5601/api/actions/action' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"actionTypeId":"string","config":{},"name":"string","secrets":{}}'
Request examples 
# Headers
kbn-xsrf: true

# Payload
{
  "actionTypeId": "string",
  "config": {},
  "name": "string",
  "secrets": {}
}
Response examples (200) 
{
  "config": {},
  "connector_type_id": "string",
  "id": "string",
  "is_deprecated": true,
  "is_missing_secrets": true,
  "is_preconfigured": true,
  "is_system_action": true,
  "name": "string"
}