API ReferencePlatform API

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.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Request

This endpoint expects an object.
data_plane_urlstringOptionalformat: "uri"<=500 characters
rotate_tokenbooleanOptionalDefaults to false
Rotate the service token on an existing deployment.

Response

idintegerRead-only
data_plane_urlstringRead-onlyformat: "uri"
token_prefixstringRead-only
entitlement_statusenum
  • active - active
  • trialing - trialing
  • past_due - past_due
  • canceled - canceled
  • none - none
last_heartbeat_atdatetime or nullRead-only
token_expires_atdatetime or nullRead-only
is_activebooleanRead-only
created_atdatetimeRead-only
updated_atdatetimeRead-only
service_tokenstring

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