Delete upload

deleteUpload(input: DeleteUploadInput!): DeleteUploadPayload!

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

Arguments

ArgumentTypeRequired
inputDeleteUploadInput!Yes

Input fields

input

DeleteUploadInput

FieldTypeRequiredDescription
projectReferenceStringNoProject UUID, slug or configured domain. Omission does not select the context project.
uploadReferenceStringNoUpload path to soft-delete. Requires upload write and path edit access; API keys also need delete scope. Restoration requires the deleted record to exist; no deletion-age cutoff is enforced.
filePathStringNoAnother spelling of uploadReference. Send one of the two.

Response

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

FieldTypeDescription
okBoolean!Always true: the upload was deleted. A failure is a GraphQL error.

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

Example

graphql
mutation DeleteUpload($input: DeleteUploadInput!) {
  deleteUpload(input: $input) {
    ok
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}