Build Docker Image

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /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 DOCKERFILE.
dockerfile_pathrequired string
The path to the desired Dockerfile in the repository. Default is DOCKERFILE.
context_pathoptional string
The docker build image context path.
docker_image_tagoptional string
The tag of the Docker image.
loginoptional string
The username required to connect to the server. Required for delivering the Dockerfile to a private registry.
passwordoptional string
The password required to connect to the server. Required for delivering the Dockerfile to a private registry.
integrationoptional Integration
Integration The integration. Required for delivering the Dockerfile to the Amazon ECR, Google GCR, Google Artifact Registry, GitHub Container Registry, Docker Hub.
docker_registryoptional string
Registry type. Available values: NONE, DOCKER_HUB, AMAZON_ECR, GOOGLE_GCR, GOOGLE_ARTIFACT_REGISTRY, GIT_HUB_CONTAINER_REGISTRY, OTHER. Required for GIT_HUB_CONTAINER_REGISTRY
regionoptional Integration
The name of the Amazon S3 region. Required for delivering the Dockerfile to the Amazon ECR. The full list of regions is available here.
registryoptional string
The url to GCR. Can be one of gcr.io, us.gcr.io, eu.gcr.io or asia.gcr.io. Required for Google GCR.
repositoryoptional string
The location of the Docker repository.
build_argsoptional string[]
The arguments used when building the image from the Dockerfile.
insecure_registryoptional boolean
If set to true, ignore SSL errors upon connecting to the Docker registry.
do_not_prune_imagesoptional boolean
If set to true, dangling images will not be pruned after the build.
buildkitoptional boolean
The Docker BuildKit will be activated while invoking the docker build command. By default, it is set to true.
secretsoptional DockerBuildSecret[]
The list of secrets to be sent using the --secret parameter.
provenanceoptional string
Refers to the --provenance switch of the Docker build. Available values: NONE, MIN, MAX. The default value is NONE.
cache_modeoptional stringBETA
Available if the cache_scope in the pipeline where this action is located, is set to WORKSPACE or PROJECT. Defines the Docker cache mode. Available values are MIN or MAX. By default, it is set to MIN.

Last modified on Oct 3, 2024

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": "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,
  "secrets": [
    {
      "id": "someSecret",
      "value": "path_to_secret",
      "type": "FILE"
    },
    {
      "id": "mysecret",
      "value": "MY_ENV_VAR_KEY",
      "type": "ENV"
    }
  ],
  "build_args": [
    "key=value"
  ]
}'
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": "Build dockerfile", "type": "DOCKERFILE", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "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, "secrets": [ { "id": "someSecret", "value": "path_to_secret", "type": "FILE" }, { "id": "mysecret", "value": "MY_ENV_VAR_KEY", "type": "ENV" } ], "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999