Getting StartedAPI ReferenceRecipesGitHub
API Reference

Register a Protection Source.

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

Privileges: PROTECTION_SOURCE_MODIFY

Register a Protection Source on the Cohesity Cluster.
It could be the root node of a vCenter Server or a physical server.

Returns the newly registered Protection Source upon success.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to register a protection source.

Specifies the parameters required to register a Protection Source.

boolean | null

Specifies if this source entity has enabled storage array snapshot or not.

string | null
enum

Specifies the entity type if the environment is kAcropolis.
overrideDescription: true

Allowed:
string | null

Specifies the agent endpoint if it is different from the source endpoint.

allowedIpAddresses
array of strings | null

Specifies the list of IP Addresses on the registered source to be
exclusively allowed for doing any type of IO operations.

allowedIpAddresses
boolean | null

Specified whether to do registration in async manner for VMware Sources.

awsCredentials
object | null

Specifies credentials needed to authenticate with AWS Cloud Platform.

awsFleetParams
object | null

Specifies information related to AWS fleets launched for various purposes.
This will only be set for kIAMUser entity.

azureCredentials
object | null

Specifies credentials needed to authenticate with Azure Cloud Platform.

blacklistedIpAddresses
array of strings | null

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

blacklistedIpAddresses
cloudCredentials
object | null

Specifies the cloud credentials used to authenticate with cloud(Aws).

clusterNetworkInfo
object | null

Specifies information related to cluster. This is only valid for CE
clusters. This is only populated for kIAMUser entity.

int64 | null

Specifies the Bifrost realm to be associated with the source root.
Whenever needed, the workflows related to this source would then
only use Bifrosts from the specified realm.

deniedIpAddresses
array of strings | null

Specifies the list of IP Addresses on the registered source to be denied
for doing any type of IO operations.

deniedIpAddresses
boolean | null

Specifies whether to enable M365 Storage Service API based(CSM) Backup
for the M365 source.

string | null

If set, user has encrypted the credential with 'user_ecryption_key'.
It is assumed that credentials are first encrypted using
internal magento key and then encrypted using user encryption key.

string | null

Specifies the network endpoint of the Protection Source where it is
reachable. It could be an URL or hostname or an IP address of the
Protection Source.

string | null
enum

Specifies the environment such as 'kPhysical' or 'kVMware' of the
Protection Source.
overrideDescription: true
Supported environment types such as 'kView', 'kSQL', 'kVMware', etc.
NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.
'kVMware' indicates the VMware Protection Source environment.
'kHyperV' indicates the HyperV Protection Source environment.
'kSQL' indicates the SQL Protection Source environment.
'kView' indicates the View Protection Source environment.
'kPuppeteer' indicates the Cohesity's Remote Adapter.
'kPhysical' indicates the physical Protection Source environment.
'kPure' indicates the Pure Storage Protection Source environment.
'kNimble' indicates the Nimble Storage Protection Source environment.
'kHpe3Par' indicates the Hpe 3Par Storage Protection Source environment.
'kAzure' indicates the Microsoft's Azure Protection Source environment.
'kNetapp' indicates the Netapp Protection Source environment.
'kAgent' indicates the Agent Protection Source environment.
'kGenericNas' indicates the Generic Network Attached Storage Protection
Source environment.
'kAcropolis' indicates the Acropolis Protection Source environment.
'kPhysicalFiles' indicates the Physical Files Protection Source environment.
'kIbmFlashSystem' indicates the IBM Flash System Protection Source environment.
'kIsilon' indicates the Dell EMC's Isilon Protection Source environment.
'kGPFS' indicates IBM's GPFS Protection Source environment.
'kKVM' indicates the KVM Protection Source environment.
'kAWS' indicates the AWS Protection Source environment.
'kExchange' indicates the Exchange Protection Source environment.
'kHyperVVSS' indicates the HyperV VSS Protection Source
environment.
'kOracle' indicates the Oracle Protection Source environment.
'kGCP' indicates the Google Cloud Platform Protection Source environment.
'kFlashBlade' indicates the Flash Blade Protection Source environment.
'kAWSNative' indicates the AWS Native Protection Source environment.
'kO365' indicates the Office 365 Protection Source environment.
'kO365Outlook' indicates Office 365 outlook Protection Source environment.
'kHyperFlex' indicates the Hyper Flex Protection Source environment.
'kGCPNative' indicates the GCP Native Protection Source environment.
'kAzureNative' indicates the Azure Native Protection Source environment.
'kKubernetes' indicates a Kubernetes Protection Source environment.
'kElastifile' indicates Elastifile Protection Source environment.
'kAD' indicates Active Directory Protection Source environment.
'kRDSSnapshotManager' indicates AWS RDS Protection Source environment.
'kCassandra' indicates Cassandra Protection Source environment.
'kMongoDB' indicates MongoDB Protection Source environment.
'kCouchbase' indicates Couchbase Protection Source environment.
'kHdfs' indicates Hdfs Protection Source environment.
'kHive' indicates Hive Protection Source environment.
'kHBase' indicates HBase Protection Source environment.
'kUDA' indicates Universal Data Adapter Protection Source environment.
'kSAPHANA' indicates SAP HANA protection source environment.
'kDB2' indicates DB2 Protection Source environment.
'kO365Teams' indicates the Office365 Teams Protection Source environment.
'kO365Group' indicates the Office365 Groups Protection Source environment.
'kO365Exchange' indicates the Office365 Mailbox Protection Source environment.
'kO365OneDrive' indicates the Office365 OneDrive Protection Source environment.
'kO365Sharepoint' indicates the Office365 SharePoint Protection Source environment.
'kO365PublicFolders' indicates the Office365 PublicFolders Protection Source environment.
'kPostgres' indicates the Postgres Protection Source environment.
kHpe3Par, kIbmFlashSystem, 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, kSAPHANA,
kO365Teams, kO365Group, kO365Exchange, kO365OneDrive, kO365Sharepoint,
kO365PublicFolders, kMongoDBPhysical, kPostgres

exchangeDagProtectionPreference
object | null

Specifies information about the preference order while choosing
between which database copy of the exchange database which is part of
DAG should be protected.

boolean | null

ForceRegister is applicable to Physical Environment. By default, the agent
running on a physical host will fail the registration, if it is already
registered as part of another cluster. By setting this option to true,
agent can be forced to register with the current cluster. This is a hidden
parameter and should not be documented externally.

gcpCredentials
object | null

Specifies credentials needed to authenticate with Google Cloud Platform.

gcpFleetParams
object | null

Specifies information related to GCP fleets launched for various purposes.
This will only be set for kIAMUser entity.

string | null
enum

Specifies the optional OS type of the Protection Source (such as kWindows
or kLinux).
overrideDescription: true
'kLinux' indicates the Linux operating system.
'kWindows' indicates the Microsoft Windows operating system.
'kAix' indicates the IBM AIX operating system.
'kSolaris' indicates the Oracle Solaris operating system.
'kSapHana' indicates the Sap Hana database system developed by SAP SE.
'kSapOracle' indicates the Sap Oracle database system developed by SAP SE.
'kCockroachDB' indicates the CockroachDB database system.
'kMySQL' indicates the MySQL database system.
'kSapSybase' indicates the SapSybase database system.
'kSapMaxDB' indicates the SapMaxDB database system.
'kSapSybaseIQ' indicates the SapSybaseIQ database system.
'kDB2' indicates the DB2 database system.
'kSapASE' indicates the SapASE database system.
'kMariaDB' indicates the MariaDB database system.
'kPostgreSQL' indicates the PostgreSQL database system.
'kHPUX' indicates the HPUX database system.
'kVOS' indicates the VOS database system.
'kOther' indicates the other types of operating system.

string | null
enum

Specifies the entity type such as 'kStorageArray' if the environment is
kHpe3Par.
overrideDescription: true

Allowed:
string | null
enum

Specifies the entity type if the environment is kHyperV.
overrideDescription: true

Allowed:
string | null
enum

Specifies the entity type such as 'kStorageArray' if the environment is
kIbmFlashSystem.
overrideDescription: true

Allowed:
boolean | null

Set to true if credentials are encrypted by internal magneto key.

boolean | null

Specifies if the physical host has to be registered as a proxy host.

