Download from sandbox

  • 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 DOWNLOAD_FROM_SANDBOX.
source_pathoptional string
The path from which the file will be downloaded.
destination_pathoptional string
The path in which the file will be saved.
deployment_excludesoptional string[]
The paths and/or files that will be excluded from the upload.
deployment_includesoptional string[]
The exceptions from the ignore patterns set in deployment_excludes.
sandbox_referencesrequired string
Defines the sandbox selection method. Available values: BY_TAGS, BY_NAME, BY_PROJECT, BY_DAYS, BY_ID, BY_ACTION.
sandbox_idoptional string
The ID of the sandbox to which the files are uploaded. Required when sandbox_references is set to BY_ID.
referenced_action_idoptional int
The ID of the action that creates the target sandbox. Required when sandbox_references is set to BY_ACTION.
referenced_sanbox_nameoptional string
The name of the target sandbox. Required when sandbox_references is set to BY_NAME.
tagsoptional string[]
The list of tags applied to the target sandbox. Required when sandbox_references is set to BY_TAGS.
sandbox_project_idoptional int
The ID of the project with the target sandbox. Required when sandbox_references is set to BY_PROJECT.
daysoptional int
The number of days passed since the creation of the target sandbox. One of 1, 2, 3, 7, 14, 30. Required when sandbox_references is set to BY_DAYS.
recursiveoptional boolean
If set to true, the whole directory tree is downloaded. Otherwise only the files from the path are downloaded.
overwriteoptional boolean
Replace files if they already exist.

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": "Download files from a sandbox",
  "type": "DOWNLOAD_FROM_SANDBOX",
  "trigger_time": "ON_EVERY_EXECUTION",
  "source_path": "/assets/",
  "destination_path": "/",
  "deployment_excludes": [
    "/tmp/"
  ],
  "deployment_includes": [
    "/tmp/file.txt"
  ],
  "recursive": true,
  "overwrite": true,
  "sandbox_id": "Cgn3QO34klUri",
  "sandbox_references": [
    "BY_ID"
  ]
}'
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": "Download files from a sandbox", "type": "DOWNLOAD_FROM_SANDBOX", "trigger_time": "ON_EVERY_EXECUTION", "source_path": "/assets/", "destination_path": "/", "deployment_excludes": [ "/tmp/" ], "deployment_includes": [ "/tmp/file.txt" ], "recursive": true, "overwrite": true, "sandbox_id": "Cgn3QO34klUri", "sandbox_references": [ "BY_ID" ], "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