Encrypt Excel Workbook with Aspose.Cells Cloud API – cURL and SDK Examples
REST API
This REST API encrypts an Excel workbook.
POST https://api.aspose.cloud/v3.0/cells/{name}/encryption
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
Query Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| folder | string | ✗ | Folder path of the original workbook. |
| storageName | string | ✗ | Name of the storage to use. |
Request Body Parameter
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| encryption | WorkbookEncryptionRequest | ✓ | Encryption settings for the workbook. |
WorkbookEncryptionRequest
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| EncryptionType | string | ✓ | Encryption algorithm. See the table below for supported values and their meanings. |
| KeyLength | integer | ✗ | Length of the encryption key in bits (ignored for XOR and Compatible). |
| Password | string | ✓ | Password used for encryption. |
EncryptionType values
| Value | Description |
|---|---|
XOR |
Simple XOR algorithm (legacy, low security). |
Compatible |
Excel 97‑2003 compatible encryption (40‑bit). |
EnhancedCryptographicProviderV1 |
AES‑128 with SHA‑1 hash. |
StrongCryptographicProvider |
AES‑256 with SHA‑512 hash (strongest). |
Response
{
"Status":"OK",
"Code":200
}
Http Status Codes
| Code | Meaning | Description |
|---|---|---|
| 200 | OK | Compression succeeded; response contains compressed file details. |
| 400 | Bad Request | Missing or invalid parameters (e.g., unsupported file type). |
| 401 | Unauthorized | Invalid or missing JWT token. |
| 413 | Payload Too Large | Uploaded file exceeds size limit. |
| 500 | Internal Server Error | Unexpected server error. |
How to Use the PostEncryptDocument API with SDKs
PostEncryptDocument API Specification
The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.
You can use the cURL command‑line tool to access Aspose.Cells web services easily. The following example shows how to make a call to the Cloud API with cURL.
Use Aspose.Cells Cloud SDKs
Using an SDK is the best way to speed up development. An SDK handles low‑level details so you can focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.
The following code examples demonstrate how to call Aspose.Cells web services using various SDKs: