IRPCVaultsAdmin.CreateNewVault
Administration API / specialized admin session
Creates a new document vault.
| Service | Vault management MFiles.IRPCVaultsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultsAdmin/CreateNewVault |
| HTTP (mf-http-grpc) | POST /grpc/v1/create-new-vault |
| Request | CreateNewVaultRequest |
| Response | CreateNewVaultResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires the system administrator server role (server right
manage_vaults). - Runs in the call and returns the new vault, with the GUID that the server generated.
- The definition is validated in full before anything is created.
Request: CreateNewVaultRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
vault | Vault | The definition of the new vault: name (vault.vault.display_name), data folder (vault.main_data_folder), database (vault.database_info) and file data storage. vault.vault.guid is ignored: the server generates a new GUID. |
vault.vault | VaultBasic | Basic data. |
vault.vault.guid | string | The vault GUID, in braces and upper case. Use it as LoginData.vault_guid. |
vault.vault.display_name | string | The vault name shown to users. |
vault.vault.tooltip | string | Optional description. Often empty. |
vault.vault.icon | bytes | The vault icon in .ico format, or empty. |
vault.vault.dns_names | StringArray | Host names configured for the vault, if any. |
vault.main_data_folder | string | The main physical folder of this vault on the server (e.g. C:\Program Files\M-Files\Server Vaults\MyVault). |
vault.additional_data_folders[] | repeated AdditionalFolder | The specification of the additional file data folders. |
vault.additional_data_folders[].path | string | Path (e.g. "\servername\sharename\folder"). |
vault.additional_data_folders[].limit_in_mb | uint32 | Data limit in megabytes or zero if no limit. |
vault.additional_data_folders[].impersonation | Impersonation | Impersonation information for accessing the folder. |
vault.database_info | SQLDatabase | The vault's SQL database. |
vault.database_info.engine | DBEngine | Database engine identification.Values: DBENGINE_NONE (0), DBENGINE_FIREBIRD (1), DBENGINE_MS_SQL_SERVER (2). |
vault.database_info.server_name | string | The data source i.e. the database server name where the vault's database is residing. This is specified for data service DB engines only. It is empty or unset for embedded databases such as Firebird Embedded. |
vault.database_info.database_name | string | The catalog i.e. the database name where the vault's data is residing. Allows the database name to differ from the vault display name. This is not specified in the Firebird case. |
vault.database_info.system_admin_impersonation | Impersonation | Impersonation information for accessing the database engine for administrative purposes. This contains SYSDBA (System Database Administrator) user name and password. If unset, the default user name and password are used. |
vault.database_info.basic_user_impersonation | Impersonation | Impersonation information for accessing the database engine in basic user operations that do not modify the database structure. This contains DB user name and password. If unset, the default user name and password are used. |
vault.file_data_storage | FileDataStorage | Identifies file data storage to use. Typically specifies that the file data storage is determined automatically.Values: FILE_DATA_STORAGE_DEFAULT (0), FILE_DATA_STORAGE_DISK (1), FILE_DATA_STORAGE_DATABASE (2), FILE_DATA_STORAGE_EXTERNAL (3), FILE_DATA_STORAGE_MASTER (4). |
vault.file_data_connection_string | string | The connection string that identifies the location, protocol, and credentials for the file data storage of this vault. For example, this might specify a storage account, a protocol, and a container name for Azure's BLOB Services. Can be unset or empty. |
vault_variables[] | repeated VaultVariable | Vault variables to set in the new vault. |
vault_variables[].name | string | The name of the vault variable. |
vault_variables[].value | bytes | The value of the variable in a serialized format. |
Response: CreateNewVaultResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
new_vault | Vault | The full definition of the new vault, including its new GUID. |
new_vault.vault | VaultBasic | Basic data. |
new_vault.vault.guid | string | The vault GUID, in braces and upper case. Use it as LoginData.vault_guid. |
new_vault.vault.display_name | string | The vault name shown to users. |
new_vault.vault.tooltip | string | Optional description. Often empty. |
new_vault.vault.icon | bytes | The vault icon in .ico format, or empty. |
new_vault.vault.dns_names | StringArray | Host names configured for the vault, if any. |
new_vault.main_data_folder | string | The main physical folder of this vault on the server (e.g. C:\Program Files\M-Files\Server Vaults\MyVault). |
new_vault.additional_data_folders[] | repeated AdditionalFolder | The specification of the additional file data folders. |
new_vault.additional_data_folders[].path | string | Path (e.g. "\servername\sharename\folder"). |
new_vault.additional_data_folders[].limit_in_mb | uint32 | Data limit in megabytes or zero if no limit. |
new_vault.additional_data_folders[].impersonation | Impersonation | Impersonation information for accessing the folder. |
new_vault.database_info | SQLDatabase | The vault's SQL database. |
new_vault.database_info.engine | DBEngine | Database engine identification.Values: DBENGINE_NONE (0), DBENGINE_FIREBIRD (1), DBENGINE_MS_SQL_SERVER (2). |
new_vault.database_info.server_name | string | The data source i.e. the database server name where the vault's database is residing. This is specified for data service DB engines only. It is empty or unset for embedded databases such as Firebird Embedded. |
new_vault.database_info.database_name | string | The catalog i.e. the database name where the vault's data is residing. Allows the database name to differ from the vault display name. This is not specified in the Firebird case. |
new_vault.database_info.system_admin_impersonation | Impersonation | Impersonation information for accessing the database engine for administrative purposes. This contains SYSDBA (System Database Administrator) user name and password. If unset, the default user name and password are used. |
new_vault.database_info.basic_user_impersonation | Impersonation | Impersonation information for accessing the database engine in basic user operations that do not modify the database structure. This contains DB user name and password. If unset, the default user name and password are used. |
new_vault.file_data_storage | FileDataStorage | Identifies file data storage to use. Typically specifies that the file data storage is determined automatically.Values: FILE_DATA_STORAGE_DEFAULT (0), FILE_DATA_STORAGE_DISK (1), FILE_DATA_STORAGE_DATABASE (2), FILE_DATA_STORAGE_EXTERNAL (3), FILE_DATA_STORAGE_MASTER (4). |
new_vault.file_data_connection_string | string | The connection string that identifies the location, protocol, and credentials for the file data storage of this vault. For example, this might specify a storage account, a protocol, and a container name for Azure's BLOB Services. Can be unset or empty. |