Terraform Plan

View as Markdown

GET
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions
/:action_id

Returns details of a single Terraform Plan action

Request

REQUIRED SCOPES

PIPELINE_READ

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

project_namerequiredstring

The human-readable ID of the project

Example: "my-project"

pipeline_idrequiredinteger

The ID of the pipeline

Example: 123

action_idrequiredinteger

The ID of the action

Example: 456

Response

RESPONSE BODY

typestring

The type of the action

Value: TERRAFORM_PLAN

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

idinteger

The ID of the action

namestring

The name of the action

current_revisionstring

The git revision of the last successful run of the action

trigger_timestring enum

Specifies when the action should be executed

Allowed enum:

ON_EVERY_EXECUTION,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

trigger_conditionsTriggerConditionView[]

The list of trigger conditions to meet so that the action can be triggered

run_nextstring enum

Defines whether the action should run in parallel with the next one

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE

variablesEnvironmentVariableView[]

The list of variables you can use the action

disabledboolean

When set to true the action is disabled. By default it is set to false

timeoutinteger

The timeout in seconds

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions

retry_countinteger

Number of retries if the action fails

retry_intervalinteger

Delay time between auto retries in seconds

last_execution_statusstring enum

The status of the last run of the action

Allowed enum:

INPROGRESS,

ENQUEUED,

TERMINATED,

SUCCESSFUL,

FAILED,

INITIAL,

NOT_EXECUTED,

SKIPPED,

TERMINATING,

WAITING_FOR_APPLY,

WAITING_FOR_VARIABLES,

WAITING_FOR_SETTABLE_VARIABLES,

WAITING_FOR_VT_SESSION

pipelineShortPipelineView

Short representation of a pipeline

permissionsPermissionsView

Access permissions configuration

loopstring[]

The list of commands that will be executed in a loop

toolstring enum

The Terraform tool to run: OPENTOFU, TERRAFORM (FOSS, up to 1.5.7) or CUSTOM

Allowed enum:

OPENTOFU,

TERRAFORM,

CUSTOM

versionstring

Tool version, e.g. 1.9.0 or latest. Required unless tool is CUSTOM

custom_binary_pathstring

Path to the binary inside the Docker image, e.g. /usr/local/bin/tofu. Required when tool is CUSTOM

docker_image_namestring

Custom Docker image to run in. Defaults to the Buddy Terraform runner

docker_image_tagstring

Tag of the custom Docker image

image_locationstring enum

The location of the image used by the action

Allowed enum:

PUBLIC_REGISTRY,

PRIVATE_REGISTRY,

ACTION,

ARTIFACT_REGISTRY

docker_registrystring enum

The type of registry from which the image is retrieved

Allowed enum:

NONE,

DOCKER_HUB,

AMAZON_ECR,

GOOGLE_GCR,

GOOGLE_ARTIFACT_REGISTRY,

OTHER,

GIT_HUB_CONTAINER_REGISTRY,

ARTIFACT_REGISTRY,

DIGITAL_OCEAN_CONTAINER_REGISTRY

registrystring

The URL of the Docker registry

loginstring

The username for the Docker registry

passwordstring

The password for the Docker registry

regionstring

The region for the Docker registry (for AWS ECR)

integrationIntegrationIdentifierView

The integration used by the action

working_directorystring

Path relative to the repository root. Defaults to .

tf_workspacestring

Terraform workspace to run in, exported to the tool as TF_WORKSPACE. Set the same value in the Plan and Apply actions, otherwise Apply runs against a different state. Defaults to default, or to TF_WORKSPACE set as a pipeline variable

additional_argsstring

Extra CLI arguments appended to the command, as a single space-separated string

backendTerraformRunBackendView

The Terraform state backend configuration

Last modified on Sep 21, 2026

Add action Edit action

Request example

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions/:action_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"

STATUS
200 OK