TRtraversal
integrations-v3

Update Connector

Changed on

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

patch/v3/connectors/{connector_id}

Request

  • Base URL
    https://api.traversal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.traversal.com/v3/connectors/{connector_id}
  • Auth
    none declared

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

  • 4a4435773444Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      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

  • cc0d29e474a3Revision changes
    • info

      added the required property to the response with the status