{"info":{"_postman_id":"30f4a97a-a714-f508-4862-f70dda8456d6","name":"s3zipper API","description":"

Welcome to the s3zipper API documentation. S3zipper allows users to zip files in AWS S3.

\n
\n

See more GitHub examples & ask questions at :

\n\n
\n

Home Page:

\n\n

Amazon Web Service(AWS EC2 AMI) Marketplace:
- https://aws.amazon.com/marketplace/seller-profile?id=abd52fdf-6ddb-4408-ae73-cc5a7e1f3b3f&ref=dtl_B0727QDVXV

\n

Support for V1 & V2 will be available till further notice.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1946477","collectionId":"30f4a97a-a714-f508-4862-f70dda8456d6","publishedId":"7EK4qUX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-12-06T02:22:04.000Z"},"item":[{"name":"Introduction To S3zipper Usage","item":[],"id":"a6ce5590-6367-4a62-bb58-47469c87f171","description":"

HOW TO USE S3ZIPPER API

\n\n

S3zipper has a lot of examples to follow inPostman.

\n\n

NB: There are four steps for using the Main Web API & three steps for using the EC2 version:

\n\n

GETTING USERKEY & USERSECRET (WEB API ONLY)

\n\n


First create an account if you don't have one here:
https://s3zipper.com/registration/register


\n\n

else, login here:

\n

https://s3zipper.com/registration/login

\n

Get the user key and user secret here:

\n

https://s3zipper.com/auth/develop

\n

USING THE MAIN WEB API (V1 & V2)

\n\n

API = The API call

\n\n

DOCS = The documentation for this API

\n\n


1. Generate the token
API : https://api.s3zipper.com/gentoken
DOCS :https://docs.s3zipper.com/#6ed32e6a-62c8-e2db-c01a-f768c75d3904


\n\n

API : https://api.s3zipper.com/tokenv2
DOCS :

\n

https://docs.s3zipper.com/#76e66131-c5e7-4f59-8495-f5f216c01bd3

\n

2 a). Start a zipping process that generates a downloadable web URL using the token. It returns a Job ID.

\n

API : https://api.s3zipper.com/v1/streamzip
DOCS :

\n

https://docs.s3zipper.com/#c1a1f851-cdb6-5d63-eeea-87bbb34799b1

\n

API : https://api.s3zipper.com/v2/streamzip
DOCS :

\n

https://docs.s3zipper.com/#b764bd66-8810-46ad-9e49-526b34d7af8d

\n

This API call starts immediately and returns Job ID ASAP.

\n\n \n

API : https://api.s3zipper.com/v2/streamzipid
DOCS :

\n

https://docs.s3zipper.com/#0e823ce3-f1f7-4c0a-b2ae-1deee3601baa

\n

2 b) Start a zipping process that zips files directly to AWS S3 bucket using token. It returns Job ID.

\n

API : https://api.s3zipper.com/v1/zipstart
DOCS :

\n

https://docs.s3zipper.com/#7487bc23-8253-a58f-2a45-3c7fdb5ea823

\n

API : https://api.s3zipper.com/v2/zipstart
DOCS :

\n

https://docs.s3zipper.com/#12577969-697b-4cf6-8dfd-c6346f287cc6

\n

This API call starts immediately and returns Job ID ASAP.

\n\n \n

API : https://api.s3zipper.com/v2/zipstartid
DOCS :

\n

https://docs.s3zipper.com/#aaef002d-f261-4717-bd5c-3b4ff5dbe06b

\n

3. Check the status of the Job ID. Not ideal for getting results.

\n

API : https://api.s3zipper.com/v1/zipstate
DOCS :

\n

https://docs.s3zipper.com/#5440bd09-0c64-794c-0c92-d58af30c313f

\n

API : https://api.s3zipper.com/v2/zipstate
DOCS :

\n

https://docs.s3zipper.com/#a329ba75-5039-47f8-a31b-89f284cba35f

\n

4. Get the result using Job ID.

\n

API : https://api.s3zipper.com/v1/zipresult
DOCS :

\n

https://docs.s3zipper.com/#fc7934f5-405c-3c2c-05f5-3f2803638a32

\n

API : https://api.s3zipper.com/v2/zipresult
DOCS :

\n

https://docs.s3zipper.com/#6087f2fe-e8af-4a31-b46c-9ce57d4ff30c

\n

USING THE EC2 VERSIONS (V1 & V2)

\n\n


The EC2 version has two simple steps.


\n\n

1 a). Start a zipping process that generates a downloadable web URL. It returns a Job ID.

\n

API : http:///v1/streamzip

\n

DOCS :

\n

https://docs.s3zipper.com/#09d11725-479d-49af-89a4-236a9245c23d

\n

API : http:///v2/streamzip
DOCS :

\n

https://docs.s3zipper.com/#fd653b3a-7e63-485e-8210-842eac9eb399

\n

1 b). Start a zipping process that zips files directly to AWS S3 bucket. It returns Job ID.

\n

API : http:///v1/s3zip
DOCS :

\n

https://docs.s3zipper.com/#f34b1b49-9518-4690-b29f-6cee9b6326a7

\n

API : http:///v2/s3zip
DOCS :

\n

https://docs.s3zipper.com/#90c2c0cc-afbf-4fbe-9cb3-040d8fe9a480

\n

2. Check the status of Job ID. It returns the status with result or errors.

\n

API : http:///v1/status
DOCS :

\n

https://docs.s3zipper.com/#500ed591-f317-4ad2-b870-cf8923bf11d4

\n

API : http:///v2/status
DOCS :

\n

https://docs.s3zipper.com/#7e282bbb-834e-48a5-9044-cde15e2cd042

\n","_postman_id":"a6ce5590-6367-4a62-bb58-47469c87f171"},{"name":"S3zipper Input Variables","item":[],"id":"90637e84-c60d-412e-9a84-ccd6b2dc4d52","description":"

S3zipper Input Variables

\n

