Run Docker container

View as Markdown

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

Returns details of a single Run Docker container action

Request

REQUIRED SCOPES

EXECUTION_INFO

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 enum

The type of the action

Allowed enum:

RUN_DOCKER_CONTAINER

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_SUCCESS,

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

working_directorystring

The directory in which the pipeline filesystem will be mounted

main_service_namestring

The hostname of the container in which the action is run. The container will be available under this name in the docker network for services

run_as_userstring

All build commands are run as the default user defined in the selected Docker image. Can be set to another username (on the condition that this user exists in the selected image)

versionstring

The version of the package from package registry

docker_image_namestring

The name of the Docker image

docker_image_tagstring

The tag of the Docker image

execute_commandsstring[]

The commands that will be executed

mount_filesystem_disableboolean

If set to true, the filesystem will not be mounted in the container

volume_mappingsstring[]

The path preceding the colon is the filesystem path (the folder from the filesystem to be mounted in the container). The path after the colon is the container path (the path in the container, where this filesystem will be located)

cached_dirsstring[]

The dependencies & directories to be cached and available to every execution in this pipeline

setup_commandsstring[]

The command that will be executed only on the first run

servicesServiceView[]

The list of services attached to the build environment

shellstring enum

The name of the shell that will be used to execute commands

Allowed enum:

SH,

BASH,

POWERSHELL

registrystring

The URL of the Docker registry

insecure_registryboolean

If set to true, the registry will be accessed over HTTP instead of HTTPS

loginstring

The username for the Docker registry

target_stagestring

The target stage of the Dockerfile

passwordstring

The password for the Docker registry

regionstring

The region for the Docker registry (for AWS ECR)

image_locationstring enum

The location of the image used by the action

Allowed enum:

PUBLIC_REGISTRY,

PRIVATE_REGISTRY,

ACTION,

PACKAGE_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,

PACKAGE_REGISTRY,

DIGITAL_OCEAN_CONTAINER_REGISTRY

docker_build_action_idinteger

The ID of the action from which the Docker image will be used

docker_build_action_namestring

The name of the action from which the Docker image will be used

export_container_pathstring

The path in the container to export

execute_every_commandboolean

If set to true all commands will be executed regardless of the result of the previous command

ignore_image_pull_failuresboolean

If set to true, use cached image on timeouts (only for official images)

cache_base_imageboolean

If set to true, the cached version of the image is used, instead of being pulled each time

reset_entrypointboolean

If set to true, resets the default entrypoint set by the image. Default value: false

vt_suitestring

The visual tests suite identifier

unit_tests_suitestring

The unit tests suite identifier

unit_tests_pathstring

The path to the unit tests results

integrationIntegrationIdentifierView

The integration used by the action

entrypointstring

The entrypoint to use for the Docker container

inline_commandsstring

The commands to execute inside the Docker container

packagestring

The identifier of the package from package registry

Last modified on Feb 18, 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