The builder-s3-pull command copies a file or folder from an Object Storage bucket or Magna-bucket into a specified destination folder on the instance.

JSON Input Data Format
{
    "id": string,
    "url": string,
    "path": string
}
id * Specifies the instance ID to which the files will be copied.
url * Specifies the URL to the file or folder in the bucket.
  • use "s3ob://bucketname/file.zip" to download a single file from an Object Storage bucket
  • use "s3ob://bucketname/folder/" to download an entire folder from an Object Storage bucket
  • use "s3mb://bucketname/file.zip" to download a single from a Magna bucket
  • use "s3mb://bucketname/folder/" to download an entire folder from a Magna bucket
path * Specifies the path and name of the destination folder. The path must start with a /, indicating the root of the instance.
* Indicates a mandatory field.

Code Snippets
Here are several code snippets provided for your direct use. Simply select your preferred tool/language by clicking on it.


Successful Response
{
    "result": "OK",
    "payload": "The process was successfully completed"
}

Failed Response
{
    "result": "ERR",
    "message": "Error message ..."
}