Cohesity Protection Sources API
The ProtectionSources API from Cohesity — 26 operation(s) for protectionsources.
Operations 32
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/physicalAgents/download
Download the backup agent installer for a host · Download the physical agent for a host type
#
Ask an LLM
“Where can I get the Cohesity agent installer for a Linux or Windows server?”
“Can I download the agent as an RPM or DEB package for Linux hosts?”
Tell an agent
Download the physical agent installer for host type {hostType}.
Download the {hostType} agent as a {pkgType} package.
POST
/public/physicalAgents/upgrade
Upgrade agents on physical servers · Initiate a request to upgrade Cohesity agents on one or more Physical Servers…
#
Ask an LLM
“After upgrading the cluster, how do I bring the agents on my physical servers up to the same release?”
“Can I push an agent upgrade to several physical hosts at once?”
Tell an agent
Upgrade the Cohesity agents with ids {agentIds} to the cluster's current agent release.
Upgrade the agents on my registered physical servers.
GET
/public/protectionSources
Browse registered sources and their object trees · Returns the registered Protection Sources and their Object subtrees
#
Ask an LLM
“How can I see every registered source along with the VMs, folders and databases underneath it?”
“Can I filter the source hierarchy to just VMware or just Office 365 environments?”
Tell an agent
Show the object subtree for protection source {id}.
Browse the source hierarchy for {environments} environments only.
GET
/public/protectionSources/applicationServers
List application servers registered under a source · Returns the registered Application Servers and their Object subtrees
#
Ask an LLM
“Which SQL or Exchange application servers are registered under my vCenter source?”
“Can I list only the hosts running SQL Server within one source tree?”
Tell an agent
List application servers under source tree root {protectionSourcesRootNodeId}.
Show the {application} application servers registered under root {protectionSourcesRootNodeId}.
PUT
/public/protectionSources/applicationServers
Change application server registration settings · Modifies the registration parameters of Application Servers in a Protection…
#
Ask an LLM
“How do I change the credentials Cohesity uses for an already registered SQL host?”
“Can I mark an existing application server registration as using a persistent agent?”
Tell an agent
Update the application server registration on source {protectionSourceId} to use username {username}.
Change the registered applications on source {protectionSourceId} to {applications}.
POST
/public/protectionSources/applicationServers
Register a host as running SQL or Exchange · Register a Protection Source as running one or more Application Servers like…
#
Ask an LLM
“How do I tell Cohesity that a protected host is running Microsoft SQL Server so it can back up the databases?”
“Can I register Exchange as an application on a physical server that is already a source?”
Tell an agent
Register source {protectionSourceId} as running {applications} application servers.
Register SQL on source {protectionSourceId} with username {username} and a persistent agent.
DELETE
/public/protectionSources/applicationServers/{id}
Unregister application servers from a source · Unregister Application Servers like Microsoft SQL servers or Microsoft Exchange…
#
Ask an LLM
“Why would unregistering the SQL application on a host fail while a backup is running?”
“Can I remove just the Exchange application from a source but keep the source itself registered?”
Tell an agent destructive · confirm first
Unregister the application servers on protection source {id}.
Remove the {applications} application registration from source {id}.
GET
/public/protectionSources/datastores
Show datastores used by a VMware VM · Returns the datastore information in VMware environment
#
Ask an LLM
“Which VMware datastores does a particular virtual machine live on?”
“Can I look up datastore details for one VM in my vCenter?”
Tell an agent
Show datastore information for VMware VM {sourceId}.
List the datastores backing virtual machine {sourceId}.
POST
/public/protectionSources/diagnostics/{id}
Collect agent diagnostics from a source host · Collect diagnostics of the protection source for a host type
#
Ask an LLM
“How can I gather a diagnostics tarball from the agent on a Linux or Windows host for support?”
“Does collecting diagnostics upload the bundle back to the cluster?”
Tell an agent
Collect agent diagnostics from protection source {id}.
Run the diagnostics script on host {id} and upload the tarball to the cluster.
GET
/public/protectionSources/downloadCftFile
Download a CloudFormation template · Download the CFT
#
Ask an LLM
“Where do I get the CloudFormation template the cluster provides for AWS setup?”
“Can I download a CFT from a specific path on the cluster?”
Tell an agent
Download the CloudFormation template named {fileName}.
Download CFT file {fileName} from path {filePath}.
GET
/public/protectionSources/exchangeDagHosts
List hosts in an Exchange DAG · List exchange dag hosts
#
Ask an LLM
“Which Exchange servers belong to my Database Availability Group?”
“Can I look up DAG members by giving the endpoint of one host in the group?”
Tell an agent
List the Exchange hosts in the DAG registered as source {protectionSourceId}.
Show all members of the Exchange DAG reachable at {endpoint}.
GET
/public/protectionSources/objects
Look up several source objects by id · List details about Protection Source objects
#
Ask an LLM
“Can I fetch details for a batch of protection source objects in one call?”
“What does the cluster know about a handful of object ids I have from a report?”
Tell an agent
Get details for protection source objects {objectIds}.
List details about the protection source objects I specify.
GET
/public/protectionSources/objects/{id}
Get one protection source object · Get details about a single Protection Source Object
#
Ask an LLM
“How do I see the details of a single VM or database object known to the cluster?”
“What attributes does one protection source object carry?”
Tell an agent
Get protection source object {id}.
Show me the details of source object {id}.
GET
/public/protectionSources/protectedObjects
List protected objects in a registered source · Returns the list of protected Objects in a registered Protection Source
#
Ask an LLM
“Which VMs in my vCenter are actually protected by a backup job right now?”
“Can I include objects covered by RPO policies when listing what's protected in a source?”
Tell an agent
List protected objects in {environment} source {id}.
Show what is protected in source {id} of type {environment}, including RPO-protected objects.
POST
/public/protectionSources/refresh/{id}
Refresh a source's inventory · Refresh the Object hierarchy of the Protection Sources tree
#
Ask an LLM
“I just added a VM in vCenter; how do I make the cluster see it immediately?”
“Can I force a re-sync of the object hierarchy for one registered source?”
Tell an agent
Refresh the inventory of protection source {id}.
Force an immediate re-sync of the source tree rooted at {id}.
POST
/public/protectionSources/register
Register a source via the v1 public endpoint · Register a Protection Source
#
Ask an LLM
“How do I register a vCenter or physical server with the older public v1 register endpoint?”
“Can I set a throttling policy and source-side dedup when registering a source the v1 way?”
Tell an agent
Register a {environment} source at {endpoint} through the v1 public register endpoint.
Register physical host {endpoint} with the v1 endpoint, forcing registration even if another cluster owns its agent.
GET
/public/protectionSources/registrationInfo
Show registration and protection info for sources · List protection sources registration info
#
Ask an LLM
“How much of each registered source is protected, and when was it registered?”
“Can I get registration info including the applications tree for my SQL hosts?”
Tell an agent
Show registration and protection info for registered sources {ids}.
Get registration info for {environments} sources, including the applications tree.
GET
/public/protectionSources/rootNodes
List top-level registered sources · Returns the top level (root) Protection Sources with registration information
#
Ask an LLM
“What top-level sources like vCenters and NAS arrays are registered on the cluster?”
“Can I list only the root sources of one environment type?”
Tell an agent
List the root protection sources for {environments}.
Show registration information for root source {id}.
GET
/public/protectionSources/sqlAagHostsAndDatabases
List SQL Always On groups and databases · Returns the registered Protection Sources and their Object subtrees
#
Ask an LLM
“Which Always On Availability Groups and databases are found on my registered SQL servers?”
“Can I see AAG membership for several SQL sources at once?”
Tell an agent
List the AAGs and their databases for SQL sources {sqlProtectionSourceIds}.
Show Always On databases on SQL servers {sqlProtectionSourceIds}.
GET
/public/protectionSources/virtualMachines
List VMs across registered vCenters · Returns the Virtual Machines in a vCenter Server
#
Ask an LLM
“Which virtual machines in my vCenter are not yet protected by any job?”
“Can I find a VM by its exact name or UUID across all registered vCenter servers?”
Tell an agent
List the VMs in vCenter {vCenterId}.
Find the virtual machine named {names}.
DELETE
/public/protectionSources/{id}
Unregister a source via the v1 endpoint · Unregister a previously registered Protection Source
#
Ask an LLM
“What happens if I unregister a vCenter source from the cluster with the v1 public endpoint?”
“Can I remove a physical server I no longer back up from the v1 source list?”
Tell an agent destructive · confirm first
Unregister protection source {id} using the v1 public endpoint.
Remove source {id} from the cluster's v1 registered sources.
PATCH
/public/protectionSources/{id}
Update a registered source's settings · Update a previously registered Protection Source with new details
#
Ask an LLM
“How do I change the password stored for a registered source?”
“Can I set a minimum free space threshold that cancels backups when a source runs low?”
Tell an agent
Update source {id} to use username {username} and a new password.
Set the minimum free space on source {id} to {minimumFreeSpaceGB} GB.
Ask an LLM
“What protection sources do I have under the v2 data-protect API?”
“Can I include sources owned by all tenants when listing sources?”
Tell an agent
List protection sources for tenants {tenantIds}.
List all sources with credentials encrypted using key {encryptionKey}.
GET
/data-protect/sources/filters
List attribute filters for a source · List attribute filters for a source
#
Ask an LLM
“What attributes can I filter leaf objects on within a given source?”
“Can I see the available attribute filters for VMs under one parent source?”
Tell an agent
List attribute filters for source {sourceUuid}.
Show the {environment} attribute filters available under source {sourceUuid}.
GET
/data-protect/sources/registrations
List source registrations · Get the list of Protection Source registrations
#
Ask an LLM
“Which source registrations exist on the cluster in the v2 API?”
“Can I filter source registrations to a specific set of registration ids?”
Tell an agent
List source registrations {ids}.
Show source registrations for tenants {tenantIds}.
POST
/data-protect/sources/registrations
Register a source via the v2 registrations API · Register a Protection Source
#
Ask an LLM
“How do I register a new source using the v2 data-protect registrations endpoint?”
“Can a v2 source registration go through a specific connection when the source is behind a connector?”
Tell an agent
Register a new {environment} source through the v2 registrations API.
Register a {environment} source reachable through connection {connectionId}.
GET
/data-protect/sources/registrations/{id}
Get a source registration · Get a Protection Source registration
#
Ask an LLM
“How do I look up one source registration and its settings?”
“What details are stored on a specific v2 source registration?”
Tell an agent
Get source registration {id}.
Show me the details of registration {id}.
PUT
/data-protect/sources/registrations/{id}
Update a source registration · Update Protection Source registration
#
Ask an LLM
“Can I change which connection a v2 source registration uses?”
“How would I re-encrypt the stored credentials on an existing registration?”
Tell an agent
Update source registration {id} for environment {environment}.
Point registration {id} at connection {connectionId}.
DELETE
/data-protect/sources/registrations/{id}
Delete a source registration · Delete Protection Source Registration
#
Ask an LLM
“How do I delete a v2 source registration I no longer need?”
“Is deleting a source registration permanent?”
Tell an agent destructive · confirm first
Delete source registration {id}.
Remove the v2 registration {id} from the cluster.
POST
/data-protect/sources/test-connection
Test connectivity to a source before registering · Test connection to a source
#
Ask an LLM
“Can I check that the cluster can reach my SQL or Cassandra source before registering it?”
“How would I verify HDFS or Hive connection parameters work?”
Tell an agent
Test the connection to a {environment} source.
Test connectivity to a {environment} source using parameters {mssqlConnectionParams}.
GET
/data-protect/sources/virtual-datacenter/{id}
Get VMware virtual datacenter details · Get VDC Details
#
Ask an LLM
“What catalogs and org networks are associated with a VMware virtual datacenter?”
“Can I inspect a VDC's details before restoring into it?”
Tell an agent
Get details for virtual datacenter {id}.
Show the catalogs and org networks of VDC {id}.
Ask an LLM
“How do I fetch one protection source by id in the v2 API?”
“What does the v2 API return for a single source?”
Tell an agent
Get protection source {id} from the v2 sources API.
Show source {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