Main Input Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionAvailableExample
awsKeyStringAws Key (Required)V1 & V2{{awsKey}}
awsSecretStringAws Secret (Required)V1 & V2{{awsSecret}}
awsBucketStringAws Bucket (Required)V1 & V2{{awsBucket}}
awsRegionStringAws Region (Required)V1 & V2{{awsRegion2}}
awsTokenStringAws Token (Optional)V1 & V2{{awsToken}}
awsEndpointStringAws Endpoint (Optional)V1 & V2{{awsEndpoint}}
filePathsArray/ListFile or Folder path in S3 bucket (Required)V1 & V2{{awsBucket}}/files/pigeon.jpg}}, {{awsBucket}}/files}}
expireLinkpositive 64-bit integersExpire link in hours. Default is 720 hours or 30 days. Must be a positive integer greater than or equal to 1 (Optional)V1 & V224
zipToStringZip To Folder In BucketV1 & V2{{my-destination-bucket}}/myzips
zipFileNameStringSpecify zip file name if not already specified in zipToV1 & V2myzipname.zip
shortUrlStringCreate a short Url using Firebase Dynamic Links. Original URL is returned if there is a problem. Default is TrueV1 & V2 (Web Only)`true, TRUE, True, false, False, FALSE`
resultsEmailStringoptional. Send results to email only if provided. This is only a convenience method for testing. Not guaranteed to deliver consistently if used in production.V1 & V2{{my-email}}
compressionStringUse no compress option on generated zips if falseV1 & V2`\"true\", \"false\"`
compressLevel Integer Level of file compression needed. Default for zip is 8 V2 range [-2, 9] : HuffmanOnly(fastest) = -2, NoCompression(faster) = 0, BestSpeed(fast) = 1, BestCompression(slower) = 9, DefaultCompression = -1
usePresignUrlStringUse native non-expiry Aws S3 URLs if false. Not recommended if urls are public.V1 & V2`\"true\", \"false\"`
maxFileCountintegerSplit/chunk the output zip file if input files are more than maximum file count.V2`1, 4`
maxFileSizeStringSplit/chunk output the zip file if input file sizes are more than maximum file sizeV2`\"2MB\", \"1 GiB\"`
emailSubjectStringA convenient way to change email subject sent by s3zipperV2`\"New zipping results from s3zipper\"`
fileMapperJSONA fileMapper is a JSON file inside the S3 bucket with key-name mappingsV2 See example in [fileMapper](https://forum.s3zipper.com/t/filemapper-a-way-to-change-file-or-folder-names/41) \n
fileMapperStrStringA fileMapperStr is a Stringified JSON fileMapper. It can be entered into input as a string value and is more convenient than a JSON file.V2See example in [fileMapper](https://forum.s3zipper.com/t/filemapper-a-way-to-change-file-or-folder-names/41)
\n\n

Destination Bucket Input Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
If you need to send files to a different Aws Bucket
NameTypeDescriptionAvailableExample
destAwsKeyStringAws Key (Required)V2{{awsKey}}
destAwsSecretStringAws Secret (Required)V2{{awsSecret}}
destAwsBucketStringAws Bucket (Required)V2{{awsBucket}}
destAwsRegionStringAws Region (Required)V2{{awsRegion2}}
destAwsTokenStringAws Token (Optional)V2{{awsToken}}
destAwsEndpointStringAws Endpoint (Optional)V2{{awsEndpoint}}
\n\n

Encryption Input Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Local VariableAWS VariableRequired
For KMS Encryption Only The right credentials will decrypt KMS encrypted files. ServerSideEncryption provided by default (Not Required).
kmsKeySSEKMSKeyIdRequired
For Custom Encryption
encryptKeySSECustomerKeyRequired
sseServerSideEncryptionRequired
cryptoAlgoSSECustomerAlgorithmRequired
cryptoMD5SSECustomerKeyMD5Required
For Custom Decryption
decryptKeySSECustomerKeyRequired
cryptoAlgoSSECustomerAlgorithmRequired
cryptoMD5SSECustomerKeyMD5Required
","_postman_id":"90637e84-c60d-412e-9a84-ccd6b2dc4d52"},{"name":"Zip to S3 API.","item":[{"name":"V1","item":[{"name":"gentoken","id":"6ed32e6a-62c8-e2db-c01a-f768c75d3904","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"userKey","value":"{{userKey_Live_Gmail}}","type":"text","description":"

Required : User Key : Input Values string

\n"},{"key":"userSecret","value":"{{userSecret_Live_Gmail}}","type":"text","description":"

Required : User Secret : Input Values string

\n"}]},"url":"https://api.s3zipper.com/gentoken","description":"

Generates a token. Token expires after 24 hours.

\n

Log into your account or create one at https://s3zipper.com/auth/develop\nLook under /developer to get UserKey and UserSecret.

\n

NB: UserKeys and UserSecrets can be renewed at any time, and are therefore independent of whether an account is free or paid. Simply, you don't need a paid account to get them and test API.

\n","urlObject":{"protocol":"https","path":["gentoken"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ed32e6a-62c8-e2db-c01a-f768c75d3904"},{"name":"zipstart","id":"7487bc23-8253-a58f-2a45-3c7fdb5ea823","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"awsKey","value":"{{awsKey}}","type":"text","description":"

Required : Aws Key : Input Values string

\n"},{"key":"awsSecret","value":"{{awsSecret}}","type":"text","description":"

Required : Aws Secret : Input Values string

\n"},{"key":"awsBucket","value":"{{awsBucket}}","type":"text","description":"

Required : Aws Bucket : Input Values string

\n"},{"key":"awsRegion","value":"{{awsRegion2}}","type":"text","description":"

Optional : Aws Region : Default is us-east-1 : Input Values string

\n"},{"key":"awsToken","value":"","type":"text","description":"

Optional : Aws Token : Input Values string

\n","disabled":true},{"key":"awsEndpoint","value":"","type":"text","description":"

Optional : Aws Endpoint : Input Values string

\n","disabled":true},{"key":"filePaths","value":"{{awsBucket}}/files/acer.pdf","type":"text","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n"},{"key":"zipTo","value":"","type":"text","description":"

Optional : Zip To Folder In Bucket ,or a complete path with file name : Input Values string.
Default zipTo if not specified is
{{awsBucket}}/zipped, or specify path.
{{awsBucket}}/zipped/myfile.zip \nExample: {{awsBucket}}/zipped/zipped-uuid.zip

\n","disabled":true},{"key":"resultsEmail","value":"{{my-email}}","type":"text","description":"

Optional : Send results to email only if provided : Input Values string . This is only a convenience method for testing. Not guaranteed to deliver consistently if used in production.

\n","disabled":true},{"key":"shortUrl","value":"","description":"

Optional : Create a short Url using Firebase Dynamic Links. Original URL is returned if there is a problem. Default is True : Input Values true, TRUE, True, false, False, FALSE

\n","type":"text","disabled":true},{"key":"expireLink","value":"","description":"

Optional : Expire link in hours. Default max for AWS presigned urls is 168 hours or 7 days. Must be a positive integer greater than or equal to 1 : Input Values positive 64-bit integers

\n","type":"text","disabled":true},{"key":"bucketAsDir","value":"true","description":"

Optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","type":"text","disabled":true},{"key":"zipFileName","value":"name.zip","description":"

Optional : Specify file name if not speciifed in zipTo : Input Values string

\n","type":"text","disabled":true},{"key":"usePresignUrl","value":"true/false","description":"

Optional : Use Presigned URLs if true. Use native S3 URLS if false : Input Values string

\n","type":"text","disabled":true}]},"url":"https://api.s3zipper.com/v1/zipstart","description":"

Starts the zip process and stores the result in the bucket.

\n

Please use JSON payload instead of form-data in body during POST.

\n","urlObject":{"protocol":"https","path":["v1","zipstart"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7487bc23-8253-a58f-2a45-3c7fdb5ea823"},{"name":"zipstate","id":"cd768b88-2989-1b25-ad47-bdf6f52e6610","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"chainTaskUUID\": [\n {\n \"streams3\": \"task_01d8d6c5-f35b-4264-9f56-26aaa3\"\n },\n {\n \"email\": \"task_29601324-5f12-49c5-844c-a75147\"\n }\n ]\n}"},"url":"https://api.s3zipper.com/v1/zipstate","description":"

Checks the state of the zipstart operation at any given time. It also shows results when done.

\n

Possible states:
\"PENDING\" - initial state of a task,
\"RECEIVED\" - task has been received,
\"STARTED\" - task has started processing,
\"RETRY\" - failed task has been scheduled for retry,
\"SUCCESS\" - task has been processed successfully,
\"FAILURE\" - task processing has failed.

\n","urlObject":{"protocol":"https","path":["v1","zipstate"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd768b88-2989-1b25-ad47-bdf6f52e6610"},{"name":"zipresult","id":"21fe8fd4-445a-8c21-4a02-1405c89baa0d","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"taskUUID\": [\n {\n \"streams3\": \"task_d18808fb-7897-498d-9be8-4a5d2ff0b4d9\"\n }\n ]\n}"},"url":"https://api.s3zipper.com/v1/zipresult","description":"

