/public/protectionSources/registrationInfo

get

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

Privileges: PROTECTION_VIEW

Returns the registration and protection information of the registered
Protection Sources.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

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.

environments

ids

array of int64s

Return only the registered root nodes whose Ids are given in the list.

ids

includeEntityPermissionInfo

boolean

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

sids

array of strings

Filter the registered root nodes for the sids given in the list.

sids

includeSourceCredentials

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'.

encryptionKey

string

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

includeApplicationsTreeInfo

boolean

Specifies whether to return applications tree info or not.

pruneNonCriticalInfo

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.

useCachedData

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.

includeExternalMetadata

boolean

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

maintenanceStatus

string

enum

Specifies the maintenance status of a source
'UnderMaintenance' indicates the source is currently under maintenance.
'ScheduledMaintenance' indicates the source is scheduled for maintenance.
'NotConfigured' indicates maintenance is not configured on the source.

Allowed:

tenantIds

array of strings

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

tenantIds

allUnderHierarchy

boolean

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

Headers

requestInitiatorType

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

Language

Credentials

Header

Loading…

Response

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

application/json

200Success

defaultError