API availability
Nexo does not publish a public Control Plane REST or gRPC API contract today. The
authenticated console, nexoctl, and internal service-to-service calls use the Control
Plane's request/response shapes, but this documentation set does not expose those as a
stable, versioned, externally consumable API — no endpoint list, request/response
schema, or client library is published here, and none should be assumed or reverse
engineered from CLI behavior. See
Control Plane connectivity and targeting
for what is explicitly not a documented public contract (host names, interval
timings, and gRPC method shapes included).
The rest of this page lists the surfaces that are documented and intended for external use, so "no public REST API" doesn't mean "no way to integrate."
Documented, supported surfaces
| Surface | What it is | Reference |
|---|---|---|
Kubernetes CRDs (nexo.io API group) | The primary way to configure Nexo declaratively — a real Kubernetes API extension, versioned v1alpha1 | CRD catalog |
| Step contract | A versioned protobuf/gRPC contract (nexo.step.v1.StepService) that pipeline steps implement | Step contract reference |
| nexoctl | The command-line surface for diagnostics, support bundles, and plugin development | nexoctl command reference |
What this means in practice
- Configuring Nexo: use the CRDs through
kubectl/GitOps tooling, or the console — not a hand-rolled Control Plane API client. - Building a pipeline step: implement the step contract — see Marketplace & extensions for the current SDK and packaging status.
- Automating operational tasks: use the documented
nexoctlcommands — see the command reference for which are implemented versus operationally supported today. - Integrating with the Control Plane directly: not currently supported as a public contract. Do not build automation against observed console network traffic or CLI request shapes — they can change without notice because they are not published as a stable API.