Tag Docker Image

  • POST
  • /workspaces
  • /:workspace
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
workspacerequired string
The workspace name.
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 PROMOTE_IMAGE.
same_locationrequired boolean
If set to true, promotes the image within the same registry (only tag changes). If false, promotes between different registries.
srcrequired ImageDefinition
Source configuration defining where to pull the image from.
destrequired ImageDefinition
Destination configuration defining where to push the image to.

Last modified on Jun 12, 2025

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Promote to production tag",
  "type": "PROMOTE_IMAGE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "same_location": true,
  "src": {
    "docker_registry": "DOCKER_HUB",
    "image": "mycompany/myapp:latest",
    "integration": "docker_hub_integration"
  },
  "dest": {
    "docker_registry": "GOOGLE_ARTIFACT_REGISTRY",
    "registry": "us-central1-docker.pkg.dev",
    "image": "my-gcp-project/my-repo/myapp:production",
    "integration": "google_service_account"
  }
}'
EXAMPLE RESPONSE
{ "name": "Promote from Docker Hub to Artifact Registry", "type": "PROMOTE_IMAGE", "trigger_time": "ON_EVERY_EXECUTION", "same_location": false, "src": { "docker_registry": "DOCKER_HUB", "image": "mycompany/myapp:latest", "integration": "docker_hub_integration" }, "dest": { "docker_registry": "GOOGLE_ARTIFACT_REGISTRY", "registry": "us-central1-docker.pkg.dev", "image": "my-gcp-project/my-repo/myapp:production", "integration": "google_service_account" } }
STATUS
200 OK
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999