Sign in
connectors

Create 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}</span></div>

Refer to Spaces for more information.

post/api/actions/connector/{id}

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

connector_type_idstring required

The type of connector.

namestring required

The display name for the connector.

Example request

{
  "config": {
    "apiUrl": "https://events.pagerduty.com/v2/enqueue"
  }
}

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

Changed in 2 of the 93 revisions of this API.111

  • cef1cb82d51410See the full diff
    • ○

      added the new optional request property config/oneOf[subschema #22: Connector request properties for a Webhook connector]/accessTokenUrl

      new-optional-request-property

    • ○

      added the new optional request property config/oneOf[subschema #22: Connector request properties for a Webhook connector]/additionalFields

      new-optional-request-property

    • ○

      added the new optional request property config/oneOf[subschema #22: Connector request properties for a Webhook connector]/clientId

      new-optional-request-property

    • ○

      added the new optional request property config/oneOf[subschema #22: Connector request properties for a Webhook connector]/scope

      new-optional-request-property

    • ○

      added the new optional request property secrets/oneOf[subschema #20: Connector secrets properties for a Webhook connector]/clientSecret

      new-optional-request-property

    • ○

      added the new delete enum value to the request property config/oneOf[subschema #22: Connector request properties for a Webhook connector]/method

      request-property-enum-value-added

    • ○

      added the new get enum value to the request property config/oneOf[subschema #22: Connector request properties for a Webhook connector]/method

      request-property-enum-value-added

    • ○

      added the new patch enum value to the request property config/oneOf[subschema #22: Connector request properties for a Webhook connector]/method

      request-property-enum-value-added

    • ○

      added the new webhook-oauth2-client-credentials enum value to the request property config/oneOf[subschema #22: Connector request properties for a Webhook connector]/authType

      request-property-enum-value-added

    • ○

      added the new webhook-oauth2-client-credentials enum value to the request property config/oneOf[subschema #23: Connector request properties for Webhook - Case Management connector]/authType

      request-property-enum-value-added

  • 342514d5974311See the full diff
    • ▲

      the config/oneOf[subschema #23: Connector request properties for Webhook - Case Management connector]/headers request property type/format changed from string/ to object/

      request-property-type-changed

    • ○

      the request property config/oneOf[subschema #23: Connector request properties for Webhook - Case Management connector]/headers became nullable

      request-property-became-nullable