Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
platformApi

Api Byoc Deployment Create

Register / view the calling org's BYOC data plane (org member).

POST registers the data plane (or updates its URL). A service token is issued on first registration, or when rotate_token is set — and returned once; only its hash is stored.

post/api/byoc/deployment/

Headers

Authorizationstring required

JWT access token or Respan API key

Request body

data_plane_urlstring uri
rotate_tokenboolean

Rotate the service token on an existing deployment.

Response

idinteger required
data_plane_urlstring uri required
token_prefixstring required
entitlement_status'active' | 'trialing' | 'past_due' | 'canceled' | 'none' required
  • active - active
  • trialing - trialing
  • past_due - past_due
  • canceled - canceled
  • none - none
last_heartbeat_atstring date-time nullable required
token_expires_atstring date-time nullable required
is_activeboolean required
created_atstring date-time required
updated_atstring date-time required
service_tokenstring

Plaintext service token — present only on first registration or rotation, and shown ONCE; only its hash is stored.