# IRPCVaultsAdmin.TakeVaultOffline

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](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdmin/index.md)

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

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

Takes a vault offline: users cannot log in to it until it is brought online again.

- **Service:** [Vault management](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdmin/index.md) `MFiles.IRPCVaultsAdmin`
- **gRPC method:** `/MFiles.IRPCVaultsAdmin/TakeVaultOffline`
- **HTTP (mf-http-grpc):** `POST /grpc/v1/take-vault-offline`
- **Request:** [`TakeVaultOfflineRequest`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdmin/TakeVaultOffline/index.md#request)
- **Response:** [`TakeVaultOfflineResponse`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdmin/TakeVaultOffline/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

- Requires the system administrator server role (server right `manage_vaults`).
- With `disconnect_users` false, the call fails if the vault has open sessions, with the same
  error as [CheckForOpenSessions](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdmin/CheckForOpenSessions/index.md). With
  `disconnect_users` true, open sessions are terminated.
- Bring the vault back with [BringVaultOnline](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdmin/BringVaultOnline/index.md).

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

## Request: TakeVaultOfflineRequest

> 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` | `string` | The GUID of the vault. |
| `disconnect_users` | `bool` | If true, any existing sessions are terminated. If false, the operation fails if there are open sessions. |

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

## Response: TakeVaultOfflineResponse

No fields.

<a id="related"></a>

## Related methods

- [CheckForOpenSessions](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdmin/CheckForOpenSessions/index.md): Checks whether users have open sessions to a vault: succeeds if there are none and fails with a list of the sessions otherwise.
- [BringVaultOnline](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultsAdmin/BringVaultOnline/index.md): Brings an offline vault online so that users can log in to it again.