Spreadsheet Protection – Set Open Password and Modify Password
Contents
[
Hide
]
In this guide you will learn how to set, modify, and remove both the open password and the read‑write password for spreadsheets using the Aspose.Cells Cloud Web API. These features help protect sensitive data in your Excel workbooks.
Prerequisites
- An active Aspose.Cells Cloud account with a valid API key and SID.
- The workbook you want to protect must be uploaded to Aspose Cloud storage or accessible via a public URL.
API Reference
| HTTP Method | Endpoint | Query / Path Parameters | Description |
|---|---|---|---|
PUT |
/cells/{fileName}/protection |
fileName (path) – name of the workbookopenPassword (query, optional) – password required to open the filereadWritePassword (query, optional) – password required to modify the file |
Sets or updates the open and/or read‑write passwords for the specified workbook. |
DELETE |
/cells/{fileName}/protection |
fileName (path) – name of the workbook |
Removes any passwords protecting the workbook. |
Request Body Example (JSON)
{
"OpenPassword": "MyOpenPwd123",
"ReadWritePassword": "MyEditPwd456"
}
Response Example (JSON)
{
"Code": 200,
"Status": "OK",
"Message": "Workbook protection updated successfully."
}
HTTP Status Codes
| Code | Meaning | Description |
|---|---|---|
| 200 | OK | Filter applied successfully; response contains operation 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. |
Code Samples
C# (Aspose.Cells Cloud SDK)
using Aspose.Cells.Cloud.SDK.Api;
using Aspose.Cells.Cloud.SDK.Model;
var apiInstance = new CellsApi("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET");
var request = new SetWorkbookProtectionRequest(
name: "Sample.xlsx",
openPassword: "MyOpenPwd123",
readWritePassword: "MyEditPwd456"
);
apiInstance.SetWorkbookProtection(request);
Python (Aspose.Cells Cloud SDK)
import asposecellscloud
from asposecellscloud.apis.cells_api import CellsApi
from asposecellscloud.models import SetWorkbookProtectionRequest
api = CellsApi(client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET")
request = SetWorkbookProtectionRequest(
name="Sample.xlsx",
open_password="MyOpenPwd123",
read_write_password="MyEditPwd456"
)
api.set_workbook_protection(request)
Error Handling
When an error occurs, the API returns a JSON payload containing Code, Message, and optionally Description. Check the status code and handle it accordingly in your application logic.
Related Topics