Operations (sample payloads)

Main operations

Bzip2

Compress a file using bzip2. Sample Input

{
    "file": \{
        "name": "example.txt",
        "url": "https://example.com/files/example.txt",
        "mime_type": "text/plain",
        "expires": 1672531200
    \},
    "file_name": "compressed_example"
}

Sample Output

{
    "file": \{
        "name": "compressed_example.bz2",
        "url": "https://example.com/files/compressed_example.bz2",
        "mime_type": "application/x-bzip2",
        "expires": 1672617600
    \}
}

Gzip

Gzip a file. Sample Input

{
    "file": \{
        "name": "example.txt",
        "url": "https://example.com/files/example.txt",
        "mime_type": "text/plain",
        "expires": 1672531200
    \}
}

Sample Output

{
    "result": \{
        "name": "example.txt.gz",
        "url": "https://example.com/files/example.txt.gz",
        "mime_type": "application/gzip",
        "expires": 1672617600
    \}
}

Unbzip2

Decompress a bzip2 file. Sample Input

{
    "file": \{
        "name": "compressed_document.bz2",
        "url": "https://example.com/files/compressed_document.bz2",
        "mime_type": "application/x-bzip2",
        "expires": 1623456789
    \},
    "file_name": "decompressed_document.pdf"
}

Sample Output

{
    "file": \{
        "name": "decompressed_document.pdf",
        "url": "https://example.com/files/decompressed_document.pdf",
        "mime_type": "application/pdf",
        "expires": 1623456789
    \}
}

Ungzip

Decompress a gzip file. Sample Input

{
    "file": \{
        "name": "compressed_document.gz",
        "url": "https://example.com/files/compressed_document.gz",
        "mime_type": "application/gzip",
        "expires": 1623456789
    \},
    "output_file_name": "decompressed_document.pdf"
}

Sample Output

{
    "result": \{
        "name": "decompressed_document.pdf",
        "url": "https://example.com/files/decompressed_document.pdf",
        "mime_type": "application/pdf",
        "expires": 1623457789
    \}
}

Unzip

Unzip a file. Sample Input

{
    "url": "https://example.com/files/archive.zip"
}

Sample Output

{
    "items": [
        \{
            "name": "document1.pdf",
            "url": "https://example.com/temp/unzipped/document1.pdf",
            "mime_type": "application/pdf",
            "expires": 1623456789
        \},
        \{
            "name": "image1.jpg",
            "url": "https://example.com/temp/unzipped/image1.jpg",
            "mime_type": "image/jpeg",
            "expires": 1623456789
        \},
        \{
            "name": "spreadsheet.xlsx",
            "url": "https://example.com/temp/unzipped/spreadsheet.xlsx",
            "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
            "expires": 1623456789
        \}
    ]
}

Unzip and decrypt

Unzip a password protected file Sample Input

{
    "file": \{
        "name": "confidential_report.zip",
        "url": "https://example.com/files/confidential_report.zip",
        "mime_type": "application/zip",
        "expires": 1623456789
    \},
    "password": "S3cureP@ssw0rd!"
}

Sample Output

{
    "items": [
        \{
            "name": "financial_data.xlsx",
            "url": "https://example.com/files/financial_data.xlsx",
            "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
            "expires": 1623457789
        \},
        \{
            "name": "project_summary.pdf",
            "url": "https://example.com/files/project_summary.pdf",
            "mime_type": "application/pdf",
            "expires": 1623457789
        \},
        \{
            "name": "meeting_notes.docx",
            "url": "https://example.com/files/meeting_notes.docx",
            "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "expires": 1623457789
        \}
    ]
}

Zip

Zip up a number of files. Sample Input

{
    "files": [
        {
            "file": \{
                "name": "document1.pdf",
                "url": "https://example.com/files/document1.pdf",
                "mime_type": "application/pdf",
                "expires": 1623456789
            \},
            "path": "/documents/document1.pdf"
        },
        {
            "file": \{
                "name": "image1.jpg",
                "url": "https://example.com/files/image1.jpg",
                "mime_type": "image/jpeg",
                "expires": 1623456790
            \},
            "path": "/images/image1.jpg"
        },
        {
            "file": \{
                "name": "spreadsheet1.xlsx",
                "url": "https://example.com/files/spreadsheet1.xlsx",
                "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
                "expires": 1623456791
            \},
            "path": "/spreadsheets/spreadsheet1.xlsx"
        }
    ],
    "file_name": "my_project_files",
    "encase_files_in_directory": true
}

Sample Output

{
    "result": \{
        "name": "my_project_files.zip",
        "url": "https://example.com/zipped/my_project_files.zip",
        "mime_type": "application/zip",
        "expires": 1623543189
    \}
}

Zip and encrypt

Zip and password protect a number of files Sample Input

{
    "files": [
        {
            "file": \{
                "name": "document1.pdf",
                "url": "https://example.com/files/document1.pdf",
                "mime_type": "application/pdf",
                "expires": 1623456789
            \},
            "path": "/documents/"
        },
        {
            "file": \{
                "name": "image1.jpg",
                "url": "https://example.com/files/image1.jpg",
                "mime_type": "image/jpeg",
                "expires": 1623456790
            \},
            "path": "/images/"
        }
    ],
    "file_name": "protected_archive.zip",
    "password": "securePassword123!",
    "encryption_type": "AES 256"
}

Sample Output

{
    "result": \{
        "name": "protected_archive.zip",
        "url": "https://example.com/files/protected_archive.zip",
        "mime_type": "application/zip",
        "expires": 1623460000
    \}
}