GraphQL Files

The GraphQL Files Schema provides a robust API for managing file uploads and their associated metadata within the CMS. This documentation outlines the available types, queries, mutations, and input objects for developers to interact with file resources.

Table of Contents:

• Types
  • File
  • RemoveableUpload
• Queries
  • file
  • files
• Mutations
  • addFile
  • saveFile
  • dropFile
  • keepFile
  • purgeFile
  • pubFile
• Inputs
  • FileFilter
  • FileInput

The File type represents a stored file with its associated metadata and relationships.

Input type for filtering file queries.

Example:

query {
  files(filter: { lang: "en", name: "report" }) {
    id
    name
  }
}

Get a single file item by its unique ID.

Arguments:

Example:

query {
  file(id: "123") {
    id
    name
    path
    mime
  }
}

Get a list of available files, with options for filtering, sorting, and publishing status.

Arguments:

Example:

query {
  files(filter: { mime: "image/jpeg" }, sort: "name", publish: all) {
    id
    name
    mime
    lang
    editor
  }
}

Input type for creating or updating file data.

Example:

mutation AddNewFile {
  addFile(
    input: {
      lang: "en"
      name: "New Company Brochure"
      description: "{\"en\": \"Our latest company brochure.\"}"
    }
    file: "<UPLOAD_FILE_DATA>"
  ) {
    id
    name
  }
}

Adds a new file upload, optionally with a preview image and a description.

Arguments:

Example:

mutation AddNewFile($file: Upload!, $preview: Upload!) {
  addFile(input: { name: "My Document", lang: "en" }, file: $file, preview: $preview) {
    id
    name
    path
  }
}

Updates an existing file identified by its ID.

Arguments:

Example:

mutation UpdateFile($fileId: ID!, $newFile: Upload, $newPreview: RemoveableUpload) {
  saveFile(
    id: $fileId
    input: { name: "Updated Document Name" }
    file: $newFile
    preview: $newPreview
  ) {
    id
    name
    updated_at
  }
}

Deletes one or more existing files. This performs a soft delete, marking files as deleted but retaining them in the database.

Arguments:

Example:

mutation DeleteFiles {
  dropFile(id: ["123", "456"]) {
    id
    name
    deleted_at
  }
}

Restores one or more previously soft-deleted files.

Arguments:

Example:

mutation RestoreFiles {
  keepFile(id: ["123"]) {
    id
    name
    deleted_at
  }
}

Permanently purges one or more files from the database and storage. This action cannot be undone.

Arguments:

Example:

mutation PurgeFiles {
  purgeFile(id: ["789"]) {
    id
  }
}

Publishes one or more files at a specific date and time.

Arguments:

mutation PublishFiles {
  pubFile(id: ["101"], at: "2025-09-01T10:00:00Z") {
    id
    name
  }
}