Delete folder

Outcome

Delete objects beneath one folder prefix. A nonempty folder requires force:true; action input wraps the HTTP query in a query object.

Before you start

• Verify identity, pin environment and organization, and discover a granted Bytes workspace before choosing file keys.
• The action requires files:delete. Select a verified workspace resource separately from action input; a body field cannot supply a workspace grant.
• Scope org uses the verified workspace shared root; private uses the caller’s private subtree. The accepted legacy all value resolves to org and does not grant cross-organization browsing. The bucket input cannot switch the configured R2 binding.
• Authorize the described effect or private-data export before passing CLI --confirm or MCP confirm:true. GET listing/search can persist derived data; HTTP method alone does not establish a read-only action.

Discover the target

topolo whoami --json
topolo actions get app_topolo_bytes.folder.delete_alt --detail --json
topolo resources topolo-bytes --json
topolo workspaces list topolo-bytes --json

• File keys are paths returned by files.list/search in the selected workspace and scope. Discover the granted workspace id; do not derive access from fixture ids.

Request

DELETE /api/folder/delete

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and the HTTP body. Set BYTES_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "folderPath": {
          "type": "string",
          "minLength": 1
        },
        "force": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          ]
        },
        "bucket": {
          "type": "string",
          "minLength": 1
        },
        "scope": {
          "type": "string",
          "enum": [
            "org",
            "private",
            "all"
          ]
        }
      },
      "required": [
        "folderPath"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Effects

• Permanently deletes the listed objects. This handler does not perform the file-delete handler’s separate semantic cleanup.

Interpret the response

The response identifier path is $.folderPath for folder. An empty list does not discover a target.

Read deletedFiles and list the exact prefix. Verify index and sharing records separately. Force accepts boolean true or the query string true.

The schema describes supported success fields; optional metadata and integration-dependent values may vary. Errors have the exact shapes shown in refused examples.

Success schema:

{
  "type": "object",
  "required": [
    "success",
    "folderPath",
    "deletedFiles",
    "message"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "folderPath": {
      "type": "string"
    },
    "deletedFiles": {
      "type": "number"
    },
    "message": {
      "type": "string"
    }
  }
}

Worked examples

Actual exported Worker handlers with local Miniflare R2/KV. Auth, workspace grants, R2 multipart, notification, usage and semantic integrations are simulated at their configured test boundaries. Synthetic ids, timestamps and signed URLs confer no live access. No deployed provider outcome, external delivery or live grant is established. Upload-session credential values are explicitly redacted; binary responses use the tested SDK transport envelope. Replace synthetic identifiers through credential-scoped discovery. Refused scenarios document failure boundaries; they are not successful workflows.

Successful request

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "query": {
    "folderPath": "trash",
    "force": "true"
  }
}

CLI:

topolo actions validate app_topolo_bytes.folder.delete_alt --data @payload.json --json
topolo actions plan app_topolo_bytes.folder.delete_alt --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_bytes.folder.delete_alt --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_bytes.folder.delete_alt",
    "input": {
      "query": {
        "folderPath": "trash",
        "force": "true"
      }
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "success": true,
  "folderPath": "trash/",
  "deletedFiles": 2,
  "message": "Folder \"trash/\" deleted successfully with 2 files"
}

HTTP 200. Read deletedFiles and list the exact prefix. Verify index and sharing records separately. Force accepts boolean true or the query string true.

Refused request · HTTP 400

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "query": {}
}

CLI:

topolo actions validate app_topolo_bytes.folder.delete_alt --data @payload.json --json
topolo actions plan app_topolo_bytes.folder.delete_alt --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 400:

{
  "error": "Folder path is required"
}

HTTP 400. This request was refused; preserve the exact response and correct its cause before retrying.

Refused request · HTTP 400

Actual worker response with local Miniflare R2/KV and simulated Auth, workspace grants and outbound integration boundaries. No authorization header is captured.

Input · payload.json:

{
  "query": {
    "folderPath": "full"
  }
}

CLI:

topolo actions validate app_topolo_bytes.folder.delete_alt --data @payload.json --json
topolo actions plan app_topolo_bytes.folder.delete_alt --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 400:

{
  "error": "Folder is not empty. Use force=true to delete all contents."
}

HTTP 400. This request was refused; preserve the exact response and correct its cause before retrying.

Verify the result

• Read deletedFiles and list the exact prefix. Verify index and sharing records separately. Force accepts boolean true or the query string true.

Errors and recovery

• Folder path is required (HTTP 400): Correct the exact fields using the discovered input schema and prerequisites. Refused input examples demonstrate errors and must not be executed as successful workflows.
• Folder is not empty. Use force=true to delete all contents. (HTTP 400): Correct the exact fields using the discovered input schema and prerequisites. Refused input examples demonstrate errors and must not be executed as successful workflows.

Authentication, the action-input validator or resource middleware can refuse a request before this handler. Preserve the exact request id, error and selected credential context. The fixtures establish no live credentials or configured provider.

Recovery boundary

Back up actual bytes before a forced deletion. There is no recovery action for deleted content.

Related actions

• List files: List one page of files and directories in the verified workspace; eligible files can have derived thumbnails generated during listing.

Evidence

Actual exported Worker handlers with local Miniflare R2/KV. Auth, workspace grants, R2 multipart, notification, usage and semantic integrations are simulated at their configured test boundaries. Synthetic ids, timestamps and signed URLs confer no live access. No deployed provider outcome, external delivery or live grant is established. Upload-session credential values are explicitly redacted; binary responses use the tested SDK transport envelope. Capture digests and test scenarios are retained in the source fixture records.