Starts a background process that waits for the zipstart operation result, and shows it when available.
Use this call when you intend to send your own emails.

\n\n

CAUTION: A response may not be available till a result is found on long running tasks.

\n","urlObject":{"protocol":"https","path":["v1","zipresult"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"21fe8fd4-445a-8c21-4a02-1405c89baa0d"}],"id":"0de90f38-a7e5-4c60-a025-ae4fcde09384","_postman_id":"0de90f38-a7e5-4c60-a025-ae4fcde09384","description":""},{"name":"V2","item":[{"name":"token","id":"76e66131-c5e7-4f59-8495-f5f216c01bd3","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"userKey","value":"{{userKey_Live_Gmail}}","type":"text","description":"

Required : User Key : Input Values string

\n"},{"key":"userSecret","value":"{{userSecret_Live_Gmail}}","type":"text","description":"

Required : User Secret : Input Values string

\n"}]},"url":"https://api.s3zipper.com/tokenv2","description":"

Generates a token. Token expires after 24 hours.

\n

Log into your account or create one at https://s3zipper.com/auth/develop\nLook under /developer to get UserKey and UserSecret.

\n

NB: UserKeys and UserSecrets can be renewed at any time, and are therefore independent of whether an account is free or paid. Simply, you don't need a paid account to get them and test API.

\n","urlObject":{"protocol":"https","path":["tokenv2"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"76e66131-c5e7-4f59-8495-f5f216c01bd3"},{"name":"zipstart","id":"12577969-697b-4cf6-8dfd-c6346f287cc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"awsKey","value":"{{my-aws-key}}","description":"

Optional : Aws Key : Input Values string

\n","type":"text"},{"key":"awsSecret","value":"{{my-aws-secret}}","description":"

Required : Aws Secret : Input Values string

\n","type":"text"},{"key":"awsBucket","value":"{{my-bucket}}","description":"

Required : Aws Bucket : Input Values string

\n","type":"text"},{"key":"awsRegion","value":"{{awsRegion2}}","description":"

Optional : Aws Region : Default is us-east-1 : Input Values string

\n","type":"text"},{"key":"awsToken","value":"","description":"

Optional : Aws Token : Input Values string

\n","type":"text","disabled":true},{"key":"awsEndpoint","value":"","description":"

Optional : Aws Endpoint : Input Values string

\n","type":"text","disabled":true},{"key":"resultsEmail","value":"{{my-email}}","description":"

Optional : Send results to email only if provided : Input Values string. This is only a convenience method for testing. Not guaranteed to deliver consistently if used in production.

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{my-bucket}}/files/systemd","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text"},{"key":"filePaths","value":"{{my-bucket}}/files/annual.pdf","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{my-bucket}}/files/1GB.zip","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text","disabled":true},{"key":"zipTo","value":"{{my-destination-bucket}}/myzips","description":"

Optional : Zip To Folder In Bucket : Input Values string.
Default zipTo if not specified is {{awsBucket}}/zipped.
Example: {{awsBucket}}/zipped/zipped-uuid.zip

\n","type":"text","disabled":true},{"key":"expireLink","value":"1","description":"

Optional : Expire link in hours. Default max for AWS presigned urls is 168 hours or 7 days. Must be a positive integer greater than or equal to 1 : Input Values positive 64-bit integers

\n","type":"text","disabled":true},{"key":"bucketAsDir","value":"true","description":"

Deprecated , use fileMapper optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","type":"text","disabled":true},{"key":"zipFileName","value":"name.zip","description":"

Optional : Specify zip file name if not already specified in zipTo : Input Values string

\n","type":"text"},{"key":"maxFileSize","value":"2MB","description":"

Optional : Split/chunk output zip file if files more than maximum file size, i.e 2MB, 100 GiB : Input Values string

\n","type":"text","disabled":true},{"key":"maxFileCount","value":"1","description":"

Optional : Split/chunk output zip file if files more than maximum file count : Input Values integer

\n","type":"text","disabled":true},{"key":"usePresignUrl","value":"false/true","description":"

Optional : Use native non-expiry Aws S3 URLs if false. If True use presigned URLs : Input Values string.

\n","type":"text","disabled":true},{"key":"compression","value":"true/false","description":"

Optional : Use no compress option on generated zips if false : Input Values string.

\n","type":"text","disabled":true},{"key":"destAwsKey","value":"{{ destination-Aws-Key }}","description":"

Optional : Destination Aws Key : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsSecret","value":"{{ destination-Aws-Secret }}","description":"

Optional : Destination Aws Secret : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsBucket","value":"{{ destination-Aws-Bucket }}","description":"

Optional : Destination Aws Bucket : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsRegion","value":"{{ destination-Aws-Region }}","description":"

Optional : Destination Aws Region : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsToken","value":"{{ destination-Aws-Token }}","description":"

Optional : Destination Aws Token : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsEndpoint","value":"{{ destination-Aws-Endpoint }}","description":"

Optional : Destination Aws Endpoint : Input Values string

\n","type":"text","disabled":true}]},"url":"https://api.s3zipper.com/v2/zipstart","description":"

Zip S3 files and stream back to S3.

\n","urlObject":{"protocol":"https","path":["v2","zipstart"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"12577969-697b-4cf6-8dfd-c6346f287cc6"},{"name":"zipstate","id":"6f03230c-409d-480b-a256-ec827972b9a8","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"chainTaskUUID\": [\n {\n \"streams3\": \"task_01d8d6c5-f35b-4264-9f56-26aaa3\"\n },\n {\n \"email\": \"task_29601324-5f12-49c5-844c-a75147\"\n }\n ]\n}"},"url":"https://api.s3zipper.com/v2/zipstate","description":"

Checks the state of the zipstart operation at any given time. It also shows results when done.

\n

Possible states:
\"PENDING\" - initial state of a task,
\"RECEIVED\" - task has been received,
\"STARTED\" - task has started processing,
\"RETRY\" - failed task has been scheduled for retry,
\"SUCCESS\" - task has been processed successfully,
\"FAILURE\" - task processing has failed.

