Docker

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.

execute_commandsrequired string[]

The commands that will be executed.

setup_commandsstring[]

The command that will be executed only on the first run.

integrationstring

The integration. Required to authorize in Amazon ECR, Google GCR and Docker Hub.

regionstring

The name of the Amazon region. If the Amazon ECR integration has been selected, provide the region to authorize in. The full list of regions is available here.

registrystring

Provide if you want to authorize in a private registry or Google GCR. For GCR, it can be one of gcr.io, us.gcr.io, eu.gcr.io or asia.gcr.io.

loginstring

The username required to authorize in a private registry.

passwordstring

The password required to authorize in a private registry.

shellstring

The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.

execute_every_commandboolean

If set to true, all commands will be executed regardless of the result of the previous command.

Last modified on Sep 27, 2024

Discord notification Docker CLI

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": "Run docker commands",
  "type": "DOCKER",
  "trigger_time": "ON_EVERY_EXECUTION",
  "execute_commands": [
    "docker --version"
  ],
  "setup_commands": [
    "apt-get update -y",
    "apt-get install -y wget"
  ],
  "shell": "SH",
  "region": "us-east-1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}'

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": "Run docker commands",
  "type": "DOCKER",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "execute_commands": [
    "docker --version"
  ],
  "setup_commands": [
    "apt-get update -y",
    "apt-get install -y wget"
  ],
  "shell": "SH",
  "region": "us-east-1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "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",
    "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