CTctrlplanedev

Create a deployment plan

Changed on

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

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

Request

  • Base URL
    http://localhost:3001/api
  • URL
    http://localhost:3001/api/v1/workspaces/{workspaceId}/deployments/{deploymentId}/plan
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

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

Changes

  • dad57e35a328Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 17bf3874d418Revision changes
    • info

      endpoint added