\n","urlObject":{"protocol":"https","path":["v2","zipstate"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f03230c-409d-480b-a256-ec827972b9a8"},{"name":"zipresult","id":"e4f3e169-00b5-4760-bb1e-7cbda86b08b4","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"taskUUID\": [\n {\n \"streams3\": \"task_d18808fb-7897-498d-9be8-4a5d2ff0b4d9\"\n }\n ]\n}"},"url":"https://api.s3zipper.com/v2/zipresult","description":"

Starts a background process that waits for the zipstart operation result, and shows it when available.
Use this call when you intend to send your own emails.

\n\n

CAUTION: A response may not be available till a result is achieved on long running tasks.

\n","urlObject":{"protocol":"https","path":["v2","zipresult"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4f3e169-00b5-4760-bb1e-7cbda86b08b4"},{"name":"zipstartid","id":"aaef002d-f261-4717-bd5c-3b4ff5dbe06b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n","key":"Authorization","value":"Bearer {{token_live_gmail}}"}],"body":{"mode":"formdata","formdata":[{"description":"

Optional : Aws Key : Input Values string

\n","key":"awsKey","type":"text","value":"{{awsKey}}"},{"description":"

Required : Aws Secret : Input Values string

\n","key":"awsSecret","type":"text","value":"{{awsSecret}}"},{"description":"

Required : Aws Bucket : Input Values string

\n","key":"awsBucket","type":"text","value":"{{aws-Bucket-2}}"},{"description":"

Optional : Aws Region : Default is us-east-1 : Input Values string

\n","key":"awsRegion","type":"text","value":"{{awsRegion2}}"},{"description":"

Optional : Aws Token : Input Values string

\n","key":"awsToken","type":"text","value":"","disabled":true},{"description":"

Optional : Aws Endpoint : Input Values string

\n","key":"awsEndpoint","type":"text","value":"","disabled":true},{"description":"

Optional : Send results to email only if provided : Input Values string. This is only a convenience method for testing. Not guaranteed to deliver consistently if used in production.

\n","key":"resultsEmail","type":"text","value":"{{my-email}}","disabled":true},{"description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","key":"filePaths","type":"text","value":"{{awsBucket2}}/files/hubstaff","disabled":true},{"description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","key":"filePaths","type":"text","value":"{{awsBucket2}}/files/annual.pdf"},{"description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","key":"filePaths","type":"text","value":"{{awsBucket2}}/files/1GB.zip","disabled":true},{"description":"

Optional : Zip To Folder In Bucket : Input Values string.
Default zipTo if not specified is {{awsBucket}}/zipped.
Example: {{awsBucket}}/zipped/zipped-uuid.zip

\n","key":"zipTo","type":"text","value":"{{awsBucket2}}//myzips","disabled":true},{"description":"

Optional : Expire link in hours. Default max for AWS presigned urls is 168 hours or 7 days. Negative values produce expired links : Input Values positive 64-bit integers

\n","key":"expireLink","type":"text","value":"1","disabled":true},{"description":"

Deprecated , use filePathsLocation optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","key":"bucketAsDir","type":"text","value":"true","disabled":true},{"description":"

Optional : Specify zip file name if not already specified in zipTo : Input Values string

\n","key":"zipFileName","type":"text","value":"2021-02.zip"},{"description":"

Optional : Split/chunk output zip file if files more than maximum file size, i.e 2MB, 100 GiB : Input Values string

\n","key":"maxFileSize","type":"text","value":"2MB","disabled":true},{"description":"

Optional : Split/chunk output zip file if files more than maximum file count : Input Values integer

\n","key":"maxFileCount","type":"text","value":"1","disabled":true},{"description":"

Optional : A JSON file in the bucket that contains custom file maps : Input Values string.

\n

Example JSON format below

\n

{
\"paths\":
[
{ \"key\":\"my-bucket/temporary/index/\", \"name\":\"/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/abedefeec123/\", \"name\": \"/screenshots/joe-bob/2018-12-21/12:23:23/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/deadbeef3421/\", \"name\":\"/screenshots/john-doe/2018-12-21/14:12:00/\" }
]
}

\n","key":"fileMapper","type":"text","value":"{{awsBucket2}}/files/m1.json","disabled":true},{"description":"

Optional : Use native non-expiry Aws S3 URLs if false. If True use presigned URLs : Input Values string.

\n","key":"usePresignUrl","type":"text","value":"false","disabled":true},{"description":"

Optional : Use no compress option on generated zips if false : Input Values string.

\n","key":"compress ","type":"text","value":"false","disabled":true},{"description":"

Optional : Destination Aws Key : Input Values string

\n","key":"destAwsKey","type":"text","value":"{{ destination-Aws-Key }}","disabled":true},{"description":"

Optional : Destination Aws Secret : Input Values string

\n","key":"destAwsSecret","type":"text","value":"{{ destination-Aws-Secret }}","disabled":true},{"description":"

Optional : Destination Aws Bucket : Input Values string

\n","key":"destAwsBucket","type":"text","value":"{{ destination-Aws-Bucket }}","disabled":true},{"description":"

Optional : Destination Aws Region : Input Values string

\n","key":"destAwsRegion","type":"text","value":"{{ destination-Aws-Region }}","disabled":true},{"description":"

Optional : Destination Aws Token : Input Values string

\n","key":"destAwsToken","type":"text","value":"{{ destination-Aws-Token }}","disabled":true},{"description":"

Optional : Destination Aws Endpoint : Input Values string

\n","key":"destAwsEndpoint","type":"text","value":"{{ destination-Aws-Endpoint }}","disabled":true}]},"url":"https://api.s3zipper.com/v2/zipstartid","description":"

Same as zipstart but returns the Job ID ASAP. Convenience method for a faster response. Please experiment with zipstart first to fix any errors that might come up before committing to zipstartid.

\n","urlObject":{"protocol":"https","path":["v2","zipstartid"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aaef002d-f261-4717-bd5c-3b4ff5dbe06b"}],"id":"e6d2689c-2047-49aa-80b9-864b576ed0d5","_postman_id":"e6d2689c-2047-49aa-80b9-864b576ed0d5","description":""}],"id":"23fc2566-464e-bcf7-1e0d-614dd77290df","description":"

All API calls for zipping documents back to AWS S3 bucket.
A URL is generated with a link to a zip file in S3 bucket.
NB : a zip file is created in S3 bucket.

