Getting StartedAPI ReferenceRecipesGitHub
API Reference

Returns the registered Protection Sources and their Object subtrees.

get
https://cluster.ip.address/irisservices/api/v1/public/protectionSources

Privileges: PROTECTION_VIEW

If no parameters are specified, all Protection Sources that are registered
on the Cohesity Cluster are returned.
In addition, an Object subtree gathered from each Source is returned.
For example, the Cohesity Cluster interrogates a Source VMware vCenter Server
and creates an hierarchical Object subtree that mirrors the
Inventory tree on vCenter Server.
The contents of the Object tree are returned as a "nodes" hierarchy
of "protectionSource"s.
Specifying parameters can alter the results that are returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
excludeOffice365Types
array of strings

Specifies the Object types to be filtered out for Office 365 that match
the passed in types such as 'kDomain', 'kOutlook', 'kMailbox', etc.
For example, set this parameter to 'kMailbox' to exclude Mailbox Objects
from being returned.

excludeOffice365Types
boolean

Specifies whether to get the list of the channels for a given M365 Teams
object.
This should be set to true only when a single Id belonging to M365 Teams
object is provided in the query params.

boolean

Specifies whether to prune membershipInfo while fetching security groups.
IsSecurityGroup should be true for pruning.

boolean

Specifies whether to get the list of members for a given M365 Security
Group object.
This should be set to true only when a single Id belonging to M365 Security
Group object is provided in the query params.

int64

Specifies the entity id starting from which the items are to be returned.

int64

Specifies the entity id upto which the items are to be returned.

int64

Specifies the entity id for the Node at any level within the Source entity
hierarchy whose children are to be paginated.

int64

Specifies the maximum number of entities to be returned within the page.

string

Specifies the values after which the items are to be returned.
This works on fields on which the results are sorted.
Unlike the pagination cursor this works on values and
supports sort and forward pagination only.

boolean

If set to true, users with valid mailbox will be returned.

boolean

If set to true, users with valid onedrive will be returned.

boolean

If set to true, Groups which are security enabled will be returned.

boolean

If set to true, sites tagged to a Group or Team will be returned.

boolean

If set to true, Groups tagged to a Team will be returned.

departmentList
array of strings

Specifies the list of departments to which an Office365 user may belong.
Used to filter Office365 entities by department.

departmentList
titleList
array of strings

Specifies the list of titles/designations applicable to Office365 users.
Used to filter Office365 entities by title.

titleList
countryList
array of strings

Specifies the list of countries to which Office365 users belong.
Used to filter Office365 entities by country.

countryList
int64

Return the Object subtree for the passed in Protection Source id.

string

Specifies the name to filter Protection Sources.
User can specify a wildcard character '*' as a suffix to a string
where all Protection Source names are matched with the prefix string.

int32

Specifies the expected number of levels from the root node to be returned
in the entity hierarchy response.

excludeTypes
array of strings

Filter out the Object types (and their subtrees) that match the passed
in types such as 'kVCenter', 'kFolder', 'kDatacenter',
'kComputeResource', 'kResourcePool', 'kDatastore', 'kHostSystem',
'kVirtualMachine', etc.
For example, set this parameter to 'kResourcePool' to
exclude Resource Pool Objects from being returned.

excludeTypes
excludeAwsTypes
array of strings

Specifies the Object types to be filtered out for AWS that match the
passed in types such as 'kEC2Instance', 'kRDSInstance', 'kAuroraCluster',
'kTag', 'kAuroraTag', 'kRDSTag', kS3Bucket, kS3Tag.
For example, set this parameter to 'kEC2Instance' to exclude ec2 instance
from being returned.

excludeAwsTypes
excludeGoogleWorkspaceTypes
array of strings

Specifies the Object types to be filtered out for Google Workspace that match the
passed in types such as 'kGmail', 'kGoogleDrive', 'kSharedDrive'.
For example, set this parameter to 'kGoogleDrive' to exclude Google drives
from being returned.

excludeGoogleWorkspaceTypes
Allowed:
boolean

If set to true, child entities (member users and their mailboxes/drives)
under Google Workspace Group entities are pruned from the response.
This is useful when the caller only needs the list of group names without
expanding group membership, which can be very large at scale.

excludeAzureTypes
array of strings

Specifies the Object types to be filtered out for Azure that match the
passed in types such as 'kVirtualMachine', 'kSQLDatabase'.
For example, set this parameter to 'kVirtualMachine' to exclude azure VMs
from being returned.