isilonParams
object | null

Specifies the registered protection source params for Isilon Source

kubernetesCredentials
object | null

Specifies the credentials needed to authenticate a Kubernetes cluster.

kubernetesParams
object | null

Extra parameters needed for registering a K8s resource.

string | null
enum

Specifies the entity type if the environment is kKubernetes.
overrideDescription: true

Allowed:
string | null
enum

Specifies the entity type if the environment is kKVM.
overrideDescription: true

Allowed:
nasMountCredentials
object | null

Specifies the server credentials to connect to a NetApp server.
This field is required for mounting SMB volumes on NetApp servers.

string | null
enum

Specifies the entity type such as 'kCluster,' if the environment is
kNetapp.

Allowed:
string | null
enum

Specifies the entity type such as 'kStorageArray' if the environment is
kNimble.
overrideDescription: true

Allowed:
string | null
enum

Specifies the entity type such as 'kPrismCentral,' if the environment is
kNutanixFS.

Allowed:
office365CredentialsList
array of objects | null

Office365 Source Credentials.

Specifies credentials needed to authenticate & authorize user for
Office365 using MS Graph APIs.

office365CredentialsList
string | null

Specifies the region for Office365.

office365ServiceAccountCredentialsList
array of objects | null

Office365 Service Account Credentials.

Specifies credentials for improving mailbox backup performance for O365.

office365ServiceAccountCredentialsList
string | null
enum

Specifies the entity type such as 'kDomain', 'kOutlook', 'kMailbox', if the
environment is kO365.

Allowed:
string | null

Specifies password of the username to access the target source.

physicalParams
object | null

Contains all params specified by the user while registering a physical
entity.

string | null
enum

Specifies the entity type such as 'kPhysicalHost' if the environment is
kPhysical.
overrideDescription: true

Allowed:
proxyHostSourceIdList
array of int64s | null

Specifies the list of the protection source id of the windows physical
host which will be used during the protection and recovery of the sites
that belong to a office365 domain.

proxyHostSourceIdList
string | null
enum

Specifies the entity type such as 'kStorageArray' if the environment is
kPure.
overrideDescription: true

Allowed:
int32 | null

Specifies the entity type when the environment is kQumulo.

boolean | null

ReRegister is applicable to Physical Environment. By default, the
agent running on a physical host will fail the registration, if it is
already registered with the cluster. By setting this option to true, agent
can be re-registered with the current cluster.

boolean | null

RestoreConfig is applicable to Physical Environment. The ReRegister option
needs to be true if RestoreConfig is true. By setting this option to true,
the agent configuration can be restored.

boolean | null

This controls whether to use source side dedup on the source or not.
This is only applicable to sources which support source side dedup
(e.g., Linux physical servers).

sslVerification
object | null

SSL verification parameter is applicable to VMware environment. It can be
populated with the server's CA certificate or certificate chain and
vCenter's certificate will be validated against this.

subnets
array of objects | null

Specifies the list of subnet IP addresses and CIDR prefix for enabeling
network data transfer. Currently, only Subnet IP and NetbaskBits are valid
input fields. All other fields provided as input will be ignored.

subnets
throttlingPolicy
object | null

Specifies the throttling policy that should be applied to this Source.

throttlingPolicyOverrides
array of objects | null

Array of Throttling Policy Overrides for Datastores.

Specifies a list of Throttling Policy for datastores that override the
common throttling policy specified for the registered Protection Source.
For datastores not in this list, common policy will still apply.

throttlingPolicyOverrides
boolean | null

Specifies whether to use existing Office365 credentials like password and
client secret for app id's.

boolean | null

Specifies whether OAuth should be used for authentication in case of
Exchange Online.

string | null

Specifies username to access the target source.

vlanParams
object | null

Specifies the VLAN parameters to be used while taking the backup of this
entity and is the preferred selection for restoring the same.
For restores, the VLAN parameters specifed here can be overridden.
Currently, this is only applicable for Physical hosts running Oracle.

vmwareParams
object | null

Contains all params specified by the user while registering a Vmware
entity.

string | null
enum

Specifies the entity type such as 'kVCenter' if the environment is
kKMware.
overrideDescription: true

Allowed:
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?