\n","event":[{"listen":"prerequest","script":{"id":"999b4e1f-b76e-41eb-8c6c-40286d8c1661","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"df987a42-b28a-4f5a-ad18-fff54b71226f","type":"text/javascript","exec":[""]}}],"_postman_id":"23fc2566-464e-bcf7-1e0d-614dd77290df"},{"name":"Stream S3 Downloads API","item":[{"name":"V1","item":[{"name":"gentoken","id":"18c0aa69-5c0c-1e14-b28d-214f8bd62b5d","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"userKey","value":"{{userKey_Live_Gmail}}","type":"text","description":"

Required : User Key : Input Values string

\n"},{"key":"userSecret","value":"{{userSecret_Live_Gmail}}","type":"text","description":"

Required : User Secret : Input Values string

\n"}]},"url":"https://api.s3zipper.com/gentoken","description":"

Generates a token. Token expires after 24 hours.

\n

Log into your account or create one at https://s3zipper.com/auth/develop\nLook under /developer to get UserKey and UserSecret.

\n

NB: UserKeys and UserSecrets can be renewed at any time, and are therefore independent of whether an account is free or paid. Simply, you don't need a paid account to get them and test API.

\n","urlObject":{"protocol":"https","path":["gentoken"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"18c0aa69-5c0c-1e14-b28d-214f8bd62b5d"},{"name":"streamzip","id":"c1a1f851-cdb6-5d63-eeea-87bbb34799b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"}],"body":{"mode":"formdata","formdata":[{"key":"awsKey","value":"{{awsKey}}","description":"

Required : Aws Key : Input Values string

\n","type":"text"},{"key":"awsSecret","value":"{{awsSecret}}","description":"

Required : Aws Secret : Input Values string

\n","type":"text"},{"key":"awsBucket","value":"{{awsBucket}}","description":"

Required : Aws Bucket : Input Values string

\n","type":"text"},{"key":"awsRegion","value":"{{awsRegion2}}","description":"

Optional : Aws Region : Default is us-east-1 : Input Values string

\n","type":"text","disabled":true},{"key":"awsToken","value":"","description":"

Optional : Aws Token : Input Values string

\n","type":"text","disabled":true},{"key":"awsEndpoint","value":"","description":"

Optional : Aws Endpoint : Input Values string

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{awsBucket}}/files/pigeon.jpg","description":"

Required : File path in bucket. It is an array/list : Input Values [string]

\n","type":"text"},{"key":"filePaths","value":"{{awsBucket}}/files/s3zipper.odt","description":"

Required : File path in bucket. It is an array/list : Input Values [string]

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{awsBucket}}/files/oversize.pdf","description":"

Required : File path in bucket. It is an array/list : Input Values [string]

\n","type":"text","disabled":true},{"key":"expireLink","value":"24","description":"

Optional : Expire link in hours. Default is 720 hours or 30 days. Must be a positive integer greater than or equal to 1 : Input Values positive 64-bit integers

\n","type":"text","disabled":true},{"key":"shortUrl","value":"","description":"

Optional : Create a short Url using Firebase Dynamic Links. Original URL is returned if there is a problem. Default is True : Input Values true, TRUE, True, false, False, FALSE

\n","type":"text","disabled":true},{"key":"resultsEmail","value":"{{my-email}}","description":"

optional : Send results to email only if provided : Input Values string. This is only a convenience method for testing. Not guaranteed to deliver consistently if used in production.

\n","type":"text","disabled":true},{"key":"bucketAsDir","value":"true","description":"

optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","type":"text","disabled":true},{"key":"zipFileName","value":"name.zip","description":"

Optional : Specify file name if not speciifed in zipTo : Input Values string

\n","type":"text"}]},"url":"https://api.s3zipper.com/v1/streamzip","description":"

Starts a process that creates a streaming download url.

\n

Please use JSON payload instead of form-data in body during POST.

\n","urlObject":{"protocol":"https","path":["v1","streamzip"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1a1f851-cdb6-5d63-eeea-87bbb34799b1"},{"name":"zipstate","id":"5440bd09-0c64-794c-0c92-d58af30c313f","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"chainTaskUUID\": [\n {\n \"idurl\": \"task_87d63e4d-7f53-4f59-8eb3-47f4a4\"\n },\n {\n \"email\": \"task_71b7995c-a8ad-4681-bc5c5c96\"\n }\n ]\n}"},"url":"https://api.s3zipper.com/v1/zipstate","description":"

Checks the state of the streamzip operation at any given time. It also shows results when done.

\n

Possible states:
\"PENDING\" - initial state of a task,
\"RECEIVED\" - task has been received,
\"STARTED\" - task has started processing,
\"RETRY\" - failed task has been scheduled for retry,
\"SUCCESS\" - task has been processed successfully,
\"FAILURE\" - task processing has failed.

\n","urlObject":{"protocol":"https","path":["v1","zipstate"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5440bd09-0c64-794c-0c92-d58af30c313f"},{"name":"zipresult","id":"fc7934f5-405c-3c2c-05f5-3f2803638a32","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"chainTaskUUID\": [\n {\n \"idurl\": \"task_44553c47-97f7-4cbc-a9f9-02f34cc91ee2\"\n },\n {\n \"email\": \"task_17ca4e7c-3fc1-46c7-9173-f88031ad551c\"\n }\n ]\n}"},"url":"https://api.s3zipper.com/v1/zipresult","description":"

Starts a background process that waits for the zipping operation result, and shows it when available.
Use this call when you intend to send your own emails.

\n\n

CAUTION: A response may not be available till a result is found on long running tasks.

\n","urlObject":{"protocol":"https","path":["v1","zipresult"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc7934f5-405c-3c2c-05f5-3f2803638a32"}],"id":"b92bcee4-2ed0-41f1-96be-779cf99b516e","_postman_id":"b92bcee4-2ed0-41f1-96be-779cf99b516e","description":""},{"name":"V2","item":[{"name":"token","id":"5543f810-d056-43f4-873c-a1a27df2b57d","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"userKey","value":"{{userKey_Live_Gmail}}","type":"text","description":"

Required : User Key : Input Values string

\n"},{"key":"userSecret","value":"{{userSecret_Live_Gmail}}","type":"text","description":"

Required : User Secret : Input Values string

\n"}]},"url":"https://api.s3zipper.com/tokenv2","description":"

Generates a token. Token expires after 24 hours.

\n

Log into your account or create one at https://s3zipper.com/auth/develop\nLook under /developer to get UserKey and UserSecret.

\n

NB: UserKeys and UserSecrets can be renewed at any time, and are therefore independent of whether an account is free or paid. Simply, you don't need a paid account to get them and test API.

\n","urlObject":{"protocol":"https","path":["tokenv2"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5543f810-d056-43f4-873c-a1a27df2b57d"},{"name":"streamzip","id":"b764bd66-8810-46ad-9e49-526b34d7af8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"awsKey","value":"{{awsKey}}","description":"

Required : Aws Key : Input Values string

\n","type":"text"},{"key":"awsSecret","value":"{{awsSecret}}","description":"

Required : Aws Secret : Input Values string

\n","type":"text"},{"key":"awsBucket","value":"{{awsBucket}}","description":"

Required : Aws Bucket : Input Values string

\n","type":"text"},{"key":"awsRegion","value":"{{awsRegion2}}","description":"

Optional : Aws Region : Default is us-east-1 : Input Values string

\n","type":"text","disabled":true},{"key":"awsToken","value":"","description":"

Optional : Aws Token : Input Values string

\n","type":"text","disabled":true},{"key":"awsEndpoint","value":"","description":"

Optional : Aws Endpoint : Input Values string

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{awsBucket}}/files/pigeon.jpg","description":"

Required : File path in bucket. It is an array/list : Input Values [string]

\n","type":"text"},{"key":"filePaths","value":"{{awsBucket}}/files/s3zipper.odt","description":"

Required : File path in bucket. It is an array/list : Input Values [string]

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{awsBucket}}/files/oversize.pdf","description":"

Required : File path in bucket. It is an array/list : Input Values [string]

\n","type":"text","disabled":true},{"key":"expireLink","value":"24","description":"

Optional : Expire link in hours. Default is 720 hours or 30 days. Must be a positive integer greater than or equal to 1 : Input Values positive 64-bit integers

\n","type":"text","disabled":true},{"key":"shortUrl","value":"","description":"

Optional : Create a short Url using Firebase Dynamic Links. Original URL is returned if there is a problem. Default is True : Input Values true, TRUE, True, false, False, FALSE

\n","type":"text","disabled":true},{"key":"resultsEmail","value":"{{my-email}}","description":"

optional : Send results to email only if provided : Input Values string. This is only a convenience method for testing. Not guaranteed to deliver consistently if used in production.

\n","type":"text","disabled":true},{"key":"bucketAsDir","value":"false","description":"

optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","type":"text","disabled":true},{"key":"zipFileName","value":"name.zip","description":"

Optional : Specify file name if not speciifed in zipTo : Input Values string

\n","type":"text"},{"key":"compression","value":"true/false","description":"

Optional : Use no compress option on generated zips if false : Input Values string.

\n","type":"text","disabled":true}]},"url":"https://api.s3zipper.com/v2/streamzip","description":"

stream zip to web

\n","urlObject":{"protocol":"https","path":["v2","streamzip"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b764bd66-8810-46ad-9e49-526b34d7af8d"},{"name":"zipstate","id":"a329ba75-5039-47f8-a31b-89f284cba35f","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"chainTaskUUID\": [\n {\n \"streams3\": \"task_01d8d6c5-f35b-4264-9f56-26aaa3\"\n },\n {\n \"email\": \"task_29601324-5f12-49c5-844c-a75147\"\n }\n ]\n}"},"url":"https://api.s3zipper.com/v2/zipstate","description":"

