Delete upload folder

deleteUploadFolder(input: UploadFolderPathInput!): UploadFolderDeletion!

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

Arguments

ArgumentTypeRequired
inputUploadFolderPathInput!Yes

Input fields

input

UploadFolderPathInput

FieldTypeRequiredDescription
projectReferenceStringNoProject UUID, slug or configured domain. Omission does not select the context project.
folderPathStringNoFolder path; a trailing slash is appended when absent. Deletion requires path edit access.
pathStringNoAnother spelling of folderPath. Send one of the two.

Response

Returns UploadFolderDeletion!. Open the type for its fields and nested types.

FieldTypeDescription
okBoolean!Always true: folder settings were removed and contained files soft-deleted.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation DeleteUploadFolder($input: UploadFolderPathInput!) {
  deleteUploadFolder(input: $input) {
    ok
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}