ESET Online Help

Search
Select the category
Select the topic

POST Download quarantined objects

Relative path: /v1/quarantined-objects:download

Download quarantined objects matching criteria in the filter.

The response is ZIP archive of quarantined objects.

Info: modeled after https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/grpc_json_transcoder_filter#sending-arbitrary-content and https://github.com/googleapis/googleapis/blob/master/google/api/httpbody.proto

Request body

Display Schema instead of an Example or vice-versa

Type

Required

Example

Schema

application/json

No

{
  "excludedObjectUuids": [
    "string"
  ],
  "filter": {
    "cloudOfficeTenantUuid": "string",
    "emailInternetMessageId": "string",
    "emailRecipient": "string",
    "emailSender": "string",
    "emailSubject": "string",
    "fileName": "string",
    "msSharepointRootSiteUuid": "string",
    "msTeamsTeamUuid": "string",
    "objectOrigin": "OBJECT_ORIGIN_UNSPECIFIED",
    "objectType": "QUARANTINED_OBJECT_TYPE_UNSPECIFIED",
    "quarantineReason": "QUARANTINE_REASON_UNSPECIFIED",
    "quarantineTime": {
      "startTime": "string",
      "endTime": "string"
    },
    "userUuid": "string"
  }
}
{
  "$ref": "v1DownloadQuarantinedObjectsRequest",
  "excludedObjectUuids": [
    {
      "type": "string"
    }
  ],
  "filter": {
    "$ref": "v1QuarantineFilter",
    "description": "Quarantine filter. Every entry can be seen as a condition. If multiple conditions are filled, they are used in filtering expression with AND operator (i.e. they must be fulfilled simultaneously).",
    "cloudOfficeTenantUuid": {
      "type": "string",
      "description": "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"
    },
    "emailInternetMessageId": {
      "type": "string",
      "description": "If filled, only messages with this Message-ID would be returned. If empty or '', messages with any Message-ID would be returned."
    },
    "emailRecipient": {
      "type": "string",
      "description": "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"
    },
    "emailSender": {
      "type": "string",
      "description": "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"
    },
    "emailSubject": {
      "type": "string",
      "description": "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"
    },
    "fileName": {
      "type": "string",
      "description": "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."
    },
    "msSharepointRootSiteUuid": {
      "type": "string",
      "description": "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"
    },
    "msTeamsTeamUuid": {
      "type": "string",
      "description": "Reference to [Microsoft Teams team]. type: eset.dotnod.quarantine_management.v1-alpha.MicrosoftTeamsTeam"
    },
    "objectOrigin": {
      "$ref": "v1ObjectOrigin",
      "type": "string",
      "description": "Object origin denotes a system managing object's life-cycle. This is necessary to be known for actions that manipulate with object, such as delete, quarantine, move and so on. 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.",
      "default": "OBJECT_ORIGIN_UNSPECIFIED",
      "enum": [
        "OBJECT_ORIGIN_UNSPECIFIED",
        "OBJECT_ORIGIN_MS_OFFICE365",
        "OBJECT_ORIGIN_GOOGLE_WORKSPACE",
        "OBJECT_ORIGIN_DEVICE"
      ]
    },
    "objectType": {
      "$ref": "v1QuarantinedObjectType",
      "type": "string",
      "description": "Possible types of object. 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.",
      "default": "QUARANTINED_OBJECT_TYPE_UNSPECIFIED",
      "enum": [
        "QUARANTINED_OBJECT_TYPE_UNSPECIFIED",
        "QUARANTINED_OBJECT_TYPE_EMAIL_MESSAGE",
        "QUARANTINED_OBJECT_TYPE_EMAIL_ATTACHMENT",
        "QUARANTINED_OBJECT_TYPE_FILE_ON_DRIVE"
      ]
    },
    "quarantineReason": {
      "$ref": "v1QuarantineReason",
      "type": "string",
      "description": "Reasons for object being quarantined. 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).",
      "default": "QUARANTINE_REASON_UNSPECIFIED",
      "enum": [
        "QUARANTINE_REASON_UNSPECIFIED",
        "QUARANTINE_REASON_MALWARE",
        "QUARANTINE_REASON_GRAYWARE",
        "QUARANTINE_REASON_PHISHING",
        "QUARANTINE_REASON_SPAM",
        "QUARANTINE_REASON_SENDER_SPOOFING",
        "QUARANTINE_REASON_RULE"
      ]
    },
    "quarantineTime": {
      "$ref": "typeInterval",
      "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.",
      "startTime": {
        "type": "string",
        "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
        "format": "date-time"
      },
      "endTime": {
        "type": "string",
        "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
        "format": "date-time"
      }
    },
    "userUuid": {
      "type": "string",
      "description": "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.

"string"
{
  "title": "Free form byte stream",
  "type": "string",
  "format": "binary"
}

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
[]