Skip to main content
POST
Plan a Dev and Prod data assignment change

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
change
enum<string>
required

Owner-confirmed assignment change. No application data is copied; physical resources are provisioned lazily.

Available options:
isolate_prod_keeps_data,
isolate_dev_keeps_data,
share_prod_keeps_data,
reset_dev

Response

The data assignment plan and its exact destructive effects.

An action-bound ten-minute plan naming retained, retired and lazily created data areas. The workspace Owner confirms its destructive effects before execution.

action
string
required
Allowed value: "data_change"
project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
change
enum<string>
required

Owner-confirmed assignment change. No application data is copied; physical resources are provisioned lazily.

Available options:
isolate_prod_keeps_data,
isolate_dev_keeps_data,
share_prod_keeps_data,
reset_dev
data_mode_before
enum<string>
required
Available options:
shared,
isolated
data_mode_after
enum<string>
required
Available options:
shared,
isolated
effects
string[]
required
Maximum array length: 32
Required string length: 1 - 2000
destructive_effects
string[]
required
Maximum array length: 32
Required string length: 1 - 2000
redeploy_environments
enum<string>[]
required
Required array length: 1 element
Available options:
dev,
prod
risks
string[]
required
Maximum array length: 32
Required string length: 1 - 2000
resource_etag
string
required

Send as If-Match with this plan's confirmation token.

Pattern: ^"sha256-[a-f0-9]{64}"$
confirmation_token
string
required

Opaque, single-action token bound to the planned action, project, target resource, and resource ETag.

Required string length: 32 - 4096
Pattern: ^[A-Za-z0-9._~-]+$
created_at
string<date-time>
required
expires_at
string<date-time>
required