Update a previously registered Protection Source with new details.

patch

https://cluster.ip.address/irisservices/api/v1/public/protectionSources/{id}

Privileges: PROTECTION_SOURCE_MODIFY

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies a unique id of the Protection Source to update.

Body Params

Request to update protection source.

UpdateProtectionSourceParameters defines a public data definition
for updating protection source.

IsStorageArraySnapshotEnabled

boolean | null

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

agentEndpoint

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

asyncRegistration

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.

connectionId

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

enableM365CSMBackup

boolean | null

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

endpoint

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.

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.

forceRegister

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.

hostType

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.

isProxyHost

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 updating a K8s resource.

minimumFreeSpaceGB

int64 | null

Specifies the minimum space in GB after which backup jobs will be canceled
due to low space.

nasMountCredentials

object | null

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

office365CredentialsList

array of objects | null

Office365 Source Credentials.

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

office365CredentialsList

office365Region

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

password

string | null

Specifies password of the username to access the target source.

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

reRegister

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.

restoreConfig

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.

sourceSideDedupEnabled

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

useExistingCredentials

boolean | null

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

useOAuthForExchangeOnline

boolean | null

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

username

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.

Responses

200Success

defaultError