Create a search of a remote Vault. (CloudRetrieve)

post

https://cluster.ip.address/irisservices/api/v1/public/remoteVaults/searchJobs

Privileges: REMOTE_RESTORE

A search Job finds Protection Jobs that archived data to a
Vault (External Target) which also match the specified search criteria.
The results can be optionally filtered by specifying a Cluster match string,
a Protection Job match string, a start time and an end time.
This is part of the CloudRetrieve functionality for finding and restoring
archived data from remote Vaults to an alternative (non-original) Cluster.

NOTE: A Vault is equivalent to an External Target in the Cohesity Dashboard.
A search Job is equivalent to a search task in the Cohesity Dashboard.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a search of a remote Vault.

Specifies settings required to create a search of a
remote Vault for data that has been archived from other Clusters.

JobUids

array of strings | null

Filter by specifying a list of remote job uids in form of
clusterId:clusterIncarnationId:jobId.

JobUids

clusterId

int64 | null

Filter by specifying a Cluster id.

clusterMatchString

string | null

Filter by specifying a Cluster name prefix string.
Only Clusters with names that start with this prefix string are returned
in the search result.
If not set, all Clusters archiving data to the Vault
are returned in the search results.

encryptionKeys

array of objects | null

Array of Encryption Keys.

Specifies an optional list of encryption keys that may be needed to
search and restore data that was archived to a remote Vault.
Archived data cannot be searched or restored without the
corresponding encryption key used by the original Cluster
to archive the data.
Encryption keys can be uploaded using the REST API
public/remoteVaults/encryptionKeys operation.
If the key is already uploaded, this field does not need to be
specified.

encryptionKeys

endTimeUsecs

int64 | null

Filter by a end time specified as a Unix epoch Timestamp
(in microseconds). Only Job Runs that completed before the specified
end time are included in the search results.

jobMatchString

string | null

Filter by specifying a Protection Job name prefix string.
Only Protection Jobs with names that start with this prefix string
are returned in the search result.
If not set, all Protection Jobs archiving data to the Vault
are returned in the search results.

searchJobName

string | null

required

Specifies the search Job name.

startTimeUsecs

int64 | null

Filter by a start time specified as a Unix epoch Timestamp
(in microseconds). Only Job Runs that started after the specified
time are included in the search results.

vaultId

int64 | null

required

Specifies the id of the Vault to search. This id was assigned by the
local Cohesity Cluster when Vault was registered as an External Target.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success

defaultError