apyhub-logo

Generate Secure Archives

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.
Endpoint Selector
Input
Output

API Playground

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 output zip file name containing the files. Default is output.zip
Request Body
AttributeTypeMandatoryDescription
filesFile arrayYesThe source files that you want to archive. You can select as many files as you want.
passwordStringYesThe password used to secure the archive
Sample Response
A successful request returns the a password protected archive file in the output parameter specified. If the request failed, the response contains an error code and a message to help determine what went wrong.

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 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 workspace settings (on the left side of the navbar) and go to applications.
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.