cdnca

API reference

/v1/gateway-bindings

1 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
POST/v1/gateway-bindings/completeGateway installer completes a binding with its one-time token (public, rate limited per source)Public

Contract file：api/openapi/v1/control.yaml

Operation details

POST /v1/gateway-bindings/complete

Gateway installer completes a binding with its one-time token (public, rate limited per source)

operationId
completeAgentGatewayBinding
Auth
  • No authentication.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

The installer generated both private keys locally and verified the token's root CA fingerprint against /downloads/gateway-ca.pem first. Returns the client certificate (URI SAN spiffe://cdn-platform/gateway/<gateway_id>, 30 days), the node channel server certificate (90 days), CA bundles and the remote endpoints.

Request body

application/json · Required：Yes

completeAgentGatewayBinding Request body
NameTypeRequiredDescription
tokenstringYesgwt1.<gateway_id>.<root CA SHA-256 first 16 bytes hex>.<secret>
client_csr_derstring(byte)YesEd25519 CSR.
server_csr_derstring(byte)YesECDSA P-256 CSR.
enrollment_portintegerYes—
agent_portintegerYes—
versionstringNo—

Responses

completeAgentGatewayBinding Responses
StatusDescription
200Bound.

Fields：gateway_id: string(uuid) installation_id: string(uuid) workload_uri_san: string client_certificate_pem: string server_certificate_pem: string root_ca_pem: string node_ca_pem: string endpoints: object

401gateway_binding_token_invalid (unknown
409gateway_remote_access_disabled
422invalid_input (ports
429rate_limited

What to do on failure

  • 401 Check the credential format and whether it expired or was rotated.
  • 409 Read the current state first; a retry of the same operation keeps the original Idempotency-Key and body.
  • 429 Rate limited: wait, then retry with lower concurrency.

↑ Back to list