ZIP

  • 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 of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to ZIP.
local_pathrequired string
The path in the repository.
destinationrequired string
The target path.
deployment_excludesoptional string[]
The paths and/or files that will be left out during the deployment.
deployment_includesoptional string[]
The exceptions from the ignore patterns set in deployment_excludes.

Last modified on Oct 7, 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": "Zippy zip",
  "type": "ZIP",
  "trigger_time": "ON_EVERY_EXECUTION",
  "local_path": "/dir_to_zip",
  "destination": "package.zip",
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ]
}'
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/845", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/845/edit", "id": 845, "name": "Zippy zip", "type": "ZIP", "local_path": "/dir_to_zip", "destination": "package.zip", "trigger_time": "ON_EVERY_EXECUTION", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "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