integrations-v3

Create Connector

Changed on

Create a self-serve Connector owned by the caller's organization.

post/v3/connectors

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
  • Auth
    none declared

Request body

namestring required

Connector display name

descriptionstring nullable

Optional connector description

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

    • 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 201

    • info

      added the required property to the response with the status