# Vault API

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/vault/

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.

<a id="core"></a>

## Core services

The main developer journeys: documented in the most depth.

| Service | Methods | Summary |
|---|---|---|
| [Server version](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCQueryVersion/index.md) `IRPCQueryVersion` | 2 | An interface for querying server version information. |
| [Login and sessions](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCLogin/index.md) `IRPCLogin` | 25 | An interface for handling client login & logout operations. |
| [Vaults on a server](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaults/index.md) `IRPCVaults` | 3 | An interface for enumerating vaults. |
| [Vault information](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVault/index.md) `IRPCVault` | 26 | An interface for vault-level information and operations. |
| [Object types](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCObjectTypes/index.md) `IRPCObjectTypes` | 3 | An interface for reading object types. |
| [Property definitions and classes](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCPropertyDefs/index.md) `IRPCPropertyDefs` | 4 | An interface for retrieving property definitions. |
| [Value lists](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCValueLists/index.md) `IRPCValueLists` | 17 | Reads value lists and their items, and lets users add and edit value list items and traditional folders. |
| [Search](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSearch/index.md) `IRPCSearch` | 14 | An interface for performing searches. |
| [Objects, versions, properties and files](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCObjectOperations/index.md) `IRPCObjectOperations` | 132 | An interface for handling documents and files |

<a id="standard"></a>

## Standard services

The rest of the end-user API.

| Service | Methods | Summary |
|---|---|---|
| [Stateless file upload sessions](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFileTransfer/index.md) `IRPCFileTransfer` | 3 | Stateless file upload. No method requires a sticky session. |
| [Streaming file upload](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFileTransferStreaming/index.md) `IRPCFileTransferStreaming` | 2 | File transfer methods that stream the file data. |
| [Views](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCViews/index.md) `IRPCViews` | 14 | Reads and maintains the views of the vault: the common views and the calling user's own (private) views. |
| [Server push](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCServerDataPush/index.md) `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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCNotificationRules/index.md) `IRPCNotificationRules` | 4 | Manages notification rules: which events on which objects send the user a notification. |
| [Shared links](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinks/index.md) `IRPCSharedLinks` | 15 | Creates and manages shared links to files for people outside the vault. |
| [Shared links (anonymous access)](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSharedLinksPublic/index.md) `IRPCSharedLinksPublic` | 7 | Opens and downloads files through shared links, without logging in. |
| [Events and notifications](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCEvents/index.md) `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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCEventLog/index.md) `IRPCEventLog` | 1 | Writes custom entries to the vault's event log. |
| [Thumbnails](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCThumbnails/index.md) `IRPCThumbnails` | 2 | Gets thumbnail images of document files and the vault's thumbnail settings. |
| [Languages](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCLanguages/index.md) `IRPCLanguages` | 2 | Lists the vault's metadata languages and changes the calling user's vault language. |
| [Named access control lists](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCNamedACLs/index.md) `IRPCNamedACLs` | 1 | Lists the named access control lists that the calling user can see. |
| [Named value storage](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCNamedValueStorage/index.md) `IRPCNamedValueStorage` | 3 | Reads and writes named values: small key-value settings stored in the vault, grouped by storage type and namespace. |
| [Workspaces](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCWorkspace/index.md) `IRPCWorkspace` | 3 | Workspace tabs: the views of related objects shown for an object of a given type. |
| [Task pane configurations](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCTaskPaneConfigurations/index.md) `IRPCTaskPaneConfigurations` | 4 | Stores the task pane configuration of M-Files Desktop per user and for all users. |
| [Folder UI settings](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/index.md) `IRPCFolderUISettings` | 7 | Stores the display settings of folders per user and as common defaults. |
| [Substitute users](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSubstituteUsers/index.md) `IRPCSubstituteUsers` | 4 | Reads and sets the substitute users of users. |
| [Electronic signatures](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCElectronicSignatures/index.md) `IRPCElectronicSignatures` | 2 | An interface for working with electronic signatures. |
| [Sensitivity labels](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCSensitivityLabels/index.md) `IRPCSensitivityLabels` | 1 | Reads the Microsoft Purview sensitivity labels of files. |
| [Exported data sets](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCExportedDataSets/index.md) `IRPCExportedDataSets` | 7 | Reads the exported data sets of the vault and reports their export status (M-Files Reporting). |
| [Data export](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCDataExport/index.md) `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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCScanningAndOCR/index.md) `IRPCScanningAndOCR` | 8 | Runs server-side OCR: converts files to searchable PDF and recognizes text in page areas. |
| [Vault extension methods](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultExtensionMethods/index.md) `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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCClientScript/index.md) `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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCConversationOperations/index.md) `IRPCConversationOperations` | 6 | Stores conversations with Aino and their chat turns in the vault, per user. |
| [Aino agents](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCAgent/index.md) `IRPCAgent` | 3 | Connects M-Files clients to the Aino agents of M-Files Cloud. |
| [Anonymous login](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCAnonymousLoginOperations/index.md) `IRPCAnonymousLoginOperations` | 2 | An interface for managing anonymous authentication operations. |
| [Identities](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCIdentityOperations/index.md) `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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCExtensionAuthentications/index.md) `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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCTest/index.md) `IRPCTest` | 9 | An interface for testing connection between a client and the server. |