Unarchive Files API
ApyHub
250 atoms
Base tier
About
This Utility API lets you extract files from an archive.
Extracting a zip file is important to ensure proper access to the files contained within it. These compressed files cannot be directly used by most applications, and they need to be extracted in order to be accessed. By extracting the files, you can access them in their original format, and they can be easily opened and used by the intended application.
Select API Endpoints
Input
API Playground
API Documentation
submit file: extracted urls
POST
https://api.apyhub.com/extract/archive/file/file-urls
Request example
Method:
POST
Content Type:
multipart/form-data
Request Body
Attribute | Type | Mandatory | Description |
---|---|---|---|
file | Archived file | Yes | The source file for the archive. |
Response
Attribute | Type | Description |
---|---|---|
data[] | Array of Strings | Contains 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 Code | Description |
---|---|
200 | The request was successful. |
401 | Required authentication information is either missing or not valid for the resource. |
400 | Invalid input - the archive file is empty or the file was corrupt. |
500 | If 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
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