---
title: "Api Byoc Deployment Create"
method: POST
path: "/api/byoc/deployment/"
tags: ["platformApi"]
---

# Api Byoc Deployment Create

`POST /api/byoc/deployment/`

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.

## Headers

- `Authorization` string, required

## Request body

- DataPlaneRegistrationRequest — Input for registering / updating an org's data plane (org admin, JWT).
  - `data_plane_url` string, uri
  - `rotate_token` boolean — Rotate the service token on an existing deployment.

## Response `200`

- DataPlaneRegistrationResponse — POST /api/byoc/deployment/ response — the deployment plus the one-time token.
  - `id` integer, required
  - `data_plane_url` string, uri, required
  - `token_prefix` string, required
  - `entitlement_status` 'active' | 'trialing' | 'past_due' | 'canceled' | 'none', required — * `active` - active * `trialing` - trialing * `past_due` - past_due * `canceled` - canceled * `none` - none
  - `last_heartbeat_at` string, date-time, nullable, required
  - `token_expires_at` string, date-time, nullable, required
  - `is_active` boolean, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `service_token` string — Plaintext service token — present only on first registration or rotation, and shown ONCE; only its hash is stored.

---

[API](https://skmtc.net/keywordsai/apis/api-reference.md) · [All operations](https://skmtc.net/keywordsai/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/keywordsai/api-reference/versions/c26d550029f8/schema)
