Docker
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to DOCKER . |
execute_commands Required | String[] | The commands that will be executed. |
setup_commands | String[] | The command that will be executed only on the first run. |
integration | String | The integration. Required to authorize in Amazon ECR, Google GCR and Docker Hub. |
region | String | 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. |
registry | String | 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. |
login | String | The username required to authorize in a private registry. |
password | String | The password required to authorize in a private registry. |
shell | String | The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH . |
execute_every_command | Boolean | If set to true , all commands will be executed regardless of the result of the previous command. |
Sample Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{
{
"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"
}
}
}
Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"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"
}
}
Last modified on January 30, 2023