Checks the state of the zipstart operation at any given time. It also shows results when done.

\n

Possible states:
\"PENDING\" - initial state of a task,
\"RECEIVED\" - task has been received,
\"STARTED\" - task has started processing,
\"RETRY\" - failed task has been scheduled for retry,
\"SUCCESS\" - task has been processed successfully,
\"FAILURE\" - task processing has failed.

\n","urlObject":{"protocol":"https","path":["v2","zipstate"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a329ba75-5039-47f8-a31b-89f284cba35f"},{"name":"zipresult","id":"6087f2fe-e8af-4a31-b46c-9ce57d4ff30c","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token_live_gmail}}","description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"taskUUID\": [\n {\n \"streams3\": \"task_d18808fb-7897-498d-9be8-4a5d2ff0b4d9\"\n }\n ]\n}"},"url":"https://api.s3zipper.com/v2/zipresult","description":"

Starts a background process that waits for the zipping operation result, and shows it when available.
Use this call when you intend to send your own emails.

\n\n

CAUTION: A response may not be available till a result is found on long running tasks.

\n","urlObject":{"protocol":"https","path":["v2","zipresult"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6087f2fe-e8af-4a31-b46c-9ce57d4ff30c"},{"name":"streamzipid","id":"0e823ce3-f1f7-4c0a-b2ae-1deee3601baa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Token from gentoken. Example : {{vault:json-web-token}}

\n","key":"Authorization","value":"Bearer {{token_live_gmail}}"}],"body":{"mode":"formdata","formdata":[{"description":"

Optional : Aws Key : Input Values string

\n","key":"awsKey","type":"text","value":"{{awsKey}}"},{"description":"

Required : Aws Secret : Input Values string

\n","key":"awsSecret","type":"text","value":"{{awsSecret}}"},{"description":"

Required : Aws Bucket : Input Values string

\n","key":"awsBucket","type":"text","value":"{{aws-Bucket-2}}"},{"description":"

Optional : Aws Region : Default is us-east-1 : Input Values string

\n","key":"awsRegion","type":"text","value":"{{awsRegion2}}"},{"description":"

Optional : Aws Token : Input Values string

\n","key":"awsToken","type":"text","value":"","disabled":true},{"description":"

Optional : Aws Endpoint : Input Values string

\n","key":"awsEndpoint","type":"text","value":"","disabled":true},{"description":"

Optional : Send results to email only if provided : Input Values string. This is only a convenience method for testing. Not guaranteed to deliver consistently if used in production.

\n","key":"resultsEmail","type":"text","value":"{{my-email}}","disabled":true},{"description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","key":"filePaths","type":"text","value":"{{awsBucket2}}/files/hubstaff","disabled":true},{"description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","key":"filePaths","type":"text","value":"{{awsBucket2}}/files/annual.pdf"},{"description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","key":"filePaths","type":"text","value":"{{awsBucket2}}/files/1GB.zip","disabled":true},{"description":"

Optional : Zip To Folder In Bucket : Input Values string.
Default zipTo if not specified is {{awsBucket}}/zipped.
Example: {{awsBucket}}/zipped/zipped-uuid.zip

\n","key":"zipTo","type":"text","value":"{{awsBucket2}}//myzips","disabled":true},{"description":"

Optional : Expire link in hours. Default max for AWS presigned urls is 168 hours or 7 days. Negative values produce expired links : Input Values positive 64-bit integers

\n","key":"expireLink","type":"text","value":"1","disabled":true},{"description":"

Deprecated , use filePathsLocation optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","key":"bucketAsDir","type":"text","value":"true","disabled":true},{"description":"

Optional : Specify zip file name if not already specified in zipTo : Input Values string

\n","key":"zipFileName","type":"text","value":"2021-02.zip"},{"description":"

Optional : Split/chunk output zip file if files more than maximum file size, i.e 2MB, 100 GiB : Input Values string

\n","key":"maxFileSize","type":"text","value":"2MB","disabled":true},{"description":"

Optional : Split/chunk output zip file if files more than maximum file count : Input Values integer

\n","key":"maxFileCount","type":"text","value":"1","disabled":true},{"description":"

Optional : A JSON file in the bucket that contains custom file maps : Input Values string.

\n

Example JSON format below

\n

{
\"paths\":
[
{ \"key\":\"my-bucket/temporary/index/\", \"name\":\"/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/abedefeec123/\", \"name\": \"/screenshots/joe-bob/2018-12-21/12:23:23/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/deadbeef3421/\", \"name\":\"/screenshots/john-doe/2018-12-21/14:12:00/\" }
]
}

\n","key":"fileMapper","type":"text","value":"{{awsBucket2}}/files/m1.json","disabled":true},{"description":"

Optional : Use native non-expiry Aws S3 URLs if false. If True use presigned URLs : Input Values string.

\n","key":"usePresignUrl","type":"text","value":"false","disabled":true},{"description":"

Optional : Use no compress option on generated zips if false : Input Values string.

\n","key":"compress ","type":"text","value":"false","disabled":true},{"description":"

Optional : Destination Aws Key : Input Values string

\n","key":"destAwsKey","type":"text","value":"{{ destination-Aws-Key }}","disabled":true},{"description":"

Optional : Destination Aws Secret : Input Values string

\n","key":"destAwsSecret","type":"text","value":"{{ destination-Aws-Secret }}","disabled":true},{"description":"

Optional : Destination Aws Bucket : Input Values string

\n","key":"destAwsBucket","type":"text","value":"{{ destination-Aws-Bucket }}","disabled":true},{"description":"

Optional : Destination Aws Region : Input Values string

\n","key":"destAwsRegion","type":"text","value":"{{ destination-Aws-Region }}","disabled":true},{"description":"

Optional : Destination Aws Token : Input Values string

\n","key":"destAwsToken","type":"text","value":"{{ destination-Aws-Token }}","disabled":true},{"description":"

Optional : Destination Aws Endpoint : Input Values string

\n","key":"destAwsEndpoint","type":"text","value":"{{ destination-Aws-Endpoint }}","disabled":true}]},"url":"https://api.s3zipper.com/v2/streamzipid","description":"

Same as streamzip but returns the Job ID ASAP. Convenience method for a faster response. Please experiment with zipstart first to fix any errors that might come up before committing to streamzipid or streamzip.

\n","urlObject":{"protocol":"https","path":["v2","streamzipid"],"host":["api","s3zipper","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e823ce3-f1f7-4c0a-b2ae-1deee3601baa"}],"id":"de451c6e-0875-4430-b55f-03ec78676abd","_postman_id":"de451c6e-0875-4430-b55f-03ec78676abd","description":""}],"id":"1c290c02-8c67-14d7-6fee-3912dca4abbf","description":"

API calls for streaming zip file downloads from AWS S3 to browser.
It generates a URL that can later be used to download zip files on a web browser.
NB :

\n\n","event":[{"listen":"prerequest","script":{"id":"7017c775-da6d-4f18-aed9-65df198bccc9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f5c0dce6-4e8d-43ba-bead-63e47fdcec01","type":"text/javascript","exec":[""]}}],"_postman_id":"1c290c02-8c67-14d7-6fee-3912dca4abbf"},{"name":"EC2(AMI) S3ZIPPER API SERVER","item":[{"name":"V1","item":[{"name":"s3zip","id":"f34b1b49-9518-4690-b29f-6cee9b6326a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"awsKey","value":"","description":"

Optional : Aws Key : Input Values string

\n","type":"text"},{"key":"awsSecret","value":"","description":"

Required : Aws Secret : Input Values string

\n","type":"text"},{"key":"awsBucket","value":"","description":"

Required : Aws Bucket : Input Values string

\n","type":"text"},{"key":"awsRegion","value":"","description":"

Optional : Aws Region : Default is us-east-1 : Input Values string

\n","type":"text"},{"key":"awsToken","value":"","description":"

Optional : Aws Token : Input Values string

\n","type":"text","disabled":true},{"key":"awsEndpoint","value":"","description":"

Optional : Aws Endpoint : Input Values string

\n","type":"text","disabled":true},{"key":"resultsEmail","value":"{{resultsEmail}}","description":"

Optional : Send results to email only if provided : Input Values string

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{aws-bucket-2}}/files/systemd","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text"},{"key":"filePaths","value":"{{aws-bucket-2}}/files/annual.pdf","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{aws-bucket-2}}/files/1GB.zip","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text","disabled":true},{"key":"zipTo","value":"","description":"

