apyhub-logo
300 atoms
Base tier

About

This Utility API lets you extract files from a password protected archive.
Extracting a zip file is important to ensure proper access to the files contained within it. These secure compressed files cannot be directly used by most applications, and they need to be extracted in order to be accessed with some password. It helps to ensure the security and integrity of the files, and can also help with organization and ease of access.
Endpoint Selector
Input

API Playground

Documentation

submit secure file: extracted urls
POST
https://api.apyhub.com/extract/secure-archive/file/file-urls

Request example

1
curl --location --request POST 'https://api.apyhub.com/extract/secure-archive/file/file-urls' \
2
--header 'apy-token: {{token}}' \
3
--form 'file=@"secure-archive.zip"'
Method: POST
Content Type: multipart/form-data
Request Body
AttributeTypeMandatoryDescription
fileArchived fileYesThe source file for the secure archive.
passwordStringYesThe password to open the secure archive
Response
AttributeTypeDescription
data[]Array of StringsContains an array of urls for the files contained within an archive

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 archive file is empty or the file was 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.