HTTP API to unzip and extract zip, jar, tar, gz, tgz, tar.gz, tar.bz2, tar.Z, or tar.xz archive files from AWS S3 into your S3 bucket

Use CloudZip HTTP API to uncompress and expand archives from Amazon S3 into your S3 bucket and automatically create all folders and files as needed during the extraction. You can call the HTTP API using HttpClient SDKs, or curl from a script or command line.

Updating your account token, keys, and balance in the Settings page is required to run the service using the API. When you Sign In and click Settings, you'll be taken to a page where you should enter the following required information in the fields to use the HTTP API. :

• API Token - either create a new token, or set the token to a custom value. The API token, in combination with your username, must be included in the HTTP request to run a service.

• AWS Access Key ID - enter your AWS Access Key ID for your IAM user with access to AWS S3. When you call the HTTP API with your user and token, it uses this key. If you don't know your keys, we recommend you create a new user for your AWS account, with S3 access, using the AWS Identity and Access Management page. It is easy, see the CloudZip IAM User Setup page for more information.

• Secret Access Key - enter your AWS Secret Access Key for your IAM user with access to AWS S3. When you call the HTTP API with your user and token, it uses this key

• Account Balance - use Amazon Payments to accumulate credit in your account to use toward CloudZip API and other services.

After you have entered the above information, you should successfully call the HTTP API to run CloudZip archive extraction services. Next follow the Usage Examples.

Usage of CloudZip HTTP API service to expand archives

Use the HTTP API to programmatically and asynchronously expand archive files in Amazon S3. Only successfully verified and submitted HTTP API requests are charged the full service amount. You can run the API using HttpClient SDKs, or curl from a script or command line.

HTTP Method and URL: POST https://www.cloudzipinc.com/api/s3archiveextract

Required HTTP Header:

• X-AUTH-USER - required, your username that you use to sign in to CloudZip, it is displayed in the welcome message header.
• X-AUTH-TOKEN - required, your token as displayed in the Settings page. Sign in and click Settings to set or obtain your token.

Required Parameters:

• destination - required, the S3 bucket and optional folder path that you would like to use as the destination for the expanded archive file (e.g. /mybucket/folder, or /mybucket). Note: the bucket and folder (if specified) must already be created, and the extraction will replace existing destination objects with same path and name as those contained in the archive. Any folders within the archive will be created in the destination as needed.
• source - required, the archive file's S3 bucket name and path that you would like expanded into the destination folder (e.g. /mybucket/uploads/files.tar.gz ). The source should refer to one file.

Example curl command-line

In this example below the $AUTH_TOKEN, $AUTH_USER, and the paths are example values, you'll need to replace them with your own values. It is common to define the AUTH values as environment variables before running a scripted sequence of curl commands. Be sure to use POST and Accept: application/json.

Linux/MacOS bash

export AUTH_TOKEN=124567890abcdefghijklmopqrstuvwxyz
export AUTH_USER=test

curl -X POST -H "X-AUTH-TOKEN:$AUTH_TOKEN"
-H "X-AUTH-USER:$AUTH_USER"-H "Accept: application/json"
-H "Content-Type: application/x-www-form-urlencoded"
-d "destination=/mybucket/folder&source=/mybucket/uploads/new.zip"
"https://www.cloudzipinc.com/api/s3archiveextract"

Response:
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache
Content-Length: 110
{"status":"success","message":"submitted extraction of
/mybucket/uploads/new.zip to /mybucket/folder"}

Windows, curl app (https://curl.haxx.se/dlwiz/)

c:\curl-7.61.0-win32-mingw\bin>
set AUTH_TOKEN=124567890abcdefghijklmopqrstuvwxyz
set AUTH_USER=test

curl -X POST -H "X-AUTH-TOKEN:%AUTH_TOKEN%"
-H "X-AUTH-USER:%AUTH_USER%" -H "Accept: application/json"
-H "Content-Type: application/x-www-form-urlencoded"
-d "destination=/mybucket/folder&source=/mybucket/uploads/new.zip"
"https://www.cloudzipinc.com/api/s3archiveextract"

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache
Content-Length: 110
{"status":"success","message":"submitted extraction of
/mybucket/uploads/new.zip to /mybucket/folder"}

If your parameters are incorrect, an error response similar to this example below will be displayed:

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache
Content-Length: 175
{"status":"error","message":"required parameter
incorrect or missing", "error":"Your X-AUTH-USER was incorrect,
it is the username to sign in to your cloudzipinc.com account"}

Priced at $ 1.00 USD per use per gigabyte, or $ 1.00 USD per archive.

To see more details and start a service, click the Register link above, or Sign In if you have already registered.