Get the list of Protection Source registrations.

get

https://helios.cohesity.com/v2/data-protect/sources/registrations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of integers

Ids specifies the list of source registration ids to return. If left empty, every source registration will be returned by default.

ids

tenantIds

array of strings

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

tenantIds

includeTenants

boolean

If true, the response will include Registrations which were created by all tenants which the current user has permission to see. If false, then only Registrations created by the current user will be returned.

includeSourceCredentials

boolean

If true, the encrypted 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

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

useCachedData

boolean

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

includeExternalMetadata

boolean

If true, the external entity metadata like maintenance mode config for the registered sources will be included.

ignoreTenantMigrationInProgressCheck

boolean

If true, tenant migration check will be ignored

includeHosts

boolean

If true, the list of hosts associated with the registered source will be included. The default is value is false.

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

200Success

defaultError