Run Docker container

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to RUN_DOCKER_CONTAINER.

docker_image_namerequired string

The name of the Docker image.

docker_image_tagrequired string

The tag of the Docker image.

inline_commandsrequired string

The commands that will be executed.

run_as_useroptional string

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).

mount_filesystem_disableoptional boolean

Defines whether or not to mount the filesystem to the running container.

volume_mappingsoptional string[]

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).

loginoptional string

The username required to connect to a private registry.

passwordoptional string

The password required to connect to a private registry.

registryoptional string

The url to the Docker registry or GCR. Required for Google GCR.

export_container_pathoptional string

Defines the export path of the container’s filesystem as a tar archive.

integrationoptional Integration

The integration. Required for using the image from the Amazon ECR, Google GCR and Docker Hub.

regionoptional string

The name of the Amazon S3 region. Required for using the image from the Amazon ECR. The full list of regions is available here.

use_image_from_actionoptional boolean

If set to true the Docker image will be taken from action defined by docker_build_action_id.

docker_build_action_idoptional integer

The ID of the action which built the desired Docker image. If set to 0, the image will be taken from previous pipeline action. Can be used instead of docker_build_action_name.

docker_build_action_nameoptional string

The name of the action which built the desired Docker image. Can be used instead of docker_build_action_id.

entrypointoptional string

Default command to execute at runtime. Overwrites the default entrypoint set by the image.

Last modified on Oct 7, 2024

Rsync (Private key from environment variables)Sentry notification

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Run container",
  "type": "RUN_DOCKER_CONTAINER",
  "docker_image_name": "library/ubuntu",
  "docker_image_tag": "latest",
  "inline_commands": "ls -al > ls.log",
  "run_as_user": "$containerUser",
  "mount_filesystem_disable": false,
  "export_container_path": "/exportPath",
  "volume_mappings": [
    "/:/buddy/mount/directory"
  ],
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "variables": [
    {
      "key": "containerUser",
      "value": "notRoot"
    }
  ],
  "entrypoint": "/bin/sh"
}'

EXAMPLE RESPONSE
{
  "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",
  "inline_commands": "ls -al > ls.log",
  "run_as_user": "$containerUser",
  "mount_filesystem_disable": false,
  "volume_mappings": [
    "/:/buddy/mount/directory"
  ],
  "export_container_path": "/exportPath",
  "entrypoint": "/bin/sh",
  "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",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999