Sign in

The run's machine-readable plan

Changed on

The resource changes the plan makes, with values the plan marks sensitive withheld from callers who may not manage this workspace's state.

get/workspaces/{workspaceId}/runs/{runId}/plan-json

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/workspaces/{workspaceId}/runs/{runId}/plan-json
  • Auth: HTTP bearer

Path parameters

workspaceIdstring required
runIdstring required

Response

The projected plan

format_versionstring required
sensitive_values_redactedboolean

Values the plan marks sensitive were withheld and read "(sensitive value)". Unmarked values ARE present in cleartext — this names a subset, unlike attributes_redacted on the state surface, where every value is gone. Absent for callers who may manage this workspace's state, which is the bar the raw state download sits at — a plan's before and after are state attributes under another name.

Changes

  • d2498b25c74dRevision changes
    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status