ESET Online Help

Search
Select the category
Select the topic

GET Get quarantined objects count

Relative path: /v1/quarantined-objects/count

Get count of quarantined objects matching criteria.

Query parameters

Name

Type

Description

filter.cloudOfficeTenantUuid

string

Reference to [cloud office tenant].

If filled, only objects of referred tenant are returned. If empty or null, objects of any tenant are returned.

type: cloud_office_protection.v1.CloudOfficeTenant

filter.emailInternetMessageId

string

If filled, only messages with this Message-ID would be returned.

If empty or "", messages with any Message-ID would be returned.

filter.emailRecipient

string

If given, only emails with given email address in recipients would be returned.

If empty or "", emails for all the recipients would be included in the response.

0..100 characters

filter.emailSender

string

If given, only emails from given email address would be returned.

If empty or "", all the senders would be included in the response.

0..100 characters

filter.emailSubject

string

If given, only emails subject containing this string would be returned.

If empty or "", emails with any subject would be included in the response.

0..100 characters

filter.fileName

string

If given, only quarantined files with path terminated with this string would be returned.

If empty or "", files of all the names would be returned.

filter.msSharepointRootSiteUuid

string

Reference to [Microsoft Sharepoint root site].

If filled, only objects belonging to given site or its child-sites are returned. If empty or "", objects of all the sites are returned.

type: eset.dotnod.quarantine_management.v1-alpha.MicrosoftSharepointSite

filter.msTeamsTeamUuid

string

Reference to [Microsoft Teams team].

type: eset.dotnod.quarantine_management.v1-alpha.MicrosoftTeamsTeam

filter.objectOrigin

string

Origin of the quarantined object.

If filled, only objects with 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.

filter.objectType

string

Type of quarantined object to be returned in the response.

If 0 or empty, all the types would be returned.

  • QUARANTINED_OBJECT_TYPE_UNSPECIFIED: fallback
  • QUARANTINED_OBJECT_TYPE_EMAIL_MESSAGE: Object is email message.
  • QUARANTINED_OBJECT_TYPE_EMAIL_ATTACHMENT: Object is email attachment.
  • QUARANTINED_OBJECT_TYPE_FILE_ON_DRIVE: Object is a file on drive.

filter.quarantineReason

string

If given, only objects quarantined for this reason would be returned.

If 0 or empty, all the reasons would be returned.

  • QUARANTINE_REASON_UNSPECIFIED: fallback
  • QUARANTINE_REASON_MALWARE: 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: Object (mostly email) was identified as phishing.
  • QUARANTINE_REASON_SPAM: Object (mostly email) was identified as unsolicited or spam.
  • QUARANTINE_REASON_SENDER_SPOOFING: Email's sender was identified as spoofed.
  • QUARANTINE_REASON_RULE: Object was quarantined by a rule (e.g. mail transfer protection rule).

filter.quarantineTime.startTime

string

Optional. Inclusive start of the interval.

If specified, a Timestamp matching this interval will have to be the same or after the start.

filter.quarantineTime.endTime

string

Optional. Exclusive end of the interval.

If specified, a Timestamp matching this interval will have to be before the end.

filter.userUuid

string

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 a 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

Responses

Display Schema instead of an Example or vice-versa

Code

Description

Example

Schema

200

Successful response.

 
{
  "objectCount": 0
}
 
{
  "$ref": "v1GetQuarantinedObjectsCountResponse",
  "objectCount": {
    "type": "integer",
    "description": "Count of quarantined objects matching criteria in the filter.",
    "format": "int64"
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

 
null
 
[]

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

 
null
 
[]

401

Token has expired or is invalid.

 
null
 
[]

403

Access denied. Check permissions.

 
null
 
[]

404

Requested resource not found.

 
null
 
[]

429

Rate limit reached. Try again later.

 
null
 
[]

500

Internal server failure. Try again later.

 
null
 
[]

502

Internal server failure. Try again later.

 
null
 
[]

503

Environment under maintenance. Try again later.

 
null
 
[]

504

Action took too long; timeout reached

 
null
 
[]