Skip to main content
PUT
Submit Deployment

Body

application/json

Payload for PUT /api/onboarding/deployment.

capabilities
enum<string>[]
required
Minimum array length: 1

Top-level capabilities offered on the first onboarding step.

Selecting one drives its own guided setup (see SETUP_KIND in app.services.deployment) and unlocks its nav/features (subject to license).

Available options:
runtime_security,
rag,
shadow_ai,
dlp,
data_security,
mcp_tools,
compliance,
agentic_guardrails,
api_proxy
primary_app_name
string | null
Required string length: 1 - 128

Response

Successful Response

Onboarding submit response, carries the one-time app token secret.

app_token is the minted attribution token in plaintext, returned once so the SDK/proxy snippets can use a real key. It is None when no token was minted (e.g. a Data-Security-only or Compliance-only deployment).

onboarding_complete
boolean
default:false
schema_version
integer
default:2
capabilities
string[]
selected_components
string[]
enabled_feature_keys
string[]
primary_app_uuid
string | null
completed_at
string<date-time> | null
updated_at
string<date-time> | null
app_token
string | null