Sign in
integrations-v3

Update Connector

Update an active Connector owned by the caller's organization.

patch/v3/connectors/{connector_id}

Path parameters

connector_idstring required

Request body

namestring nullable

Updated Connector display name

descriptionstring nullable

Updated Connector description; null clears it

Response

Successful Response

idstring required
namestring required
descriptionstring nullable required
kind'LEGACY' | 'SELF_SERVE' required
created_atstring date-time required
controller_urlstring required

Public Edge Controller URL that customer Connectors dial. This is the environment's edge.<base-domain> host, not the in-cluster URL stored on org_connectors.url.

Changes

Changed in 2 of the 57 revisions of this API.21

  • 4a44357734442See the full diff
    • ▲

      the response property /// became optional for the status

      response-property-became-optional

    • ▲

      response property status/anyOf[subschema #1]/oneOf[subschema #1: ConnectedConnectorStatus]/active_connection_count list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    This revision also has 331 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cc0d29e474a31See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

Of the 57 revisions, 9 have no diff computed.