Build multi-arch image

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

actionrequired string

The ID of the action.

typerequired string

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

dockerfile_pathrequired string

The path of the desired dockerfile in the repository. Default is DOCKERFILE.

context_pathstring

The docker build image context path.

target_stagestring

Specifes an intermediate build stage by name as a final stage for the resulting image. Commands after the target stage are skipped.

secret_idstring

The identifier to pass into the docker build --secret. This identifier is associated with the RUN --mount identifier to use in the Dockerfile.

secret_srcstring

Renames the secret file to a specific file in the Dockerfile RUN command to use.

build_argsstring[]

The arguments used when building the image from the Dockerfile.

target_platformstring[]

Specifies the target platform for the build output. You can set multiple target platforms. Default value: linux/amd64. Available values: linux/amd64, linux/arm64, linux/arm/v7, linux/arm/v6.

docker_image_tagstring

The tag of the Docker image.

loginstring

The username required to connect to the server. Required for delivering the Dockerfile to a private registry.

passwordstring

The password required to connect to the server. Required for delivering the Dockerfile to a private registry.

integration_hashstring

The ID of the integration. Required for delivering the Dockerfile to the Amazon ECR, Google GCR and Docker Hub.

regionstring

The name of the Amazon S3 region. Required for delivering the Dockerfile to the Amazon ECR. The full list of regions is available here.

registrystring

The url to GCR. Can be one of gcr.io, us.gcr.io, eu.gcr.io or asia.gcr.io. Required for Google GCR.

repositorystring

The location of the Docker repository.

cache_modestringBETA

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 Sep 27, 2024

Build Flutter App Clear Cache

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 multi-arch image",
  "type": "DOCKER_BUILD_MULTI_ARCH",
  "build_args": [
    "key=value"
  ],
  "dockerfile_path": "Dockerfile",
  "context_path": "/contextPath",
  "target_stage": "$targetStage",
  "secret_id": "$secretId",
  "secret_src": "$path_to_secret",
  "target_platform": "linux/amd64,linux/arm64"
}'

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 multi-arch image",
  "type": "DOCKER_BUILD_MULTI_ARCH",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "dockerfile_path": "Dockerfile",
  "target_platform": "linux/amd64,linux/arm64",
  "secret_id": "$secretId",
  "secret_src": "$path_to_secret",
  "build_args": [
    "key=value"
  ],
  "context_path": "/contextPath",
  "target_stage": "$targetStage",
  "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
  }
}

STATUS
201 Created

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