Manage a connector

Connectors are governed egress paths to private upstreams. The safe pattern for any disruptive change is assess impact first, then transition lifecycle. See Private connectivity.

Requires platform_admin (or equivalent)

Connector lifecycle changes require platform/operate permissions in the target environment.

List connectors and their health

List connectors and status

UIAPICLI

1. Open Operate → Connectors to see each connector's state and dependents.

GET/v1/connectors

Copy

curl "$GATEWAY/v1/connectors?environment_id=prod" \
-H "authorization: Bearer $TOKEN"

View listConnectors in the API reference →

Copy

gatewayctl connectors list --format json

Also: gatewayctl connector-status for a single connector's lifecycle.

Assess impact before disabling

See what a connector change would affect

UIAPICLI

1. Open the connector and view Impact — the servers, routes, and sessions that depend on it.

GET/v1/connectors/{connector_id}/impact

Copy

curl "$GATEWAY/v1/connectors/conn_eu_private/impact" \
-H "authorization: Bearer $TOKEN"

View getConnectorImpact in the API reference →

Copy

gatewayctl connectors get conn_eu_private --format json

Review dependents before disabling; impact is metadata-only.

Transition the lifecycle

Disable, re-enable, or revoke a connector

UIAPICLI

1. From the connector, choose Disable, Re‑enable, or Revoke and confirm.

POST/v1/connectors/{connector_id}/lifecycle

Copy

curl -X POST \
"$GATEWAY/v1/connectors/conn_eu_private/lifecycle" \
-H "authorization: Bearer $TOKEN" \
-H "content-type: application/json" \
--data '{"transition": "disable", "reason_code": "maintenance"}'

View transitionConnectorLifecycle in the API reference →

Copy

gatewayctl connectors disable conn_eu_private --format json

connectors supports list / get / disable / reenable / revoke.

Tip

Always run impact analysis first — disabling a connector affects every route and session that depends on it, and revocation takes effect on the next request.