Copy files

  • 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 COPY_FILES.
source_pipelineoptional Pipeline
The object with the id of the pipeline from which files will be copied. If not set, the source pipeline will be the current pipeline.
target_pipelineoptional Pipeline
The object with the id of the pipeline to which files will be copied. If not set, the target pipeline will be the current pipeline.
source_pathoptional string
The path in the source pipeline’s filesystem.
target_pathoptional string
The path in the current pipeline’s filesystem.
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.
copy_hidden_filesoptional boolean
When set to true the hidden files and folders (the ones with the name beginning with a ".") are copied.

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": "Copy files from another pipeline",
  "type": "COPY_FILES",
  "copy_hidden_files": true,
  "trigger_time": "ON_EVERY_EXECUTION",
  "source_pipeline": {
    "id": 2
  },
  "target_pipeline": {
    "id": 3
  },
  "source_path": "/",
  "target_path": "Home/www/",
  "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/855", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/855/edit", "id": 1, "name": "Copy files from another pipeline", "type": "COPY_FILES", "copy_hidden_files": true, "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "source_pipeline": { "id": 2 }, "target_pipeline": { "id": 3 }, "source_path": "/", "target_path": "Home/www/", "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