IRPCVaultsAdminBasic.GetGroundLinkProxyAdmin
Administration API / specialized admin session idempotent
Gets one Ground Link proxy vault with its administrative details.
| Service | Vault management (basic) MFiles.IRPCVaultsAdminBasic |
|---|---|
| gRPC method | /MFiles.IRPCVaultsAdminBasic/GetGroundLinkProxyAdmin |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-ground-link-proxy-admin |
| Request | GetGroundLinkProxyAdminRequest |
| Response | GetGroundLinkProxyAdminResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Any session can call it. With the server right
manage_vaultsthe data is complete; otherwise only the basic data is filled. - A GUID that is not a Ground Link proxy vault (also an ordinary vault) fails with "The specified document vault does not exist.".
Request: GetGroundLinkProxyAdminRequest
A structure that specifies get ground link proxy admin request.
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 |
|---|---|---|
guid | string | The GUID of the Ground Link proxy vault, with braces. |
Response: GetGroundLinkProxyAdminResponse
A structure that specifies get ground link proxy admin response.
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 |
|---|---|---|
can_manage_vaults | bool | True if the caller has the server right manage_vaults. |
vault | VaultEx | The vault. With can_manage_vaults all fields are filled except database credentials; otherwise only the basic data. See VaultEx. |
vault.vault | Vault | Basic data. |
vault.vault.vault | VaultBasic | Basic data. |
vault.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.vault.additional_data_folders[] | repeated AdditionalFolder | The specification of the additional file data folders. |
vault.vault.database_info | SQLDatabase | The vault's SQL database. |
vault.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.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.vault_type | VaultType | The vault type.Values: VAULT_TYPE_NORMAL_VAULT (0), VAULT_TYPE_REPLICA_VAULT (1), VAULT_TYPE_GROUND_LINK_PROXY (2). |
vault.master_server_address | ServerAddress | The address of the master server. Specified if the vault type is 'replica'. |
vault.master_server_address.network_address | string | The network address (name) of the server. |
vault.master_server_address.endpoint | string | The endpoint of the server. |
vault.master_server_address.protocol_sequence | string | The protocol sequence of the server. |
vault_variables[] | repeated VaultVariable | Always empty for Ground Link proxy vaults. |
vault_variables[].name | string | The name of the vault variable. |
vault_variables[].value | bytes | The value of the variable in a serialized format. |
online_state | bool | The online state of the vault. |