API and protocols overview
Map Control Plane entry points for HTTP OpenAPI, gRPC, xDS, and compatibility protocols.
This section covers the public entry points and default ports of pole-control-plane. It is for integrators: which port, which protocol, and which path prefix. Console workflows stay in Guides. Protobuf message details stay in Specification.
Protocol map
| Entry | Default port | Primary readers | Docs |
|---|---|---|---|
| Console HTTP | 8080 | Platform operators | Using the Console |
| HTTP API (OpenAPI-style) | 8090 | Scripts, automation, Console-backed calls | HTTP OpenAPI |
| Discovery gRPC | 8091 | SDK / client discovery and registration | gRPC |
| Config gRPC | 8093 | SDK / client configuration | gRPC |
| xDS v3 | 15010 | Envoy / data plane | xDS |
| Eureka / Nacos / Apollo | 8761 / 8848 (+9848 gRPC) / 8890 | Legacy client compatibility | Compatibility |
Full port matrix: Protocol ports. Authoritative config: pole-control-plane/deploy/conf/pole-apiserver.yaml.
Read with these boundaries
- Control-plane HTTP OpenAPI is not the same as user service-contract OpenAPI. The former is the control plane REST surface; the latter is contract text that services may report via discovery (
ReportServiceContract). - Protocol adapters parse requests and identity carriers; authorization runs in domain Server interceptors. See Authorization and resources.
- HTTP OpenAPI is split by scenario (namespaces, services, instances, config, governance, and more), with a parameters-left / examples-right layout. Full schemas still follow control-plane annotations and the running server.
Suggested order
- Protocol ports: confirm which listeners are enabled.
- HTTP OpenAPI: browse management and client REST by scenario.
- gRPC or xDS: pick by runtime.
- For legacy registries, read Compatibility.