Delete file

deleteFile(input: DeleteFileInput!): DeleteFilePayload

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

Arguments

Argument	Type	Required
`input`	`DeleteFileInput!`	Yes

Field	Type	Required	Description
`filePath`	`String!`	Yes	File path whose deletion appends a deletion version in main or the selected branch; immutable history remains. URL-encode this path when supplied in a REST URL.
`expectedVersionId`	`String`	No	Optional optimistic-concurrency guard: the delete is rejected before any mutation when the file’s current version no longer matches.
`ref`	`String`	No	Canonical content selector: main, branch:<name-or-id>, release:<version> or env:<name>. An unresolvable reference is rejected; it never falls back to main. A release or environment is read-only, so a write addressed to one is refused rather than applied elsewhere.
`branchId`	`String`	No	Legacy alias for ref=branch:<value>. Supplying both is accepted when they name the same content and rejected when they do not.

Returns DeleteFilePayload. Open the type for its fields and nested types.

Field	Type	Description
`ok`	`Boolean!`	Always true: the file 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.

mutation DeleteFile($input: DeleteFileInput!) {
  deleteFile(input: $input) {
    ok
  }
}

{
  "input": {
    "filePath": "example"
  }
}