Run Docker container

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to RUN_DOCKER_CONTAINER.
docker_image_name
Required
StringThe name of the Docker image.
docker_image_tag
Required
StringThe tag of the Docker image.
inline_commands
Required
StringThe commands that will be executed.
run_as_userStringAll 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).
mount_filesystem_disableBooleanDefines whether or not to mount the filesystem to the running container.
mount_filesystem_pathStringThe directory in which the pipeline filesystem will be mounted.
loginStringThe username required to connect to the Dockerhub, private registry or GCR.
passwordStringThe password required to connect to the Dockerhub, private registry or GCR.
registryStringThe url to the Docker registry or GCR.
integration_idIntegrationThe integration. Required for using the image from the Amazon ECR.
regionStringThe name of the Amazon S3 region. Required for using the image from the Amazon ECR. The full list of regions is available here.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Run container",
"type": "RUN_DOCKER_CONTAINER",
"trigger_time": "ON_EVERY_EXECUTION",
"docker_image_name": "library/ubuntu",
"docker_image_tag": "latest",
"variables": [
{
"key": "containerUser",
"value": "notRoot"
}
],
"run_as_user": "$containerUser",
"inline_commands": "ls -al > ls.log",
"mount_filesystem_disable": false,
"mount_filesystem_path": "/buddy/my-repo-dir"
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
"id": 2,
"name": Run container",
"type": "RUN_DOCKER_CONTAINER",
"trigger_time": "ON_EVERY_EXECUTION",
"last_execution_status": "INITIAL",
"docker_image_name": "library/ubuntu",
"docker_image_tag": "latest",
"variables": [
{
"key": "containerUser",
"value": "notRoot"
}
],
"run_as_user": "$containerUser",
"inline_commands": "ls -al > ls.log",
"mount_filesystem_disable": false,
"mount_filesystem_path": "/buddy/my-repo-dir",
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}