Optional : Zip To Folder In Bucket : Input Values string.
Default zipTo if not specified is {{awsBucket}}/zipped.
Example: {{awsBucket}}/zipped/zipped-uuid.zip

\n","type":"text","disabled":true},{"key":"expireLink","value":"1","description":"

Optional : Expire link in hours. Default max for AWS presigned urls is 168 hours or 7 days. Must be a positive integer greater than or equal to 1 : Input Values positive 64-bit integers

\n","type":"text","disabled":true},{"key":"bucketAsDir","value":"true","description":"

optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","type":"text","disabled":true}]},"url":"http:///v1/s3zip","description":"

Zip S3 files and stream back to S3.

\n","urlObject":{"protocol":"http","path":["Domain >","v1","s3zip"],"host":["Copy JSON result from s3zip or streamzip directly

\n"}],"body":{"mode":"raw","raw":"{\n \"message\": \"STARTED\",\n \"zipID\": \"8c7e2458-bc66-425d-a876-279e5338ee15\"\n}"},"url":"http:///v1/status","description":"

check the status of the zip operation

\n","urlObject":{"protocol":"http","path":["Domain >","v1","status"],"host":["/v1/streamzip","description":"

stream zip to web

\n","urlObject":{"protocol":"http","path":["Domain >","v1","streamzip"],"host":["Required : Aws Key : Input Values string

\n","type":"text"},{"key":"awsSecret","value":"{{my-aws-secret}}","description":"

Required : Aws Secret : Input Values string

\n","type":"text"},{"key":"awsBucket","value":"{{my-bucket}}","description":"

Required : Aws Bucket : Input Values string

\n","type":"text"},{"key":"awsRegion","value":"us-east-1","description":"

Optional : Aws Region : Input Values string

\n","type":"text"},{"key":"awsToken","value":"","description":"

Optional : Aws Token : Input Values string

\n","type":"text","disabled":true},{"key":"awsEndpoint","value":"","description":"

Optional : Aws Endpoint : Input Values string

\n","type":"text","disabled":true},{"key":"resultsEmail","value":"{{my-email}}","description":"

Optional : Send results to email only if provided : Input Values string

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{my-bucket}}/files/systemd","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text"},{"key":"filePaths","value":"{{my-bucket}}/files/annual.pdf","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{my-bucket}}/files/1GB.zip","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text","disabled":true},{"key":"zipTo","value":"{{my-bucket}}/myzips or {{my-bucket}}/myzips/file.zip ","description":"

Optional : Zip To Folder In Bucket, or specify path to file : Input Values string.
Default zipTo if not specified is {{awsBucket}}/zipped.
Example: {{awsBucket}}/zipped/zipped-uuid.zip

\n","type":"text","disabled":true},{"key":"expireLink","value":"1","description":"

Optional : Expire link in hours. Default max for AWS presigned urls is 168 hours or 7 days. Negative values produce expired links : Input Values positive 64-bit integers

\n","type":"text","disabled":true},{"key":"bucketAsDir","value":"true","description":"

Use fileMapper. optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","type":"text","disabled":true},{"key":"zipFileName","value":"myname.zip","description":"

Optional : Specify zip file name if not already specified in zipTo : Input Values string

\n","type":"text","disabled":true},{"key":"maxFileSize","value":"2MB","description":"

Optional : Split/chunk output zip file if files more than maximum file size, i.e 2MB, 100 GiB : Input Values string

