Prepress
Files
Explore the data types and operations available in Files.
80 operations
List all valid data change event topics, grouped by resource. Requires authentication.
listFilesQueryList files with pagination and filtering. Requires file:list permission.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listStorageBackendsQueryList the calling tenant's storage backends. Requires storageBackend:list permission.
magicQueryQueryExecutes 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.
pauseInboxFolderMutationPause polling and fence in-flight mailbox work.
pingQueryHealth check endpoint
rebindInboxFolderMutationReplace a paused mailbox and reset its namespace without importing existing messages.
releaseInboxMessageMutationRequest fresh bounded parsing/scanning with an audited reason. Admission is never directly bypassed.
releaseInboxMessageHoldMutationRelease this operator's retention hold with an audited reason.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
replayInboxDeliveryMutationCreate one bounded new delivery generation for a currently enabled matching trigger.
requestFileUploadsMutationAllocate one or more cloud upload URLs. Requires file:write permission.
requestInboxReplyMutationPersist an idempotent reply request after fresh actor, sender, recipient, File and scan checks.
resolveInboxOutboundMutationAudit an operator's confirmation or explicit resend decision for unknown delivery.
resumeInboxFolderMutationRecheck retrieval and storage before resuming the saved cursor.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
setInboxFolderCredentialMutationStore a mailbox credential without returning it.
storageCapabilitiesQueryWhich storage backend kinds this deployment supports, so a client can hide unusable options. Requires storageBackend:list permission.
testFolderMutationChecks 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.
testInboxFolderMutationTest credentials and required TLS without importing or sending mail.
testStorageBackendMutationProbe 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.
topicExamplesQueryFetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.
updateFileMutationUpdate a file. Only provided fields are changed. Requires file:write permission.
updateFolderMutationPatches 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.
updateInboxFolderMutationReplace a paused configuration using optimistic concurrency.
updateStorageBackendMutationUpdate a storage backend. Only provided fields are changed. Requires storageBackend:write permission.
upsertFileMutationCreate or update an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.
upsertStorageBackendMutationCreate 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.