IRPCVaultsAdminBasic.GetGroundLinkProxiesAdmin

Administration API / specialized admin session idempotent

Lists the Ground Link proxy vaults of the server, including offline ones.

Service	Vault management (basic) `MFiles.IRPCVaultsAdminBasic`
gRPC method	`/MFiles.IRPCVaultsAdminBasic/GetGroundLinkProxiesAdmin`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-ground-link-proxies-admin`
Request	`GetGroundLinkProxiesAdminRequest`
Response	`GetGroundLinkProxiesAdminResponse`
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_vaults the data is complete; otherwise only the basic data is filled.
vaults, vault_variables and online_states are parallel lists.

Request: GetGroundLinkProxiesAdminRequest

A structure that specifies get ground link proxies admin request.

No fields.

Response: GetGroundLinkProxiesAdminResponse

A structure that specifies get ground link proxies 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`; then the vault data is complete.
`vaults[]`	repeated `VaultEx`	The Ground Link proxy vaults. With `can_manage_vaults` all fields are filled except database credentials; otherwise only the basic data. See VaultEx.
`vaults[].vault`	`Vault`	Basic data.
`vaults[].vault.vault`	`VaultBasic`	Basic data.
`vaults[].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).
`vaults[].vault.additional_data_folders[]`	repeated `AdditionalFolder`	The specification of the additional file data folders.
`vaults[].vault.database_info`	`SQLDatabase`	The vault's SQL database.
`vaults[].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).
`vaults[].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.
`vaults[].vault_type`	`VaultType`	The vault type.Values: `VAULT_TYPE_NORMAL_VAULT` (0), `VAULT_TYPE_REPLICA_VAULT` (1), `VAULT_TYPE_GROUND_LINK_PROXY` (2).
`vaults[].master_server_address`	`ServerAddress`	The address of the master server. Specified if the vault type is 'replica'.
`vaults[].master_server_address.network_address`	`string`	The network address (name) of the server.
`vaults[].master_server_address.endpoint`	`string`	The endpoint of the server.
`vaults[].master_server_address.protocol_sequence`	`string`	The protocol sequence of the server.
`vault_variables[]`	repeated `VaultVariableArray`	The vault variables of each vault, in the order of `vaults`. Not valid for offline vaults.
`vault_variables[].value[]`	repeated `VaultVariable`	Array of vault variables (VaultVariable).
`vault_variables[].value[].name`	`string`	The name of the vault variable.
`vault_variables[].value[].value`	`bytes`	The value of the variable in a serialized format.
`online_states[]`	repeated `bool`	Whether each vault is online, in the order of `vaults`.