This API lets you archive multiple files in various formats, to a password-protected ZIP file quickly and safely.- without the need of additional software. - ApyHub
apyhub-logo
FusionPlatformAPI CatalogPricingBlog

Generate Archives API

Smart Generation#archive#zip
ApyHub
ApyHub
verified icon
150 atoms
Base tier

About

This Utility API lets you archive multiple files to a ZIP file.
Archiving files compresses them into a single file, which takes up less space than the original files. This is especially important when dealing with large files or when you need to store files for an extended period of time. A single file is much more easier to transfer or to share with others. Instead of having to send multiple files, you can send a single archive file, which is faster and more convenient.
Select API Endpoints
Input
Output

API Playground

API Documentation

submit files: download archive
POST
https://api.apyhub.com/generate/archive/files/archive-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/archive/files/archive-file?output=samplezip' \
2
--header 'apy-token: {{token}}' \
3
--form 'files=@"test.png"' \
4
--form 'files=@"sample.ppt"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe name of the resulting zip file containing the archived files. The default name is output.zip.
Request Body
AttributeTypeMandatoryDescription
filesFile arrayYesThe source files that you want to archive. You can select as many files as you want.
Sample Response
A successful request returns a password-protected archive file in the specified output parameter. If the request fails, the response contains an error code and a message to help identify the issue.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the files are empty or the files are corrupt.
500If any unexpected error occurs while processing the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles