IRPCObjectOperations.GetFileMalwareInfo
Vault API / core read session or assertion idempotent
Gets the malware scanning verdict of a file, as an advisory hint for a user interface.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetFileMalwareInfo |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-file-malware-info |
| Request | GetFileMalwareInfoRequest |
| Response | GetFileMalwareInfoResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
Used by the M-Files clients to warn before a download. An empty malware_info.description means
the file is clean or no verdict is available, for example when the vault does not scan files.
Request: GetFileMalwareInfoRequest
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 |
|---|---|---|
file | File | The file to check,. Only pwszMasterStorageFileRef is read. |
file.file_ver | FileVer | The file and its version. Pass it unchanged in an ObjFileVer to download the file. |
file.file_ver.file_id | FileID | The file. |
file.file_ver.type | FileVerType | FILE_VER_TYPE_SPECIFIC for a file version number.Values: FILE_VER_TYPE_UNINITIALIZED (0), FILE_VER_TYPE_LATEST (1), FILE_VER_TYPE_ANY (2), FILE_VER_TYPE_SPECIFIC (3). |
file.file_ver.internal_version | int32 | The file version number. |
file.file_ver.external_repository_version | string | Used only for files in external repositories. Leave empty. |
file.file_ver.external_repository_sort_key | int64 | Used only for files in external repositories. Leave 0. |
file.title | string | The file name without the extension. |
file.extension | string | The file name extension without the dot, for example "pdf". |
file.size | int64 | The size of the file in bytes. Exact when size_precision is FILE_SIZE_PRECISION_EXACT. |
file.size_precision | FileSizePrecision | How exact size is. Do not rely on size if it is FILE_SIZE_PRECISION_UNKNOWN.Values: FILE_SIZE_PRECISION_EXACT (0), FILE_SIZE_PRECISION_ESTIMATE (1), FILE_SIZE_PRECISION_UNKNOWN (2). |
file.created_at_utc | google.protobuf.Timestamp | The time in UTC the file was originally created. |
file.accessed_at_utc | google.protobuf.Timestamp | The time in UTC the file was last accessed (e.g. read). |
file.written_at_utc | google.protobuf.Timestamp | The time in UTC the file was last written to. |
file.changed_at_utc | google.protobuf.Timestamp | The time in UTC the file was last written to or its attributes were changed. |
file.guid | string | GUID of the file. |
file.md5_checksum | string | The MD5 checksum of the file as 32 lowercase hexadecimal digits, if available. |
file.is_missing | bool | True, if the file is missing. |
file.is_content_volatile | bool | True, if the file physical content is volatile. I.e. the physical content can change without the version number change, as long as the logical content is same. The file content is guaranteed to stay physically consistent within single download session only. |
file.flags | OBJECTFILEFLAGS | Object file flags. |
file.flags.all | bool | Specifies all flags set; Including any future flags. |
file.flags.can_be_edited_externally | bool | Next available value. |
file.master_storage_file_ref | string | An optional File reference (GUID) to external Master Storage API. Only used with Master Storage, otherwise empty. |
Response: GetFileMalwareInfoResponse
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 |
|---|---|---|
malware_info | FileMalwareInfo | Malware verdict. Empty description = clean / no info available. |
malware_info.description | string | Malware description from Master Storage when the file is flagged. Empty / null means "no warning". |