Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesIntegrationsSelf-HostedYAMLBuddy GitTroubleshootingAPI

Push Docker 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
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to DOCKER_PUSH.
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 string
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 the 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.
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.

Last modified on Oct 7, 2024

Previous pagePublish Bundle to Google PlayNext pagePushbullet

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": "Push to registry",
  "type": "DOCKER_PUSH",
  "trigger_time": "ON_EVERY_EXECUTION",
  "docker_image_tag": "14.06",
  "region": "us-east-1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "docker_build_action_id": 1,
  "repository": "MyDockerRepo"
}'
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/pipeline/2/action/2/edit",
  "id": 2,
  "name": "Push to registry",
  "type": "DOCKER_PUSH",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "docker_build_action_id": 1,
  "docker_image_tag": "14.06",
  "region": "us-east-1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "repository": "MyDockerRepo",
  "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