Sign in

v1

latestOpenAPI 3.0.02026-07-1799139348.0 KB

Create a deployment plan

Compute a dry-run plan showing rendered diffs for each release target without creating a version.

post/v1/workspaces/{workspaceId}/deployments/{deploymentId}/plan

Path parameters

workspaceIdstring required

ID of the workspace

deploymentIdstring required

ID of the deployment

Request body

metadataobject

Arbitrary key-value metadata for the plan (e.g. GitHub PR links, CI run URLs)

Response

OK response

idstring required
status'computing' | 'completed' | 'failed' required