File Encryption encrypts a binary file with an AES key and returns the encrypted file as binary output. Send a file and a URL-safe Base64 key, get the encrypted file back.
Use it when you need to protect documents before storage, transport, or sharing. The request body requires file and key, where the key must come from GenerateKey and be 16, 24, or 32 bytes when decoded. The file input supports uploads up to 10 MB.
The response is a binary file, so you can pass it straight into your storage layer, download flow, or downstream processing step. This fits workflows like encrypting customer uploads, securing exported reports, or wrapping files before moving them between systems.
If your product handles sensitive content, File Encryption gives you a simple file-level encryption step without adding custom crypto handling to your application.
Encrypt a file by uploading it along with the AES key.
curl -X POST "https://api.eu.apyhub.com/frolic/encrypt-and-decrypt-file-api/encrypt-file" \
-H "apy-token: $APY_TOKEN" \
-F "key=FsBheKBiDXTjDdHT-mPmN28QVqvZZ3Vm3hN4XbhrQHU=" \
-F "file=@/path/to/file"Returns a binary file download containing the encrypted file data.
Loading your default key…Encrypts an uploaded file using the provided AES key and returns the encrypted file as binary output.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| file | String | Yes | File to encrypt (max 10 MB) |
| key | String | Yes | AES key from GenerateKey, URL-safe Base64 (16, 24 or 32 bytes) |
Returns a binary file stream containing the encrypted file. The success response is a raw String-formatted binary payload, not a JSON object.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
Decrypt an .enc file by uploading the file and the encryption key.
curl -X POST "https://api.eu.apyhub.com/frolic/encrypt-and-decrypt-file-api/decrypt-file" \
-H "apy-token: $APY_TOKEN" \
-F "key=FsBheKBiDXTjDdHT-mPmN28QVqvZZ3Vm3hN4XbhrQHU=" \
-F "file=@/path/to/file.enc"Returns a JSON object with no declared top-level fields.
{}Loading your default key…Decrypts an encrypted file by accepting the encrypted file content and the encryption key used to protect it. The output schema is empty, so the response shape is not yet captured in the schema.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| file | String | Yes | The .enc file from EncryptFile. Format: binary. |
| key | String | Yes | The key the file was encrypted with. |
The endpoint returns a minimal acknowledgement on success — the detailed shape is not yet captured in the schema.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
bad_requestRequired parameter missing or malformed body.
unauthorizedAPI key missing, revoked, or not authorized for this service.
rate_limitedYour plan's per-second rate exceeded. Retry with exponential backoff.
upstream_busyBackend temporarily unavailable. Try again in a few seconds.
Closest matches in the catalog based on this service.
Reads that touch this API.
