apyhub

Protected Unarchiver Extractor

What it does

Protected Archive Extractor lets you send a password-protected archive and get signed URLs for each extracted file back. It supports uploaded archives through file and remote archives through url, and both endpoints require a password to decrypt the contents.

Use it when you need to unlock .zip, .rar, or .7z files without handling the extraction yourself. The response is a data array of URI strings, each pointing to an extracted file in signed cloud storage. That makes it straightforward to hand off decompressed documents, images, or other assets to the next step in your workflow.

Protecting access to uploaded archives is a common need in document pipelines, support tooling, and internal file processing systems. You can accept an archive from a user, decrypt it with the provided password, and store or forward the resulting files using the returned links. Because the API returns URLs instead of raw binary payloads, it fits cleanly into systems that already work with object storage or downstream fetch jobs.

▣ ENDPOINT 01 / 02
POST
Extract password-protected uploaded archive and return signed URLs
https://api.eu.apyverse.com/apyhub/extract-protected-archive/file/link

QUICKSTART

GUIDE

Quickstart

Upload a password-protected archive and get back signed URLs for the extracted files.

curl -X POST "https://api.eu.apyverse.com/apyhub/extract-protected-archive/file/link" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/archive.zip" \
  -F "password=secret123"

What you'll get back

Returns a JSON object with a data array of URI strings — each item is a signed cloud storage URL for one extracted file.

{
  "data": [
    "https://storage.example.com/unzip/document.pdf?sig=abc",
    "https://storage.example.com/unzip/image.png?sig=def"
  ]
}
TRY ITLIVE · 300 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*
Password-protected archive (.zip, .rar, or .7z).
Password required to decrypt the archive.

About this endpoint

What it does

Extracts a password-protected uploaded archive and returns signed URLs for the files contained in it. The request sends the archive file and its password; the response returns a JSON object with a data array of URI strings.

Request Body

ParameterTypeMandatoryDescription
fileStringYesPassword-protected archive file uploaded as binary data. Supported archive formats: .zip, .rar, .7z.
passwordStringYesPassword used to decrypt the archive.

Response

Returns a JSON object with a data array of URI strings — one signed cloud storage URL for each extracted file.

ParameterTypeMandatoryDescription
dataString ArrayYesSigned cloud storage URLs for each extracted file. Each item is a URI.

Body

Name
Type
Description
bodyREQUIRED
object

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 02 / 02
POST
Extract password-protected remote archive and return signed URLs
https://api.eu.apyverse.com/apyhub/extract-protected-archive/url/link

QUICKSTART

GUIDE

Quickstart

Decrypt a protected archive from a URL by providing the archive link and its password.

curl -X POST "https://api.eu.apyverse.com/apyhub/extract-protected-archive/url/link" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://assets.apyhub.com/samples/sample.zip",
    "password": "secret123"
  }'

What you'll get back

Returns a JSON object with a data array of URI strings — each item is a signed cloud storage URL for an extracted file.

{
  "data": [
    "https://storage.example.com/unzip/document.pdf?sig=abc",
    "https://storage.example.com/unzip/image.png?sig=def"
  ]
}
TRY ITLIVE · 300 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
Password required to decrypt the archive.

About this endpoint

What it does

Extracts a password-protected archive from a remote URL and returns signed URLs for the extracted files.

Request Body

ParameterTypeMandatoryDescription
urlStringYesRemote archive URL. Must be a URI.
passwordStringYesPassword required to decrypt the archive.

Response

Returns a JSON object with a data string array field. Each item in the array is a signed cloud storage URL for an extracted file.

ParameterTypeMandatoryDescription
dataString ArrayYesSigned cloud storage URLs for each extracted file.

Body

Name
Type
Description
bodyREQUIRED
object
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.