Rename folder

Outcome

Copy and delete objects from one accessible folder prefix to another, retaining metadata. The handler does not rewrite stored sharing records or semantic index entries.

Before you start

• Verify identity, pin environment and organization, and discover a granted Bytes workspace before choosing file keys.
• The action requires folders:write. 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.rename_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

PUT /api/folder/rename

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": {
    "oldPath": {
      "type": "string",
      "minLength": 1
    },
    "newPath": {
      "type": "string",
      "minLength": 1
    },
    "bucket": {
      "type": "string",
      "minLength": 1
    },
    "scope": {
      "type": "string",
      "enum": [
        "org",
        "private",
        "all"
      ]
    }
  },
  "required": [
    "oldPath",
    "newPath"
  ],
  "additionalProperties": false
}

Effects

• Moves objects one by one. This operation is not a transaction.

Interpret the response

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

Compare filesMoved and the original/target listings. Preserve per-request errors and inspect both prefixes after any interrupted or failed request.

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",
    "oldPath",
    "newPath",
    "filesMoved",
    "message"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "oldPath": {
      "type": "string"
    },
    "newPath": {
      "type": "string"
    },
    "filesMoved": {
      "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:

{
  "oldPath": "old-folder",
  "newPath": "new-folder"
}

CLI:

topolo actions validate app_topolo_bytes.folder.rename_alt --data @payload.json --json
topolo actions plan app_topolo_bytes.folder.rename_alt --resource-type workspace --resource-id "$BYTES_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_bytes.folder.rename_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.rename_alt",
    "input": {
      "oldPath": "old-folder",
      "newPath": "new-folder"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "success": true,
  "oldPath": "old-folder/",
  "newPath": "new-folder/",
  "filesMoved": 2,
  "message": "Folder renamed successfully. Moved 2 files."
}

HTTP 200. Compare filesMoved and the original/target listings. Preserve per-request errors and inspect both prefixes after any interrupted or failed request.

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:

{
  "oldPath": "a"
}

CLI:

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

Captured local response · HTTP 400:

{
  "error": "Both oldPath and newPath are required"
}

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

Refused request · HTTP 404

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:

{
  "oldPath": "nope",
  "newPath": "yep"
}

CLI:

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

Captured local response · HTTP 404:

{
  "error": "Folder not found or empty"
}

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

Verify the result

• Compare filesMoved and the original/target listings. Preserve per-request errors and inspect both prefixes after any interrupted or failed request.

Errors and recovery

• Both oldPath and newPath are 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 not found or empty (HTTP 404): Discover the existing file, share or release in the intended scope. A missing or inaccessible target is not authorization to create a replacement.

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

Capture all original paths first; reverse a confirmed move only after checking target collisions and shared-link dependencies.

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.