IRPCVaultsAdmin.EncryptFileData
Administration API / specialized admin session
Encrypts the existing files of a vault with the vault's latest encryption key.
| Service | Vault management MFiles.IRPCVaultsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultsAdmin/EncryptFileData |
| HTTP (mf-http-grpc) | POST /grpc/v1/encrypt-file-data |
| Request | EncryptFileDataRequest |
| Response | EncryptFileDataResponse |
| 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
- Starts a background job and returns before it completes; follow it with
task_id(see the service overview). - Requires the system administrator server role (server right
manage_vaults).
Request: EncryptFileDataRequest
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 |
|---|---|---|
encryptfiledatajob | EncryptFileDataJob | The job. Set vault_guid to the GUID of the vault. |
encryptfiledatajob.vault_guid | string | The GUID of the vault. |
Response: EncryptFileDataResponse
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 |
|---|---|---|
task_id | int32 | The ID of the server-level scheduled job that encrypts the files. Pass it to GetScheduledJobRunInfo. |