M-Files gRPC API

View as Markdown

The M-Files Server gRPC API is the complete interface to M-Files Server. The M-Files web and desktop clients and M-Files Admin use it for everything they do with the server: working with objects, files and metadata, searching, workflows, and administering vaults and the server.

The COM API and the REST API, also documented on this portal, are layers on top of the same server interface: the COM API calls it, and the REST API is built on the COM API. They expose much, but not all, of what the gRPC API offers.

The API evolves with M-Files Server: most changes are additions, and methods can also be deprecated or removed. See Versions and compatibility.

You need a gRPC library for your language, the server's address (port 443 with TLS on M-Files Cloud, 7766 by default on-premises) and an M-Files account. Connecting to the server lists the endpoints, TLS and the limits.

Start here

  1. Find your endpoint: Cloud and on-premises tells M-Files Cloud and on-premises apart.
  2. Run a quickstart in your language, about 10 minutes: Python quickstart, C# quickstart, Go quickstart.
  3. Learn what every call needs: Connecting to the server, Authentication and sessions, Call metadata, Errors.
  4. Learn the model: Concepts -- The M-Files model behind the API: vaults and their metadata structure, objects and versions, properties, search, permissions and workflows.
  5. Do a task: Guides -- recipes for searching, reading and creating objects, files, workflows and errors.
  6. Look up methods in the API reference: Vault API, Administration API, Server integration API.

Client packages

The client code generated from the .proto files, with helpers for the connection, login, call metadata and errors that the guides use. Each package has the version of the server release it was generated from, and its repository has runnable examples.

LanguagePackageInstallSource
Pythonmfiles-grpcpip install mfiles-grpc==26.11.0M-Files/mfiles-grpc-python
C#MFiles.Grpcdotnet add package MFiles.Grpc --version 26.11.0M-Files/mfiles-grpc-dotnet
Gogithub.com/M-Files/mfiles-grpc-gogo get github.com/M-Files/mfiles-grpc-go@v0.2611.0M-Files/mfiles-grpc-go
API version26.11
PackageMFiles
Services78
Methods712
Generated2026-11-06T06:32:26+00:00

For coding agents

Every page has a Markdown twin: add index.md to its URL.

Concepts

Runtime conventions

Guides

API reference

BookContentsServicesMethods
Vault APIEverything an application does in a vault on behalf of a user.39380
Administration APIServer and vault administration, metadata structure and user management.28264
Server integration APIServices that other M-Files components and connectors call.1168

Downloads