# IRPCVaultsAdminBasic.GetVaultsAdmin

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md) > [Administration API](https://developer.m-files.com/APIs/gRPC-API/admin/index.md) > [Vault management (basic)](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetVaultsAdmin/

Badges: `Administration API / specialized` `admin` `session` `idempotent`

Lists the ordinary vaults of the server (not replicas or Ground Link proxies) with their
administrative details, including offline vaults.

- **Service:** [Vault management (basic)](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/index.md) `MFiles.IRPCVaultsAdminBasic`
- **gRPC method:** `/MFiles.IRPCVaultsAdminBasic/GetVaultsAdmin`
- **HTTP (mf-http-grpc):** `POST /grpc/v1/get-vaults-admin`
- **Request:** [`GetVaultsAdminRequest`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetVaultsAdmin/index.md#request)
- **Response:** [`GetVaultsAdminResponse`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdminBasic/GetVaultsAdmin/index.md#response)
- **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)

<a id="remarks"></a>

## Remarks

- Any session can call it.
- With the server right `manage_vaults`: all vaults, with complete data. Otherwise: only vaults in
  which the caller has a user account (enabled or disabled), with basic data only. On servers
  with vault login accounts, a caller whose login comes from a vault sees only that vault.
- `vaults`, `vault_variables` and `online_states` are parallel lists: entry *i* of each describes
  the same vault. The order is not specified.
- Waits for vaults that are being brought online or offline before returning.

<a id="request"></a>

## Request: GetVaultsAdminRequest

A structure that specifies get vaults admin request.

No fields.

<a id="response"></a>

## Response: GetVaultsAdminResponse

A structure that specifies get vaults 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 [`Vault`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.Vault/index.md) | The vaults. With `can_manage_vaults` all fields are filled except database credentials; otherwise only the basic data (`vault`: GUID, name, host names). See [Vault](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.Vault/index.md). |
| `vaults[].vault` | [`VaultBasic`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.VaultBasic/index.md) | Basic data. |
| `vaults[].vault.guid` | `string` | The vault GUID, in braces and upper case. Use it as `LoginData.vault_guid`. |
| `vaults[].vault.display_name` | `string` | The vault name shown to users. |
| `vaults[].vault.tooltip` | `string` | Optional description. Often empty. |
| `vaults[].vault.icon` | `bytes` | The vault icon in .ico format, or empty. |
| `vaults[].vault.dns_names` | [`StringArray`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.StringArray/index.md) | Host names configured for the vault, if any. |
| `vaults[].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[].additional_data_folders[]` | repeated [`AdditionalFolder`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.AdditionalFolder/index.md) | The specification of the additional file data folders. |
| `vaults[].additional_data_folders[].path` | `string` | Path (e.g. "\\servername\sharename\folder"). |
| `vaults[].additional_data_folders[].limit_in_mb` | `uint32` | Data limit in megabytes or zero if no limit. |
| `vaults[].additional_data_folders[].impersonation` | [`Impersonation`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.Impersonation/index.md) | Impersonation information for accessing the folder. |
| `vaults[].database_info` | [`SQLDatabase`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.SQLDatabase/index.md) | The vault's SQL database. |
| `vaults[].database_info.engine` | [`DBEngine`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.DBEngine/index.md) | Database engine identification. Values: `DBENGINE_NONE` (0), `DBENGINE_FIREBIRD` (1), `DBENGINE_MS_SQL_SERVER` (2). |
| `vaults[].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. |
| `vaults[].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. |
| `vaults[].database_info.system_admin_impersonation` | [`Impersonation`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.Impersonation/index.md) | 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. |
| `vaults[].database_info.basic_user_impersonation` | [`Impersonation`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.Impersonation/index.md) | 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. |
| `vaults[].file_data_storage` | [`FileDataStorage`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.FileDataStorage/index.md) | 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[].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 [`VaultVariableArray`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.VaultVariableArray/index.md) | The vault variables of each vault, in the order of `vaults`, for every caller. Not valid for offline vaults. |
| `vault_variables[].value[]` | repeated [`VaultVariable`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.VaultVariable/index.md) | 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`. |