EOS

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /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 BUILD.
docker_image_namerequired string
The name of the Docker image.
docker_image_tagrequired string
The tag of the Docker image.
execute_commandsrequired string[]
The commands that will be executed.
cached_dirsoptional string[]
The dependencies & directories to be cached and available to every execution in this pipeline.
working_directoryoptional string
The directory in which the pipeline filesystem will be mounted.
setup_commandsoptional string[]
The command that will be executed only on the first run.
servicesoptional Service[]
The containers with the services that will be attached to this environment. Available types: NODEOS, MYSQL, MONGO_DB, MARIADB, POSTGRE_SQL, REDIS, MEMCACHED, ELASTICSEARCH.

Last modified on Sep 27, 2024

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": "EOS by API",
  "type": "BUILD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "docker_image_name": "eosio/eos-dev",
  "docker_image_tag": "latest",
  "execute_commands": [
    "cleos --url http://nodeos:8888 get info"
  ],
  "working_directory": "/buddy/my-repo-dir",
  "services": [
    {
      "type": "NODEOS",
      "version": "latest",
      "persistent": false,
      "connection": {
        "host": "node.os",
        "port": 8888
      },
      "plugins": [
        "eosio::chain_api_plugin",
        "eosio::history_api_plugin",
        "eosio::history_plugin",
        "eosio::http_plugin",
        "eosio::producer_plugin",
        "eosio::wallet_plugin",
        "eosio::wallet_api_plugin"
      ]
    }
  ]
}'
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": "EOS by API", "type": "BUILD", "trigger_time": "ON_EVERY_EXECUTION", "docker_image_name": "eosio/eos-dev", "docker_image_tag": "latest", "execute_commands": [ "cleos --url http://nodeos:8888 get info" ], "working_directory": "/buddy/my-repo-dir", "services": [ { "type": "NODEOS", "version": "latest", "persistent": false, "connection": { "host": "node.os", "port": 8888 }, "plugins": [ "eosio::chain_api_plugin", "eosio::history_api_plugin", "eosio::history_plugin", "eosio::http_plugin", "eosio::producer_plugin", "eosio::wallet_plugin", "eosio::wallet_api_plugin" ] } ], "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