Build Docker Image

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to DOCKERFILE.
dockerfile_path
Required
StringThe path to the desired Dockerfile in the repository.
context_pathStringThe docker build image context path.
docker_image_tagStringThe tag of the Docker image.
loginStringThe username required to connect to the server. Required for delivering the Dockerfile to a private registry.
passwordStringThe password required to connect to the server. Required for delivering the Dockerfile to a private registry.
integrationIntegrationThe integration. Required for delivering the Dockerfile to the Amazon ECR, Google GCR and Docker Hub.
regionStringThe name of the Amazon S3 region. Required for delivering the Dockerfile to the Amazon ECR. The full list of regions is available here.
registryStringThe url to GCR. Can be one of gcr.io, us.gcr.io, eu.gcr.io or asia.gcr.io. Required for Google GCR.
repositoryStringThe location of the Docker repository.
build_argsString[]The arguments used when building the image from the Dockerfile.
insecure_registryBooleanIf set to true, ignore SSL errors upon connecting to the Docker registry.
do_not_prune_imagesBooleanIf set to true, dangling images will not be pruned after the build.
buildkitBooleanIf set to true, the Docker BuildKit will be activated while invoking the docker build command.
without_progressBooleanIf set to true, the output of the logs will be default. If set to false, the output of the logs will be displayed in the plain mode.
secret_idStringThe identifier to pass into the docker build --secret. This identifier is associated with the RUN --mount identifier to use in the Dockerfile.
secret_srcStringRenames the secret file to a specific file in the Dockerfile RUN command to use.
target_platformStringSpecifies the target platform for the build output. By default, it is set to linux/amd64. If the setting is other than default, the buildkit field is set to true. Available options: linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7, linux/arm/v.

Example

Request

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

JSON

{
  "name": "Build dockerfile",
  "type": "DOCKERFILE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "docker_image_tag": "14.06",
  "region": "us-east-1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "dockerfile_path": "dir/Dockerfile",
  "repository": "MyDockerRepo",
  "insecure_registry": true,
  "do_not_prune_images": true,
  "buildkit": true,
  "without_progress": true,
  "target_platform":"linux/386",
  "secret_id": "secretId",
  "secret_src": "path_to_secret",
  "build_args": [
     "key=value"
  ]
}

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": "Build dockerfile",
  "type": "DOCKERFILE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "trigger_time": "ON_EVERY_EXECUTION",
  "docker_image_tag": "14.06",
  "region": "us-east-1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "dockerfile_path": "dir/Dockerfile",
  "repository": "MyDockerRepo",
  "insecure_registry": true,
  "do_not_prune_images": true,
  "buildkit": true,
  "without_progress": true,
  "target_platform":"linux/386",
  "secret_id": "secretId",
  "secret_src": "path_to_secret",
  "build_args": [
     "key=value"
  ],
  "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"
  }
}