Delete a file or folder
Delete a file or folder.
DELETE
/v1/sessions/{id}/filesRequest
| Method and path | DELETE/v1/sessions/{id}/files |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
Path parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
idrequired | string | – | – |
Query parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
path | string | . | – | A path inside the workspace, e.g. downloads/report.csv. |
curl -X DELETE "https://api.boxline.dev/v1/sessions/$SESSION_ID/files?path=report.pdf" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLawait bx.sessions.files.delete("SESSION_ID", "report.pdf");from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLbx.sessions.files.delete("SESSION_ID", "report.pdf")boxline files rm $SESSION_ID report.pdfResponses
204 No Content
Deleted.
Deleted.Errors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 400 Bad Request | invalid_request, invalid_json, invalid_cursor, invalid_idempotency_key, invalid_extension, variables_with_extensions, terms_not_accepted, invalid_reset_token, invalid_confirmation_code, wrong_password, no_password, invalid_next, invalid_oauth_token | The request is not valid. |
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
| 404 Not Found | not_found, invite_not_found, provider_unavailable | No such thing in this project (or organization), or no such route. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Use with the browser
Clear old downloads before the browser saves a new one, so waiting finds the new file. See Browser, shell and files together.
curl -X DELETE "https://api.boxline.dev/v1/sessions/$SESSION_ID/files?path=downloads" \ -H "x-api-key: $BOXLINE_API_KEY"# … click the download link, then wait for downloads/*.csvawait session.files.delete("downloads"); // the folder comes back with the next downloadawait session.actions({ action: "click", selector: "text=Download report" });const csv = await session.files.waitFor("downloads/*.csv");session.files.delete("downloads") # the folder comes back with the next downloadsession.actions({"action": "click", "selector": "text=Download report"})csv = session.files.wait_for("downloads/*.csv")Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.