XExenovia
deployments

Update Deployment Route

Changed on
patch/api/v1/deployments/{deployment_id}

Request

  • Base URL
    https://cp.xenovia.io (the document declares no server; this is the origin it was published from)
  • URL
    https://cp.xenovia.io/api/v1/deployments/{deployment_id}
  • Auth
    none declared

Path parameters

deployment_idstring uuid required

Headers

Authorizationstring nullable
X-Request-IDstring nullable

Request body

namestring nullable
ingress_urlstring nullable
data_plane_urlstring nullable

Response

Successful Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
org_idstring uuid required
namestring required
status'pending' | 'active' | 'revoked' required

Lifecycle of a hybrid data-plane deployment.

pending — created; bootstrap token issued but not yet redeemed active — agent bootstrapped; deployment credential valid revoked — credential invalidated; the agent can no longer sync

ingress_urlstring nullable required
data_plane_urlstring nullable required
bootstrap_expires_atstring date-time nullable required
last_seen_atstring date-time nullable required
agent_versionstring nullable required
runtime_versionsobject nullable required
spool_depthinteger nullable required
ch_schema_versioninteger nullable required
sync_lag_secondsinteger nullable required

Changes