Skip to main content
POST
Plan promotion of the current dev deployment

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}$
source_deployment_id
string
required

Current succeeded dev deployment whose immutable artifact will be promoted.

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

Response

A promotion plan with a ten-minute action-bound confirmation token.

Non-mutating guarded-action plan with a confirmation token that expires exactly ten minutes after creation.

action
enum<string>
required
Available options:
rollback,
promote,
delete
Allowed value: "rollback"
project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
target_deployment_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
target_artifact_digest
string
required
Pattern: ^sha256:[0-9a-f]{64}$
resource_etag
string
required
Required string length: 3 - 128
effects
string[]
required
Required string length: 1 - 512
risks
string[]
required
Required string length: 1 - 512
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
source_deployment_id
string
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
source_artifact_digest
string
Pattern: ^sha256:[0-9a-f]{64}$
source_environment
string
Allowed value: "dev"
target_environment
string
Allowed value: "prod"