Cohesity

Cohesity Restore Tasks API

The RestoreTasks API from Cohesity — 27 operation(s) for restoretasks.

GitHub OpenAPI
Business capability
Disaster Recovery Management BC-160.20

Operations 30

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /public/restore/adDomainRootTopology Get the root topology of an AD domain restore · Gets Root Topology for an AD Domain #
Ask an LLM
“What does the root topology of the Active Directory domain look like in my AD restore task?”
“Can I browse the top of the AD domain tree for a specific restore task before recovering objects?”
Tell an agent
Show the AD domain root topology for restore task {restoreTaskId}.
Fetch the top-level AD domain tree for restore task {restoreTaskId} so I can pick where to browse.
POST /public/restore/adObjectAttributes Compare AD object attributes snapshot vs production · Compares the AD Object from both Snapshot and Production AD and returns the… #
Ask an LLM
“Which attributes of an Active Directory object differ between the backup snapshot and production AD?”
“Can I hide system attributes and identical values when comparing an AD object against its snapshot?”
Tell an agent
Compare the AD objects in {guidPairs} for restore task {RestoreTaskId} between snapshot and production.
Do a quick attribute compare of {guidPairs} in restore task {RestoreTaskId}, showing only values that differ.
GET /public/restore/adObjects Browse AD objects in snapshot and production · Searches for AD Objects in both Production and Snapshot AD from given search… #
Ask an LLM
“Which AD objects under a given base DN are missing from production compared to the snapshot?”
“Can I page through AD objects under an OU and see whether each one is equal, changed or missing in production?”
Tell an agent
List AD objects under {searchBaseDn} for restore task {restoreTaskId} with their production match status.
Show the next {numObjects} AD objects in restore task {restoreTaskId} starting at offset {recordOffset}.
POST /public/restore/adObjects Look up production AD objects by GUID, SAM or DN · Searches for AD Objects that match the list of object guids, sam account names… #
Ask an LLM
“Can I look up live production AD objects by their object GUIDs or SAM account names?”
“What does production Active Directory currently hold for a list of distinguished names?”
Tell an agent
Find production AD objects with SAM account names {samAccountNames}.
Look up the production AD objects matching distinguished names {distinguishedNames}.
GET /public/restore/adObjects/searchResults Search backed-up AD objects to recover · Get ad objects #
Ask an LLM
“Which backed-up Active Directory users or groups can I recover, searching by name or email?”
“Can I filter recoverable AD objects by object type and protection job?”
Tell an agent
Search recoverable AD objects named {name}.
Find the backed-up AD user with email {email} in domain {domain} to recover.
GET /public/restore/adObjects/status Check restore status of recovered AD objects · Ad objects restore status #
Ask an LLM
“Did the AD objects I restored from the snapshot make it back into production?”
“What is the per-object restore status for an Active Directory restore task?”
Tell an agent
Show the AD object restore status for restore task {restoreTaskId}.
Check which AD objects in restore task {restoreTaskId} were restored to production successfully.
POST /public/restore/applicationsClone Clone an application such as a SQL database · Create a Restore Task for cloning Applications like SQL Databases #
Ask an LLM
“Can I clone a backed-up SQL Server database onto a host for test or dev use?”
“What is needed to spin up a clone of a protected application on another host?”
Tell an agent
Create a clone task named {name} for {applicationEnvironment} applications hosted on {hostingProtectionSource}.
Clone the SQL databases {applicationRestoreObjects} onto host {hostingProtectionSource} as task {name}.
POST /public/restore/applicationsRecover Recover an application such as a SQL database · Create a Restore Task for recovering Applications like SQL Databases #
Ask an LLM
“How do I restore a SQL Server database from a Cohesity backup back to its host?”
“Can I recover protected application databases rather than clone them?”
Tell an agent
Start an application recovery task named {name} for {applicationEnvironment} on host {hostingProtectionSource}.
Recover the SQL databases {applicationRestoreObjects} back to {hostingProtectionSource} as task {name}.
POST /public/restore/clone Clone VMs or a View from backup · Create a Restore Task for cloning VMs or a View #
Ask an LLM
“Can I clone backed-up VMs into a new location without overwriting the originals?”
“What does it take to clone a View from a snapshot under a new view name?”
Tell an agent
Create a {type} clone task named {name} for the VMs {objects}.
Clone the view as {targetViewName} in a {type} clone task called {name}.
DELETE /public/restore/clone/{id} Destroy a clone task and its clones · Destroy a clone task with specified id #
Ask an LLM
“How do I tear down cloned VMs or views once I'm done testing with them?”
“Can I destroy a clone task by its id to clean up the cloned resources?”
Tell an agent destructive · confirm first
Destroy clone task {id}.
Clean up the clones created by clone task {id}.
POST /public/restore/deploy Deploy backed-up VMs or a View to cloud · Create a Restore Task for deploying VMs or a View on cloud #
Ask an LLM
“Can I deploy backed-up VMs into AWS or Azure from Cohesity?”
“Which cloud targets can a restore deploy VMs onto?”
Tell an agent
Create a deploy task named {name} to push {objects} to cloud target {target}.
Deploy the backed-up VMs as task {name} into the cloud.
POST /public/restore/downloadFilesAndFolders Create a legacy download task for files and folders · Create a Download Task for downloading files and folders #
Ask an LLM
“Can I download specific files and folders out of a backup instead of restoring them in place?”
“What does the older public restore API need to package backed-up files for download?”
Tell an agent
Create a download task named {name} for files {filesAndFoldersInfo} using the public restore API.
Start the legacy files-and-folders download task {name}.
GET /public/restore/files Search backed-up files and folders to recover · Search for files and folders to recover that match the specified search and… #
Ask an LLM
“Which backed-up files match a filename pattern so I can pick them for recovery?”
“Can I search only folders, or restrict a file search to a time window and protection job?”
Tell an agent
Search backups for files matching {search}.
Find folders only matching {search} backed up by jobs {jobIds}.
POST /public/restore/files Recover files and folders to a host · Create a Restore Task for recovering files and folders #
Ask an LLM
“Can I restore selected files back to the original server or to a different directory?”
“Will a file restore overwrite existing files, and can I preserve their attributes?”
Tell an agent
Restore files {filenames} as task {name}.
Recover files {filenames} into {newBaseDirectory} on host {targetSourceId} without overwriting.
GET /public/restore/files/fstats Get fstat details for a file in a snapshot · Get the fstat information about file provided using query parameters #
Ask an LLM
“What are the size, timestamps and other fstat details of a file inside a backup snapshot?”
“Can I stat one file path in a specific job run before recovering it?”
Tell an agent
Get fstat info for {filePath} in job {jobId} run {jobInstanceId} started {jobStartTimeUsecs}, entity {entityId}, job uid object {jobUidObjectId}.
Stat file {filePath} from entity {entityId} in backup job {jobId}.
GET /public/restore/files/snapshotsInformation List snapshots that contain a file · Get the information about snapshots that contain the specified file or folder. #
Ask an LLM
“Which backup snapshots contain a particular file or folder?”
“Can I see every version of a file across snapshots so I pick the right one to restore?”
Tell an agent
List snapshots of job {jobId} that contain {filename} from source {sourceId} on cluster {clusterId} incarnation {clusterIncarnationId}.
Show which snapshots hold {filename} for source {sourceId}.
GET /public/restore/objects Search backed-up objects such as VMs to recover · Find backup objects that match the specified search and filter criteria on the… #
Ask an LLM
“Which protected VMs or servers have backups I can recover from?”
“Can I filter recoverable backup objects by environment, operating system or application?”
Tell an agent
Find backed-up objects matching {search}.
List recoverable objects in environments {environments} protected by jobs {jobIds}.
GET /public/restore/office365/onedrive/documents Search backed-up OneDrive files to recover · Returns the OneDrive files and folders #
Ask an LLM
“Which OneDrive files and folders from Office 365 backups can I recover?”
“Can I search OneDrive backups by document name for a specific mailbox?”
Tell an agent
Search OneDrive backups for documents named {documentName}.
List recoverable OneDrive files for users {mailboxIds}.
GET /public/restore/office365/outlook/emails Search backed-up Outlook emails to recover · Returns the Outlook emails and folders containing emails #
Ask an LLM
“Can I find a deleted Outlook email in the backups by sender or subject?”
“Which backed-up emails with attachments arrived in a given date range?”
Tell an agent
Search backed-up Outlook emails from {senderAddress} with subject {emailSubject}.
Find backed-up emails in folder {folderName} for mailboxes {mailboxIds}.
GET /public/restore/office365/sharepoint/documents Search backed-up SharePoint files to recover · Returns the Sharepoint Site's files and folders #
Ask an LLM
“Which SharePoint site files and folders are in my Office 365 backups?”
“Can I search SharePoint backups for a document by name on specific sites?”
Tell an agent
Search SharePoint backups for documents named {documentName}.
List recoverable SharePoint files on sites {siteIds}.
POST /public/restore/pointsForTimeRange List restore points in a time range · List Restore Points in a give time range #
Ask an LLM
“Which restore points exist for a protection job between two dates?”
“Can I see the snapshots available to restore from within a specific time window?”
Tell an agent
List restore points for jobs {jobUids} between {startTimeUsecs} and {endTimeUsecs}.
Show the snapshots for jobs {jobUids} on source {protectionSourceId}.
PUT /public/restore/recover Update a restore task for Hot-Standby · Update restore task #
Ask an LLM
“Can I turn on auto sync for an existing restore task to keep a Hot-Standby copy current?”
“What extra SQL or AD options can be added to a restore task after it was created?”
Tell an agent
Enable auto sync on restore task {restoreTaskId}.
Update the SQL options of restore task {restoreTaskId} to {sqlOptions}.
POST /public/restore/recover Recover VMs or instantly mount volumes · Create a Restore Task for recovering VMs or instantly mounting volumes #
Ask an LLM
“How do I recover VMs from backup to their original location or a new one?”
“Can I instantly mount volumes from a snapshot instead of doing a full restore?”
Tell an agent
Create a {type} recover task named {name} for VMs {objects}.
Start recover task {name} of type {type} to mount volumes with {mountParameters}.
GET /public/restore/tasks List restore tasks · List the Restore Tasks filtered by the specified parameters #
Ask an LLM
“Which restore tasks are running or finished on my cluster?”
“Can I filter restore tasks by type, environment or a start and end time?”
Tell an agent
List restore tasks of types {taskTypes}.
Show restore tasks started between {startTimeUsecs} and {endTimeUsecs}.
PUT /public/restore/tasks/cancel/{id} Cancel a running recover or clone task · Cancel a recover or clone task with specified id #
Ask an LLM
“Can I stop a recover or clone task that is still in progress?”
“What happens if I cancel a restore task midway?”
Tell an agent destructive · confirm first
Cancel restore task {id}.
Stop the in-progress clone task {id}.
GET /public/restore/tasks/{id} Get details of one restore task · List details about a single Restore Task #
Ask an LLM
“What is the current status and progress of a specific restore task?”
“Can I pull the full details of one restore task by its id?”
Tell an agent
Show details for restore task {id}.
Check the progress of restore task {id}.
GET /public/restore/virtualDiskInformation Get virtual disk details from a backup run · Fetches information of virtual disk #
Ask an LLM
“What virtual disks were captured for a VM in a particular backup run?”
“Can I read virtual disk information from an archived snapshot in a vault?”
Tell an agent
Get virtual disk info for source {sourceId} in job {jobId} run {jobRunId} started {startTimeUsecs} on cluster {clusterId} incarnation {clusterIncarnationId}.
Show the virtual disks backed up for VM {sourceId} in run {jobRunId}.
GET /public/restore/vms/directoryList Browse a directory inside a VM backup · Get the directory list based on the given directory name and other query… #
Ask an LLM
“Can I browse the folders inside a backed-up VM to find files to restore?”
“What files are in a given directory of a VM snapshot, with their stat details?”
Tell an agent
List directory {dirPath} in VM {entityId} for job {jobId} run {jobInstanceId} started {jobStartTimeUsecs}, job uid object {jobUidObjectId}.
Browse {dirPath} on volume {volumeName} of a backed-up VM.
GET /public/restore/vms/volumesInformation List logical volumes in a backed-up VM · Get information about the logical volumes found in a VM #
Ask an LLM
“Which logical volumes were found in a VM's backup snapshot?”
“Can I see only the supported volumes of a VM before mounting one?”
Tell an agent
Get volumes of VM {sourceId}, job {jobId}/{originalJobId}, run {jobRunId} at {startedTimeUsecs}, cluster {clusterId}:{clusterIncarnationId}.
Show the supported volumes of VM {sourceId} in backup run {jobRunId}.
GET /public/virtualDatacenters/{id}/storageProfiles List storage profiles of a virtual datacenter · Fetches information of virtual disk #
Ask an LLM
“Which storage profiles are available in a vCloud virtual datacenter for restores?”
“What storage policy options does a given virtual datacenter offer?”
Tell an agent
List storage profiles for virtual datacenter {id}.
Show the storage profiles I can restore into on virtual datacenter {id}.

Documentation

📖
Documentation
https://developer.cohesity.com/helios-api.html
📖
GettingStarted
https://developer.cohesity.com/docs/helios-getting-started
📖
APIReference
https://developer.cohesity.com/apidocs/versions/
📖
Documentation
https://developer.cohesity.com/apidocs/versions/
📖
APIReference
https://developers.cohesity.com/page/api-reference
📖
GettingStarted
https://developers.cohesity.com/docs/getting-started
📖
Documentation
https://developer.cohesity.com/apidocs/helios-reporting
📖
Documentation
https://developer.cohesity.com/apidocs/site-continuity

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-restoretasks-api-openapi.yml

Other Resources

🔗
Postman
https://api.cohesity.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cohesity:cohesity-restoretasks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cohesity-restoretasks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'This API list provides operations for interfacing with the Cohesity

    Cluster.'
  title: Cohesity REST Restore Tasks API
  version: '1.0'
servers:
- url: https://<CLUSTER_VIP>/irisservices/api/v1
tags:


# --- truncated at 32 KB (589 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-restoretasks-api-openapi.yml