Administration API

Server and vault administration, metadata structure and user management.

28 services, 264 methods, grouped by importance level. Each service page lists its highlighted methods first, then all others.

Specialized services

Administration and server-integration services.

Service	Methods	Summary
Server administration `IRPCServerAdmin`	21	Server-wide administration: master database backup and restore, vault backups, server activity, gRPC endpoint certificates, notification (e-mail) settings, server users and the M-Files Manage subscription.
Vault management `IRPCVaultsAdmin`	23	Creates, attaches, detaches, destroys, upgrades, backs up, restores and copies the vaults of a server, and takes them offline and online.
Vault management (basic) `IRPCVaultsAdminBasic`	7	Lists the vaults, replica vaults and Ground Link proxy vaults of the server with their administrative details, as far as the caller is allowed to see them.
Vault administration `IRPCVaultAdmin`	21	Administers the vault of the session: verify and repair, search indexes, archiving and restoring from archives, and vault-level authentication settings.
Server login accounts `IRPCLoginsAdmin`	19	Manages the server's login accounts: list, add, modify and remove logins, force logouts, look up Windows accounts and groups, and handle password resets.
Vault login accounts `IRPCVaultLoginsAdmin`	17	Manages vault login accounts: login accounts stored in one vault, used on servers that have vault login accounts enabled, such as M-Files Cloud.
Users `IRPCUsersAdmin`	11	Adds, reads, modifies and removes the user accounts of a vault: who may use the vault, with which vault roles.
User groups `IRPCUserGroupsAdmin`	12	Adds, reads, modifies and removes the user groups of a vault and their members.
Object type administration `IRPCObjectTypesAdmin`	18	Administers object types and value lists: reads their full definitions, adds, modifies, converts and removes them, and manages value list items with administrator rights.
Property definition and class administration `IRPCPropertyDefsAdmin`	14	Administers property definitions and classes: reads their full definitions, adds, modifies and removes them, and starts recalculation of automatic values.
Class groups `IRPCDocClassGroupsAdmin`	4	Administers class groups: reads, adds, modifies and removes the groups that organize document classes.
Workflow administration `IRPCWorkflowsAdmin`	5	Administers workflows: reads their full definitions with states and transitions, and adds, modifies and removes them.
Common views administration `IRPCViewsAdmin`	1	Reads the common views and every user's private views of a vault, for administrators.
Named access control list administration `IRPCNamedACLsAdmin`	5	Adds, reads, modifies and removes the named access control lists (permission templates) of a vault.
Language administration `IRPCLanguagesAdmin`	5	Adds, modifies and removes the languages of a vault, and reads and writes the translations of its metadata structure names.
Event handlers `IRPCEventHandlersAdmin`	4	Reads and replaces the event handlers of a vault or of the server: VBScript code that the server runs when an event occurs.
Event administration `IRPCEventsAdmin`	13	Reads, exports and deletes the vault's event log, turns event logging on or off, and stores the caller's saved event log filters.
Scheduled jobs `IRPCScheduledJobsAdmin`	10	Lists, adds, changes, removes, starts and cancels scheduled jobs of the server or of a vault.
Background operations `IRPCBackgroundOperationsAdmin`	9	Monitors the vault's background work: refreshes of external object types and external locations, and the queue of asynchronous tasks.
Exported data set administration `IRPCExportedDataSetsAdmin`	9	Manages the vault's exported data sets: the definitions of the vault data that M-Files Reporting Data Services exports to a reporting database.
External locations `IRPCExternalLocationsAdmin`	6	Administers the vault's external sources: file folders and mail boxes from which the server imports or links content.
Thumbnail administration `IRPCThumbnailsAdmin`	1	Discards the thumbnail images stored in a vault.
Web access administration `IRPCWebAccessAdmin`	7	Sets up M-Files Web in Internet Information Services (IIS) on the server computer.
License management `IRPCLicenseManagement`	6	Reads and sets the server's license, its usage, and whether licensed features such as OCR or M-Files Web are available.
Monitoring status `IRPCMonitoringStatus`	3	Reads the vault's monitoring indicators; currently the status of the search indexes.
Declarative metadata structure `IRPCDeclarativeMetadataStructure`	8	Reads and validates the whole metadata structure of a vault as one declarative JSON document. Preview feature, off by default.
Declarative metadata structure (protobuf) `IRPCDeclarativeMetadataStructureAsProtobuf`	4	Reads and replaces the whole metadata structure of a vault as one typed message. Preview feature, off by default; for the declarative configuration converter.
Cloud management `IRPCCloudManagementApiOperations`	1	Gets the identity of the server in M-Files Manage, for client features that call M-Files cloud services.