Connector Gateway API reference
The Connector Gateway API serves the calling user's view of the gateway: each
connector's upstream connection status and tools, and the flow that connects a
connector on the user's behalf. Users enable and disable their connectors
through the
Enterprise Manager API
at /v1/me/connections. See
Configure the Connector Gateway.
Base URL
The REST API uses the control-plane Service (controlPlane.port, default
8090, with controlPlane.enabled: true). The MCP endpoint serves client tool
calls on the gateway's data-plane Service. To expose this REST API externally,
route to the control-plane Service and use that route's HTTPS base URL.
With the default Service name and port, the in-cluster base URL is:
http://<RELEASE_NAME>-connector-gateway-control-plane.<NAMESPACE>.svc:8090
<RELEASE_NAME> is your platform Helm release name. Helm name overrides can
change the Service name, and values overrides can change the port. Check your
installed Services:
kubectl get svc -n <NAMESPACE>
For a local connection, forward the Service's HTTP port:
kubectl port-forward -n <NAMESPACE> svc/<SERVICE_NAME> 8080:8090
Replace <SERVICE_NAME> with the installed Service name. Keep the command
running in a separate terminal. Your local base URL is http://localhost:8080.
Append each endpoint path to the base URL once; for example,
http://localhost:8080/v1/users/me/gateway/connectors/status. API
authentication still applies when using a port-forward.
For external access, ask your platform administrator for this API's HTTPS base
URL. To publish it, configure your ingress or gateway controller to route to
<RELEASE_NAME>-connector-gateway-control-plane on port 8090 in the Service's
namespace, using the installed name and port if overridden.
For routing and verification steps, see Publish and verify the Connector Gateway endpoints.
The interactive reference uses http://localhost:8080, which matches the
port-forward above. For calls from inside the cluster or through an external
endpoint, replace that address with your deployment's base URL.