connectors

Update a connector

Changed on

Spaces method and path for this operation:

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

Refer to Spaces for more information.

put/api/actions/connector/{id}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/actions/connector/{id}
  • Auth
    • API key in header Authorization
    • or HTTP basic

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

is_inbound_events_enabledboolean

Turn receiving inbound events on or off. Omit to keep the current setting. Only valid for connectors that both send and receive.

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_inbound_events_enabledboolean

Indicates whether this connector can receive inbound events. Always true for inbound-only connectors. For connectors that also send actions, true after inbound events have been turned on.

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

  • cef1cb82d514Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new delete enum value to the request property //

    • info

      added the new get enum value to the request property //

    • info

      added the new patch enum value to the request property //

    • info

      added the new webhook-oauth2-client-credentials enum value to the request property //

    • info

      added the new webhook-oauth2-client-credentials enum value to the request property //

  • 342514d59743Revision changes
    • breaking

      the // request property type changed from string to object

    • info

      the request property // became nullable