Generate Secure File Archives API - ApyHub

Generate Secure Archives API

File SecuritySmart Generation#archive#secure#zip
ApyHub
ApyHub
verified icon
200 atoms
Base tier

About

This Utility API lets you archive multiple files to a password-protected ZIP file.
Archiving files with a password helps to protect them from unauthorized access. If you have sensitive or confidential information that you want to store, archiving the files with a password ensures that only those who have the password can access them.
Select API Endpoints
Input
Output

API Playground

API Documentation

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

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/secure-archive/files/archive-file?output=samplezip' \
2
--header 'apy-token: {{token}}' \
3
--form 'files=@"test.png"' \
4
--form 'files=@"sample.ppt"' \
5
--form 'password="hopefully-a-very-secure-password"'
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.
passwordStringYesA password to protect and encrypt the archive, with a minimum length of 8 characters.
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