Delete upload folder

veryfront__delete_upload_folder

Requires project.uploads.write; API keys also need delete scope.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
folder_pathstringNoFolder prefix whose visibility settings and contained files are removed; files are soft-deleted. Requires upload write and path edit access. Minimum length: 1.
pathstringNoAnother spelling of folder_path. Send one of the two. Minimum length: 1.
confirmbooleanYesMust be true to confirm folder deletion and soft deletion of contained files. Value: true.
project_referencestringNoProject ID or slug. Minimum length: 1.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__delete_upload_folder",
    "arguments": {
      "confirm": true
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
okbooleanYesValue: true.

Full schemas

json
{
  "type": "object",
  "properties": {
    "folder_path": {
      "type": "string",
      "minLength": 1,
      "description": "Folder prefix whose visibility settings and contained files are removed; files are soft-deleted. Requires upload write and path edit access."
    },
    "path": {
      "type": "string",
      "minLength": 1,
      "description": "Another spelling of folder_path. Send one of the two."
    },
    "confirm": {
      "type": "boolean",
      "const": true,
      "description": "Must be true to confirm folder deletion and soft deletion of contained files."
    },
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project ID or slug."
    }
  },
  "required": [
    "confirm"
  ],
  "additionalProperties": false,
  "description": "Arguments for the delete_upload_folder tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the delete_upload_folder tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}