Download Backblaze B2

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy 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_BACKBLAZE_B2.

bucket_namerequired string

The name of the Backblaze B2 Bucket.

source_pathrequired string

The path from which the file will be downloaded.

destination_pathrequired string

The path in which the file will be saved.

integration_hashrequired string

The ID of the integration.

regionrequired string

The name of the Backblaze region.

overwriteboolean

Replace files if they already exist.

recursiveboolean

If set to true, the whole directory tree is downloaded. Otherwise only the files from the path are downloaded.

deployment_excludesstring[]

The paths and/or files that will be excluded from the download.

deployment_includesstring[]

The exceptions from the ignore patterns set in deployment_excludes.

Last modified on Sep 27, 2024

Dockerfile Linter Download from sandbox

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 Backblaze B2/bucketname",
  "type": "DOWNLOAD_BACKBLAZE_B2",
  "trigger_time": "ON_EVERY_EXECUTION",
  "bucket_name": "bucketname",
  "source_path": "source",
  "destination_path": "destination",
  "integration_hash": "5ddb7c180fb38be67bd78a88a",
  "region": "us-east-005",
  "overwrite": true,
  "recursive": true,
  "deployment_excludes": [
    "/tmp",
    "*.log"
  ],
  "deployment_includes": [
    "/tmp/assets",
    "/tmp/styles"
  ]
}'

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/pipeline/2/action/2/edit",
  "id": 2,
  "name": "Download files from Backblaze B2/bucketname",
  "type": "DOWNLOAD_BACKBLAZE_B2",
  "trigger_time": "ON_EVERY_EXECUTION",
  "bucket_name": "bucketname",
  "source_path": "source",
  "destination_path": "destination",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "region": "us-east-005",
  "overwrite": true,
  "recursive": true,
  "deployment_excludes": [
    "/tmp",
    "*.log"
  ],
  "deployment_includes": [
    "/tmp/assets",
    "/tmp/styles"
  ],
  "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": "test server",
    "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