\n","type":"text","disabled":true},{"key":"maxFileCount","value":"10","description":"

Optional : Split/chunk output zip file if files more than maximum file count : Input Values integer

\n","type":"text","disabled":true},{"key":"fileMapper","value":"{{my-bucket}}/files/mapper.json","description":"

Optional : A JSON file in the bucket that contains custom file maps : Input Values string.

\n

Example JSON format below

\n

{
\"paths\":
[
{ \"key\":\"my-bucket/temporary/index/\", \"name\":\"/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/abedefeec123/\", \"name\": \"/screenshots/joe-bob/2018-12-21/12:23:23/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/deadbeef3421/\", \"name\":\"/screenshots/john-doe/2018-12-21/14:12:00/\" }
]
}

\n","type":"text","disabled":true},{"key":"destAwsKey","value":"","description":"

Optional : Destination Aws Key : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsSecret","value":"","description":"

Optional : Destination Aws Secret : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsBucket","value":"","description":"

Optional : Destination Aws Bucket : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsRegion","value":"","description":"

Optional : Destination Aws Region : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsToken","value":"","description":"

Optional : Destination Aws Token : Input Values string

\n","type":"text","disabled":true},{"key":"destAwsEndpoint","value":"","description":"

Optional : Destination Aws Endpoint : Input Values string

\n","type":"text","disabled":true},{"key":"fileMapper","value":"{{my-bucket}}/files/files.json","description":"

Optional : A json file in bucket containing files to be zipped. Use instead of filePaths.
Example below

\n

[\n \"{{bucket}}/files/annual.pdf\",\n \"{{bucket}}/files/systemd\" \n ]

\n","type":"text","disabled":true}]},"url":"http:///v2/s3zip","description":"

Zip S3 files and stream back to S3.

\n","urlObject":{"protocol":"http","path":["Domain >","v2","s3zip"],"host":["/v2/status","description":"

check the status of the zip operation

\n","urlObject":{"protocol":"http","path":["Domain >","v2","status"],"host":["Required : Aws Key : Input Values string

\n","type":"text"},{"key":"awsSecret","value":"{{my-aws-secret}}","description":"

Required : Aws Secret : Input Values string

\n","type":"text"},{"key":"awsBucket","value":"{{my-bucket}}","description":"

Required : Aws Bucket : Input Values string

\n","type":"text"},{"key":"awsRegion","value":"us-east-1","description":"

Optional : Aws Region : Input Values string

\n","type":"text"},{"key":"awsToken","value":"","description":"

Optional : Aws Token : Input Values string

\n","type":"text","disabled":true},{"key":"awsEndpoint","value":"","description":"

Optional : Aws Endpoint : Input Values string

\n","type":"text","disabled":true},{"key":"resultsEmail","value":"{{my-email}}","description":"

Optional : Send results to email only if provided : Input Values string

\n","type":"text","disabled":true},{"key":"filePaths","value":"{{my-bucket}}/files/systemd","description":"

Required : File path in bucket. It is an array/list : Input Values [string].
Example : {{awsBucket}}, {{awsBucket}}/path/to/file, {{awsBucket}}/path/to/folder

\n","type":"text"},{"key":"bucketAsDir","value":"true","description":"

Use fileMapper. optional : Bucket as root directory(preserve file paths starting from bucket name) :
Arguments : string : <\"true/TRUE/True/Yes\"> or <\"false/FALSE?False/No\"> or <\"folder\"> or <\"/folder\"> . Default is true/yes.

\n
    \n
  1. If folder is specified and has leading forward slash, the folder is root directory.
    2. \n
  2. If folder is specified and has no leading forward slash, the folder below it becomes root directory.
    3. \n
  3. If \"TRUE\", bucket is root directory.
    4. \n
  4. If \"FALSE\", all files are dumped in one folder.
    5. \n
  5. If folder is specified but not found or faulty.Default behavior reverts to \"FALSE\".
    6. \n
\n","type":"text","disabled":true},{"key":"zipFileName","value":"myname.zip","description":"

Optional : Specify zip file name if not already specified in zipTo : Input Values string

\n","type":"text"},{"key":"fileMapper","value":"{{my-bucket}}/files/mapper.json","description":"

Optional : A JSON file in the bucket that contains custom file maps : Input Values string.

\n

Example JSON format below

\n

{
\"paths\":
[
{ \"key\":\"my-bucket/temporary/index/\", \"name\":\"/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/abedefeec123/\", \"name\": \"/screenshots/joe-bob/2018-12-21/12:23:23/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/deadbeef3421/\", \"name\":\"/screenshots/john-doe/2018-12-21/14:12:00/\" }
]
}

\n","type":"text","disabled":true}]},"url":"http:///v2/streamzip","description":"

stream zip to web

\n","urlObject":{"protocol":"http","path":["Domain >","v2","streamzip"],"host":["This is for EC2 AMI version 2.

\n

Please use filePathsLocation for file mapping

\n

Example JSON for file mapper:

\n

{
\"paths\":
[
{ \"key\":\"my-bucket/temporary/index/\", \"name\":\"/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/abedefeec123/\", \"name\": \"/screenshots/joe-bob/2018-12-21/12:23:23/\" },
{ \"key\":\"my-bucket/screenshots/5/2018/deadbeef3421/\", \"name\":\"/screenshots/john-doe/2018-12-21/14:12:00/\" }
]
}

\n
\n","event":[{"listen":"prerequest","script":{"id":"12acabe2-91b4-4d1e-90ca-9463ab19f6a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"016fd4a1-e8b9-465b-83dc-7f8a1114e73b","type":"text/javascript","exec":[""]}}],"_postman_id":"74ea103f-9117-453a-b85a-7e7f141178be"}],"id":"bd260c71-5f11-4a05-a07b-6e489ca8cb7d","description":"

This is an AMI image that can be launched in AWS EC2.
It is useful if you need your own simple but robust zipping server.

\n
\n

Home Page:

\n\n

Amazon Web Service(AWS EC2 AMI) Marketplace:
- https://aws.amazon.com/marketplace/seller-profile?id=abd52fdf-6ddb-4408-ae73-cc5a7e1f3b3f&ref=dtl_B0727QDVXV

\n

AWS SETTINGS

\n

2 ways to provide Aws settings:

\n
    \n
  • hardwired in to the configuration file(config.toml), or
    • \n
  • provided in the form body. This is good if you need to use temporary tokens.
    • \n
\n

NB: Hard-wired settings will have preference over credentials from form body.

\n","event":[{"listen":"prerequest","script":{"id":"aed0c9fe-28f4-4cd4-a983-3642d172472d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3f829a76-0111-4343-a3aa-3c3190382588","type":"text/javascript","exec":[""]}}],"_postman_id":"bd260c71-5f11-4a05-a07b-6e489ca8cb7d"}],"event":[{"listen":"prerequest","script":{"id":"d4f3ddf4-7f17-45e4-8922-3cd17cd15d28","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"33cd36a0-1a75-44b7-9daf-1febceb5bcf7","type":"text/javascript","exec":[""]}}]}