quarantine_quarantined_objects__list_quarantined_objects
List quarantined email messages, attachments, and drive files by reason, sender, user, tenant, origin, or quarantine time to review blocked items and support security investigations.
Instructions
List quarantined objects - (GET /v1/quarantined-objects) - List all quarantined objects matching the criteria in the filter.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Optional server-side projection: return only these keys for each list-item in the response. Reduces token usage on large list endpoints. Example: ['uuid','displayName']. Top-level fields (e.g. nextPageToken) are always preserved. Not forwarded to ESET - applied locally after fetch. | |
| orderBy | No | Comma-separated list of fields (from the request resource). Allowed formats are: - [snake_case version of the field name](https://developers.google.com/protocol-buffers/docs/style#message_and_field_names) as used by protocol buffers. - [JSON version of the field name](https://protobuf.dev/programming-guides/proto3/#json) The syntax is described at [Standard Methods: List Ordering](https://google.aip.dev/132#ordering) | |
| pageSize | No | Limit for pagination purposes. If unspecified or 0, the default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000. > **Info:** > For more information, refer to [Paginating Requests in APIs](https://medium.com/@ignaciochiazzo/paginating-requests-in-apis-d4883d4c1c4c) > > or [Design Patterns: Pagination](https://google.aip.dev/158) | |
| pageToken | No | Page token of the current page. If not given or "", the first page is returned. > **Info:** > For more information, refer to [Paginating Requests in APIs](https://medium.com/@ignaciochiazzo/paginating-requests-in-apis-d4883d4c1c4c) > > or [Design Patterns: Pagination](https://google.aip.dev/158) | |
| filter.fileName | No | If given, only quarantined files with the path terminated with this string are returned. If empty or "", all files are returned. | |
| filter.userUuid | No | This is a reference to the user associated with the quarantined object through ownership of its storage. If filled for a file, only the files on a cloud drive owned by the given user are included in the response. If filled for mail, only the files in a mailbox owned by the given user are included in the response. If null or empty, quarantined objects associated with any user and accessible to the caller will be included in the response. type: user_management.v1.User | |
| filter.objectType | No | Type of quarantined object to be returned in the response. If 0 or empty, all types of quarantined objects are returned. - QUARANTINED_OBJECT_TYPE_UNSPECIFIED: fallback - QUARANTINED_OBJECT_TYPE_EMAIL_MESSAGE: The object is an email message. - QUARANTINED_OBJECT_TYPE_EMAIL_ATTACHMENT: The object is an email attachment. - QUARANTINED_OBJECT_TYPE_FILE_ON_DRIVE: The object is a file on the drive. | QUARANTINED_OBJECT_TYPE_UNSPECIFIED |
| filter.emailSender | No | If given, only emails from the given email address are returned. If empty or "", emails from all the senders are included in the response. 0 - 100 characters | |
| filter.emailSubject | No | If given, only emails whose subject contains this string are returned. If empty or "", emails with any subject are included in the response. 0 - 100 characters | |
| filter.objectOrigin | No | Origin of the quarantined object. If filled, only objects with the given origin are returned. Objects with any origin are returned otherwise. - OBJECT_ORIGIN_UNSPECIFIED: fallback - OBJECT_ORIGIN_MS_OFFICE365: Object originates in Microsoft Office 365. - OBJECT_ORIGIN_GOOGLE_WORKSPACE: Object originates in Google Workspace. - OBJECT_ORIGIN_DEVICE: Object originates from a device. | OBJECT_ORIGIN_UNSPECIFIED |
| filter.emailRecipient | No | If given, only emails with the given email address in recipients are returned. If empty or "", emails for all the recipients are included in the response. 0 - 100 characters | |
| filter.msTeamsTeamUuid | No | Reference to [Microsoft Teams team]. type: eset.dotnod.quarantine_management.v1-alpha.MicrosoftTeamsTeam | |
| filter.quarantineReason | No | If given, only objects quarantined for this reason are returned. If 0 or empty, objects quarantined for all possible reasons are returned. - QUARANTINE_REASON_UNSPECIFIED: fallback - QUARANTINE_REASON_MALWARE: The object was identified as malware or as containing malware. - QUARANTINE_REASON_GRAYWARE: The object was identified as grayware or as containing grayware. Grayware refers to potentially unwanted programs or files that, while not explicitly malicious, can negatively impact system performance or user experience. - QUARANTINE_REASON_PHISHING: The object (mostly email) was identified as phishing. - QUARANTINE_REASON_SPAM: The object (mostly email) was identified as unsolicited or spam. - QUARANTINE_REASON_SENDER_SPOOFING: The email's sender was identified as spoofed. - QUARANTINE_REASON_RULE: The object was quarantined by a rule (for example, `mail transfer protection rule`). | QUARANTINE_REASON_UNSPECIFIED |
| filter.cloudOfficeTenantUuid | No | Reference to [cloud office tenant]. If filled, only objects of the referred tenant are returned. If empty or null, objects of any tenant are returned. type: cloud_office_protection.v1.CloudOfficeTenant | |
| filter.emailInternetMessageId | No | If filled, only messages with this Message-ID are returned. If empty or "", messages with any Message-ID are returned. | |
| filter.quarantineTime.endTime | No | Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. | |
| filter.msSharepointRootSiteUuid | No | Reference to [Microsoft Sharepoint root site]. If filled, only objects belonging to the given site or its child sites are returned. If empty or "", objects of all sites are returned. type: eset.dotnod.quarantine_management.v1-alpha.MicrosoftSharepointSite | |
| filter.quarantineTime.startTime | No | Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. |