Vault API
Everything an application does in a vault on behalf of a user.
39 services, 380 methods, grouped by importance level. Each service page lists its highlighted methods first, then all others.
Core services
The main developer journeys: documented in the most depth.
| Service | Methods | Summary |
|---|---|---|
Server version IRPCQueryVersion | 2 | An interface for querying server version information. |
Login and sessions IRPCLogin | 25 | An interface for handling client login & logout operations. |
Vaults on a server IRPCVaults | 3 | An interface for enumerating vaults. |
Vault information IRPCVault | 26 | An interface for vault-level information and operations. |
Object types IRPCObjectTypes | 3 | An interface for reading object types. |
Property definitions and classes IRPCPropertyDefs | 4 | An interface for retrieving property definitions. |
Value lists IRPCValueLists | 17 | Reads value lists and their items, and lets users add and edit value list items and traditional folders. |
Search IRPCSearch | 14 | An interface for performing searches. |
Objects, versions, properties and files IRPCObjectOperations | 132 | An interface for handling documents and files |
Standard services
The rest of the end-user API.
| Service | Methods | Summary |
|---|---|---|
Stateless file upload sessions IRPCFileTransfer | 3 | Stateless file upload. No method requires a sticky session. |
Streaming file upload IRPCFileTransferStreaming | 2 | File transfer methods that stream the file data. |
Views IRPCViews | 14 | Reads and maintains the views of the vault: the common views and the calling user's own (private) views. |
Server push IRPCServerDataPush | 2 | A server-to-client channel: the server pushes requests and notifications to a logged-in client over a long-lived stream. |
Notification rules IRPCNotificationRules | 4 | Manages notification rules: which events on which objects send the user a notification. |
Shared links IRPCSharedLinks | 15 | Creates and manages shared links to files for people outside the vault. |
Shared links (anonymous access) IRPCSharedLinksPublic | 7 | Opens and downloads files through shared links, without logging in. |
Events and notifications IRPCEvents | 7 | Reads and sets the user's notification switch, checks whether a user can receive notifications, and sends requests and custom notifications to users. |
Event log IRPCEventLog | 1 | Writes custom entries to the vault's event log. |
Thumbnails IRPCThumbnails | 2 | Gets thumbnail images of document files and the vault's thumbnail settings. |
Languages IRPCLanguages | 2 | Lists the vault's metadata languages and changes the calling user's vault language. |
Named access control lists IRPCNamedACLs | 1 | Lists the named access control lists that the calling user can see. |
Named value storage IRPCNamedValueStorage | 3 | Reads and writes named values: small key-value settings stored in the vault, grouped by storage type and namespace. |
Workspaces IRPCWorkspace | 3 | Workspace tabs: the views of related objects shown for an object of a given type. |
Task pane configurations IRPCTaskPaneConfigurations | 4 | Stores the task pane configuration of M-Files Desktop per user and for all users. |
Folder UI settings IRPCFolderUISettings | 7 | Stores the display settings of folders per user and as common defaults. |
Substitute users IRPCSubstituteUsers | 4 | Reads and sets the substitute users of users. |
Electronic signatures IRPCElectronicSignatures | 2 | An interface for working with electronic signatures. |
Sensitivity labels IRPCSensitivityLabels | 1 | Reads the Microsoft Purview sensitivity labels of files. |
Exported data sets IRPCExportedDataSets | 7 | Reads the exported data sets of the vault and reports their export status (M-Files Reporting). |
Data export IRPCDataExport | 5 | Reads objects, value list items and property value history in bulk, in batches ordered by ID, for exporting vault data to another system. |
Scanning and OCR IRPCScanningAndOCR | 8 | Runs server-side OCR: converts files to searchable PDF and recognizes text in page areas. |
Vault extension methods IRPCVaultExtensionMethods | 5 | Calls vault extension methods: server-side code in the vault that takes a string and returns a string. |
Client scripts and UI extension applications IRPCClientScript | 16 | Lists, installs, enables, disables, licenses and removes the applications of the vault: vault applications (server side) and UI extension applications (client side), and downloads their packages and files. |
Conversations IRPCConversationOperations | 6 | Stores conversations with Aino and their chat turns in the vault, per user. |
Aino agents IRPCAgent | 3 | Connects M-Files clients to the Aino agents of M-Files Cloud. |
Anonymous login IRPCAnonymousLoginOperations | 2 | An interface for managing anonymous authentication operations. |
Identities IRPCIdentityOperations | 1 | Lets M-Files cloud services that hand out object and value list item IDs on behalf of a vault ask the vault to replenish their ID ranges. |
Extension authentications IRPCExtensionAuthentications | 8 | Manages the credentials that the vault uses to access external systems, such as external repositories connected to the vault, on behalf of the user. |
Connection and health checks IRPCTest | 9 | An interface for testing connection between a client and the server. |