excludeAzureTypes
Allowed:
excludeGcpTypes
array of strings

Specifies the Object types to be filtered out for GCP that match the
passed in types such as 'kVirtualMachine', 'kBigQueryDataset'.
For example, set this parameter to 'kVirtualMachine' to exclude GCP VMs
from being returned.

excludeGcpTypes
Allowed:
excludeKubernetesTypes
array of strings

Specifies the Object types to be filtered out for Kubernetes that match
the passed in types such as 'kService'.
For example, set this parameter to 'kService' to exclude services
from being returned.

excludeKubernetesTypes
Allowed:
boolean

Set this parameter to true to also return kDatastore object types found in
the Source in addition to their Object subtrees.
By default, datastores are not returned.

boolean

Set this parameter to true to also return kNetwork object types found in
the Source in addition to their Object subtrees.
By default, network objects are not returned.

boolean

Set this parameter to true to also return kVMFolder object types found in
the Source in addition to their Object subtrees.
By default, VM folder objects are not returned.

boolean

Set this parameter to true to also return fields of the object found
in the Source in addition to their Object subtrees.
By default, Sfdc object fields are not returned.

boolean

Set this parameter to true to also return system VApp object types found
in the Source in addition to their Object subtrees.
By default, VM folder objects are not returned.

environments
array of strings

Return only Protection Sources that match the passed in environment type
such as 'kVMware', 'kSQL', 'kView' 'kPhysical', 'kPuppeteer', 'kPure',
'kNetapp', 'kGenericNas', 'kHyperV', 'kAcropolis', or 'kAzure'.
For example, set this parameter to 'kVMware' to only return the Sources
(and their Object subtrees) found in the 'kVMware'
(VMware vCenter Server) environment.

NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.
kNimble, kHpe3Par, kAzure, kNetapp, kAgent, kGenericNas, kAcropolis,
kPhysicalFiles, kIsilon, kGPFS, kKVM, kAWS, kExchange, kHyperVVSS,
kOracle, kGCP, kFlashBlade, kAWSNative, kO365, kO365Outlook, kHyperFlex,
kGCPNative, kAzureNative, kKubernetes, kElastifile, kAD,
kRDSSnapshotManager, kCassandra, kMongoDB, kCouchbase, kHdfs, kHive,
kHBase, kUDA, KSfdc, kAwsS3

environments
Allowed:
string

This field is deprecated. Use environments instead.
deprecated: true

boolean

If specified, then a list of entites with permissions assigned to them are
returned.

sids
array of strings

Filter the object subtree for the sids given in the list.

sids
boolean

If specified, then crednetial for the registered sources will be included.
Credential is first encrypted with internal key and then reencrypted with
user supplied 'encryption_key'.

string

Key to be used to encrypt the source credential. If
include_source_credentials is set to true this key must be specified.

boolean

If specified, the object protection of entities(if any) will be returned.

boolean

Specifies whether to prune non critical info within entities.
Incase of VMs, virtual disk information will be pruned.
Incase of Office365, metadata about user entities will be pruned.
This can be used to limit the size of the response by caller.

boolean

Specifies whether to prune the aggregation information about the number
of entities protected/unprotected.

boolean

Specifies whether we can serve the GET request to the read replica cache.
setting this to true ensures that the API request is served
to the read replica. setting this to false will serve the request to
the master.

boolean

Specifies if entity external metadata should be included within the
response to get entity hierarchy call.

boolean

Set this parameter to true to include node count statistics for Oracle
protection sources. When set, the nodeCount field in
oracleProtectionSource will be populated from the cluster configuration.

boolean

Specifies whether to filter entities by protection status.
If set to true, only entities covered by a protection group are
returned. If set to false, only entities not covered by any
protection group are returned. If omitted, all entities are
returned regardless of protection status.

tenantIds
array of strings

TenantIds contains ids of the tenants for which objects are to be
returned.

tenantIds
boolean

AllUnderHierarchy specifies if objects of all the tenants under the
hierarchy of the logged in user's organization should be returned.

Headers
string

Specifies the type of the request. Possible values are UIUser and UIAuto,
which means the request is triggered by user or is an auto refresh
request. Services like magneto will use this to determine the priority
of the requests, so that it can more intelligently handle overload
situations by prioritizing higher priority requests.

Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?