Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Ransomware Recovery

Get details of a quarantine range - v1

Returns information about a quarantine range on an infected resource using the rangeID. :fa-info-circle: Both v1 and v2 Quarantine APIs are supported for Endpoints, File Server, NAS, VMware, OneDrive, and SharePoint.

get/ransomwarerecovery/v1/quarantineranges/resource/{resourceID}/range/{rangeID}

Path parameters

resourceIDinteger required

The unique ID of the resource on which you seek the quarantine range information. Get the ID of a device using the ‘List all devices’ API. For data sources like File Server, NAS, VMware refer to the respective ‘List all backup sets’ API.

rangeIDstring required

The unique quarantine range ID for which you need the details. Get the quarantine range ID using the 'List all quarantine ranges' API.

Response

OK

resourceIDinteger

The unique identifier of the resource or a device which is quarantined. Example - 101

rangeIDinteger

The unique identifier of the quarantine range for the quarantined resource. Example - 101.

orgIDinteger

The Phoenix organization ID for the resource. For inSync workloads, value will be -1.

resourceNamestring

Name of the quarantined resource. Example - Ernie Carter's Macbook.

resourceParentstring

Name of the device user which is quarantined. Example - Ernie Carter

resourcePlatformstring

The operating system on the quarantined resource. Example - linux

resourceTypestring

The type of resource. A resource can be one of the following types: Endpoint OneDrive SharePoint File Server NAS VMware and so on

workloadstring

The type of workload. A workload can be one of the following types: endpoint oneDrive sharePoint fileserver nas vmware, and so on

fromDatestring date

Lists the start date of the quarantine range. Example - 2020-01-25.

toDatestring date

Lists the end date of the quarantine change. If the administrator has not defined any end date, empty string is returned.

addedTimestring date

The date and time when the quarantine range was created. Format - YYYY-MM-DDTHH:MM:SSZ Example - 2020-01-02T15:04:05Z

dataLockboolean

Resource is data locked or not, if true, cannot delete the quarantined snapshots

Example response

{
  "resourceID": 101,
  "rangeID": 101,
  "orgID": 101,
  "resourceName": "Ernie Carter's Macbook",
  "resourceParent": "Ernie Carter",
  "resourcePlatform": "linux",
  "resourceType": "Endpoint",
  "workload": "endpoints",
  "fromDate": "2020-10-25",
  "toDate": "2020-10-25",
  "addedTime": "2020-01-02T15:04:05Z"
}