Prepress

Files

Explore the data types and operations available in Files.

80 operations

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listFilesQuery

List files with pagination and filtering. Requires file:list permission.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listStorageBackendsQuery

List the calling tenant's storage backends. Requires storageBackend:list permission.

magicQueryQuery

Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.

pauseInboxFolderMutation

Pause polling and fence in-flight mailbox work.

pingQuery

Health check endpoint

rebindInboxFolderMutation

Replace a paused mailbox and reset its namespace without importing existing messages.

releaseInboxMessageMutation

Request fresh bounded parsing/scanning with an audited reason. Admission is never directly bypassed.

releaseInboxMessageHoldMutation

Release this operator's retention hold with an audited reason.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

replayInboxDeliveryMutation

Create one bounded new delivery generation for a currently enabled matching trigger.

requestFileUploadsMutation

Allocate one or more cloud upload URLs. Requires file:write permission.

requestInboxReplyMutation

Persist an idempotent reply request after fresh actor, sender, recipient, File and scan checks.

resolveInboxOutboundMutation

Audit an operator's confirmation or explicit resend decision for unknown delivery.

resumeInboxFolderMutation

Recheck retrieval and storage before resuming the saved cursor.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

setInboxFolderCredentialMutation

Store a mailbox credential without returning it.

storageCapabilitiesQuery

Which storage backend kinds this deployment supports, so a client can hide unusable options. Requires storageBackend:list permission.

testFolderMutation

Checks a folder transport with a read-only stat probe. CONTROL_CLOUD reports UNKNOWN because its sentinel probe cannot verify tenant storage provisioning or remote reachability. Other bindings accept an absent sentinel as reachable; this does not test write permissions. Nothing is written, and no folder state changes. Requires folder:read permission.

testInboxFolderMutation

Test credentials and required TLS without importing or sending mail.

testStorageBackendMutation

Probe a storage backend's connectivity with its stored credentials (a bucket/root head — nothing is written). Never throws: a failure comes back as ok: false with a reason. Requires storageBackend:read permission.

topicExamplesQuery

Fetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.

updateFileMutation

Update a file. Only provided fields are changed. Requires file:write permission.

updateFolderMutation

Patches a folder. Omitted fields are left unchanged. A folder that files already reference may not have its binding or root path changed (stored file handles would resolve against the wrong transport/prefix), and the tenant default may be moved to another folder but never simply unset. Requires folder:write permission.

updateInboxFolderMutation

Replace a paused configuration using optimistic concurrency.

updateStorageBackendMutation

Update a storage backend. Only provided fields are changed. Requires storageBackend:write permission.

upsertFileMutation

Create or update an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.

upsertStorageBackendMutation

Create or update a storage backend in one call. Prefer createStorageBackend / updateStorageBackend, which have the same validation but distinct create/update semantics. Requires storageBackend:write permission.