Delete external file

deleteExternalFile(input: ExternalStorageFileInput!): ExternalStorageDelete!

Requires project.integrations.connect; API keys also need delete scope.

Arguments

ArgumentTypeRequired
inputExternalStorageFileInput!Yes

Input fields

input

ExternalStorageFileInput

FieldTypeRequiredDescription
providerString!YesStorage provider accessed through the caller's own personal connection. A human caller is required; agent, run, and service-account credentials are refused.
projectReferenceStringNoProject ID or slug. Access is checked for the selected operation.
fileIdString!Yes

Response

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

FieldTypeDescription
okBoolean!Always true: the provider accepted the delete.
statusString!deleted (Google Drive) or trashed (OneDrive, SharePoint recycle bin).

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

Example

graphql
mutation DeleteExternalFile($input: ExternalStorageFileInput!) {
  deleteExternalFile(input: $input) {
    status
    ok
  }
}
json
{
  "input": {
    "provider": "drive",
    "projectReference": "example-project",
    "fileId": "00000000-0000-4000-8000-000000000001"
  }
}