TRtraversal
integrations-v3

Create Org Connector

Changed on

Create a new OrgConnector for an organization.

Permissions: platform admin only.

Returns HTTP 201 with the created connector.

post/internal/v3/integrations/org_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/internal/v3/integrations/org_connectors
  • Auth
    none declared

Request body

organization_idstring required

Organization ID that owns the connector

namestring required

Name of network of which the connector tunnels through. Should be a name that makes sense to the customer 'eg: XCorp VPN, XCorp k8` (unique per organization)

urlstring required

Controller URL from inside the k8s cluster

descriptionstring nullable

Optional description

Response

Successful Response

idstring required
organization_idstring required
kind'LEGACY' | 'SELF_SERVE' required
state'ACTIVE' | 'DELETED' required
namestring required
urlstring required

URL of the Edge Controller this connector's tunnel routes through (not the customer connector itself, which is outbound-only and has no reachable address)

descriptionstring nullable required
created_atstring date-time required
last_connected_atstring date-time nullable

Changes

  • 0fb124422604Revision changes
    • info

      added the optional property to the response with the status

  • 6bbc7dd4088cRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status