Cluster V2 (7.3 -> 7.3.1)

API Changelog: 7.3 → 7.3.1

API Changelog: 7.3 → 7.3.1

12 incompatible changes (including 0 removed endpoints) · 91 compatible changes (including 10 new endpoints, 0 deprecated)

Incompatible (12)
API EndpointWhat ChangedDetails
PUT/clusters/upgrade-checks
  • New required fields
  • New fields that are always included in the response
New required request fields (1)
  • requestType[Request]— Type of upgrade checks(pre/post) to run
Now-guaranteed response fields (1)
  • testRunInstanceId[Return Type]— Specifies test run instance allocated for upgrade checks
POST/network/vlans
  • Privilege name updated
  • New properties added
  • New optional properties
  • New required fields
  • New fields that are always included in the response
Privilege name updated

No API contract change for POST. Only the documented privilege name was updated from Unknown Privileges to VLAN_MODIFY, CLUSTER_CREATE. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

Added properties (4)
  • gatewayV6[Request, Return Type]— Ipv6 gateway of the vlan.
  • loopbackInterfaceGroupId[Request, Return Type]— Id of the Loopback Interface group. Used only in get, for display
  • subnetV6[Request, Return Type]— IPv6 subnet in CIDR format i.e ip-address/prefix
  • vlanInterfaceGroupName[Request, Return Type]— Vlan interface group name, it should be in interface_group_name.vlan_id format.
New optional properties (2)
  • interfaceName[Request]— Name of the interface.
  • interfaceName[Return Type]— Name of the interface.
New required request fields (1)
  • vlanInterfaceGroupName[Request]— Vlan interface group name, it should be in interface_group_name.vlan_id format.
Now-guaranteed response fields (1)
  • vlanInterfaceGroupName[Return Type]— Vlan interface group name, it should be in interface_group_name.vlan_id format.
POST/groups
  • Breaking change details
  • New properties added
  • New fields that are always included in the response
Breaking details (1)
  • [Request] type of the request body (root schema) changed: arrayobject
Added properties (1)
  • groupType[Return Type]— Specifies the type of group: local, ad, or idp.
Now-guaranteed response fields (1)
  • groupType[Return Type]— Specifies the type of group: local, ad, or idp.
POST/users
  • New required fields
  • New fields that are always included in the response
New required request fields (2)
  • domain[Request]— Specifies the domain of the user. For active directories, this is the fully qualified domain name (FQDN). It is 'LOCAL' for local users on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.
  • username[Request]— Specifies the username.
Now-guaranteed response fields (2)
  • domain[Return Type]— Specifies the domain of the user. For active directories, this is the fully qualified domain name (FQDN). It is 'LOCAL' for local users on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.
  • username[Return Type]— Specifies the username.
PUT/data-protect/sources/registrations/{id}
  • New properties added
  • New required fields
  • New fields that are always included in the response
Added properties (5)
  • asyncRegistration[Request]— Indicates whether the source should be registered asynchronously. Currently supported only for VMware sources.
  • name[Return Type]— A user specified name for this source.
  • nutanixFSParams[Request, Return Type]— Specifies parameters to register an NutanixFS Source.
  • postgresParams[Request, Return Type]— Specifies the object to hold username and password.
  • useCases[Request, Return Type]— The use cases for which the source is to be registered.
New required request fields (1)
  • entityId[Request]— Specifies the entity id of the source. The source can a non-root entity.
Now-guaranteed response fields (1)
  • entityId[Return Type]— Specifies the entity id of the source. The source can a non-root entity.
POST/data-protect/sources/registrations
  • New properties added
  • New required fields
  • New fields that are always included in the response
Added properties (5)
  • asyncRegistration[Request]— Indicates whether the source should be registered asynchronously. Currently supported only for VMware sources.
  • name[Return Type]— A user specified name for this source.
  • nutanixFSParams[Request, Return Type]— Specifies parameters to register an NutanixFS Source.
  • postgresParams[Request, Return Type]— Specifies the object to hold username and password.
  • useCases[Request, Return Type]— The use cases for which the source is to be registered.
New required request fields (1)
  • entityId[Request]— Specifies the entity id of the source. The source can a non-root entity.
Now-guaranteed response fields (1)
  • entityId[Return Type]— Specifies the entity id of the source. The source can a non-root entity.
PUT/data-protect/protection-groups/{id}
  • New properties added
  • New required fields
  • New fields that are always included in the response
Added properties (27)
  • auroraPostgresDbProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS Aurora Postgres DB related Protection Groups.
  • blobStorageProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Blob Storage workload. Objects must be specified.
  • bucketAutoCreate[Request, Return Type]— Specifies whether to auto create the Cloud Storage bucket if it doesn't exist.
  • cassandraProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB Cassandra workload. Objects must be specified.
  • cosmosDBNoSQLProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB NoSQL workload. Objects must be specified.
  • cosmosdbmongodbProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB MongoDB workload. Objects must be specified.
  • diskExclusionParams[Request, Return Type]— Specifies parameters to exclude Azure Disks attached to Azure VM at job or object level. A disk satisfying any of this criteria will be excluded from the backup job.
  • documentDBProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS DocumentDB related Protection Groups.
  • firestoreProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to GCP Firestore related Protection Groups.
  • mySqlProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Google MySQL related Protection Groups.
  • nfsProtocol[Request, Return Type]— Specifies the preferred protocol to use if this device supports multiple protocols.
  • nutanixFSParams[Request, Return Type]— Specifies the parameters which are specific to Nutanix FS related Protection Groups.
  • oracleProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS RDS Oracle related Protection Groups.
  • postgreSqlProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Google PostgreSQL related Protection Groups.
  • postgresParams[Request, Return Type]— Specifies parameters related to the Postgres Protection group.
  • postgresqlProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure PostgreSQL workload. Objects must be specified.
  • protectionType[Return Type]— Specifies the AWS Protection Group type.
  • rdsMsSqlProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS RDS MS SQL related Protection Groups.
  • rdsPostgresDbProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS RDS Postgres DB related Protection Groups.
  • redshiftProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS Redshift related Protection Groups.
  • spannerProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Google Spanner related Protection Groups.
  • sqlDbProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure SQL DB workload. Objects must be specified.
  • sqlMiProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure SQL MI workload. Objects must be specified.
  • sqlServerProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Google SQL Server related Protection Groups.
  • tableApiProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Table API workload. Objects must be specified.
  • tableStorageProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Table Storage workload. Objects must be specified.
  • teamsProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Office 365 Teams related Protection Groups.
New required request fields (1)
  • cloudStorageBucketName[Request]— The Cloud Storage bucket name for Oracle database backup.
Now-guaranteed response fields (1)
  • cloudStorageBucketName[Return Type]— The Cloud Storage bucket name for Oracle database backup.
POST/data-protect/recoveries/download-files-folders
  • Breaking change details
  • New properties added
  • Properties removed
  • New optional properties
Breaking details (3)
  • [Return Type] removed property acropolisParams.recoverVmParams.acropolisTargetParams.recoveryTargetConfig.newSourceConfig.networkConfig.networkPortGroup
  • [Return Type] type of azureParams.azureMysqlParams.azureTargetParams.newSourceConfig changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
  • [Return Type] type of azureParams.azureMysqlParams.snapshots[n].recoverAzureMysqlObjectParams changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
Added properties (29)
  • azureBlobStorageParams[Return Type]— Specifies the parameters to recover Azure Blob Storage .
  • azureCosmosDBCassandraParams[Return Type]— Specifies the parameters to recover Azure CosmosDB Cassandra.
  • azureCosmosDBMongoDBParams[Return Type]— Specifies the parameters to recover Azure CosmosDB MongoDB.
  • azureCosmosDBNoSQLParams[Return Type]— Specifies the parameters to recover Azure CosmosDB NoSQL.
  • azurePostgreSQLParams[Return Type]— Specifies the parameters to recover Azure PostgreSQL.
  • azureSQLDBParams[Return Type]— Specifies the parameters to recover Azure SQL Database.
  • azureSQLMIParams[Return Type]— Specifies the parameters to recover Azure SQL Managed Instance.
  • azureTableAPIParams[Return Type]— Specifies the parameters to recover Azure Table API.
  • azureTableStorageParams[Return Type]— Specifies the parameters to recover Azure Table Storage.
  • bucketAutoCreate[Return Type]— Specifies whether to auto create the Cloud Storage bucket if it does not exist.
  • disableNetwork[Return Type]— Specifies whether the attached network should be left in disabled state. Default is false
  • documentParams[Request]— Specifies additional info needed for o365 recovery/download.
  • gcpAlloyDbPostgreSqlParams[Return Type]— Specifies the parameters to recover GCP AlloyDB PostgreSQL database.
  • gcpFirestoreParams[Return Type]— Specifies the parameters to recover GCP Firestore.
  • gcpMySqlParams[Return Type]— Specifies the parameters to recover GCP MySQL database.
  • gcpPostgreSqlParams[Return Type]— Specifies the parameters to recover GCP PostgreSQL database.
  • gcpSqlServerParams[Return Type]— Specifies the parameters to recover GCP SQL Server database.
  • googleSpannerParams[Return Type]— Specifies the parameters to recover Google Spanner.
  • name[Return Type]— Specifies the name of the recovery task. This field must be set and must be a unique name.
  • newNetworkConfig[Return Type]— Specifies the new network config parameters to be applied to VMware VMs.
  • nutanixFSParams[Return Type]— Specifies the recovery options specific to NutanixFS environment.
  • postgresParams[Return Type]— Specifies the recovery options specific to Postgres environment.
  • recoverAWSDocumentDBParams[Return Type]— Specifies the parameters to recover AWS DocumentDB.
  • recoverRdsAuroraPostgresDbParams[Return Type]— Specifies the parameters to recover RDS Aurora Postgres.
  • recoverRdsMsSqlParams[Return Type]— Specifies the parameters to recover AWS RDS MS SQL.
  • recoverRdsOracleParams[Return Type]— Specifies the parameters to recover AWS RDS Oracle.
  • recoverRdsPostgresDbParams[Return Type]— Specifies the parameters to recover RDS Postgres.
  • recoverRedshiftParams[Return Type]— Specifies the parameters to recover Redshift.
  • siteUuid[Return Type]— Specifies the uuid of the site of the document library item. This is needed for Teams and Groups having subsites, as multiple items across different subsites can be selected for granular recovery. This is only applicable for the subsite items.
Deleted properties (1)
  • networkPortGroup[Return Type]— Specifies the object identifier to perform recovery.
New optional properties (1)
  • cloudStorageBucketName[Return Type]— The Cloud Storage bucket name for MS SQL database recovery.
GET/data-protect/recoveries/{id}
  • Breaking change details
  • New properties added
  • Properties removed
  • New optional properties
Breaking details (3)
  • [Return Type] removed property acropolisParams.recoverVmParams.acropolisTargetParams.recoveryTargetConfig.newSourceConfig.networkConfig.networkPortGroup
  • [Return Type] type of azureParams.azureMysqlParams.azureTargetParams.newSourceConfig changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
  • [Return Type] type of azureParams.azureMysqlParams.snapshots[n].recoverAzureMysqlObjectParams changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
Added properties (28)
  • azureBlobStorageParams[Return Type]— Specifies the parameters to recover Azure Blob Storage .
  • azureCosmosDBCassandraParams[Return Type]— Specifies the parameters to recover Azure CosmosDB Cassandra.
  • azureCosmosDBMongoDBParams[Return Type]— Specifies the parameters to recover Azure CosmosDB MongoDB.
  • azureCosmosDBNoSQLParams[Return Type]— Specifies the parameters to recover Azure CosmosDB NoSQL.
  • azurePostgreSQLParams[Return Type]— Specifies the parameters to recover Azure PostgreSQL.
  • azureSQLDBParams[Return Type]— Specifies the parameters to recover Azure SQL Database.
  • azureSQLMIParams[Return Type]— Specifies the parameters to recover Azure SQL Managed Instance.
  • azureTableAPIParams[Return Type]— Specifies the parameters to recover Azure Table API.
  • azureTableStorageParams[Return Type]— Specifies the parameters to recover Azure Table Storage.
  • bucketAutoCreate[Return Type]— Specifies whether to auto create the Cloud Storage bucket if it does not exist.
  • disableNetwork[Return Type]— Specifies whether the attached network should be left in disabled state. Default is false
  • gcpAlloyDbPostgreSqlParams[Return Type]— Specifies the parameters to recover GCP AlloyDB PostgreSQL database.
  • gcpFirestoreParams[Return Type]— Specifies the parameters to recover GCP Firestore.
  • gcpMySqlParams[Return Type]— Specifies the parameters to recover GCP MySQL database.
  • gcpPostgreSqlParams[Return Type]— Specifies the parameters to recover GCP PostgreSQL database.
  • gcpSqlServerParams[Return Type]— Specifies the parameters to recover GCP SQL Server database.
  • googleSpannerParams[Return Type]— Specifies the parameters to recover Google Spanner.
  • name[Return Type]— Specifies the name of the Recovery.
  • newNetworkConfig[Return Type]— Specifies the new network config parameters to be applied to VMware VMs.
  • nutanixFSParams[Return Type]— Specifies the recovery options specific to NutanixFS environment.
  • postgresParams[Return Type]— Specifies the recovery options specific to Postgres environment.
  • recoverAWSDocumentDBParams[Return Type]— Specifies the parameters to recover AWS DocumentDB.
  • recoverRdsAuroraPostgresDbParams[Return Type]— Specifies the parameters to recover RDS Aurora Postgres.
  • recoverRdsMsSqlParams[Return Type]— Specifies the parameters to recover AWS RDS MS SQL.
  • recoverRdsOracleParams[Return Type]— Specifies the parameters to recover AWS RDS Oracle.
  • recoverRdsPostgresDbParams[Return Type]— Specifies the parameters to recover RDS Postgres.
  • recoverRedshiftParams[Return Type]— Specifies the parameters to recover Redshift.
  • siteUuid[Return Type]— Sharepoint site uuid to which this Drive belongs. This is needed for Teams and Groups having subsites, as multiple items across different subsites can be selected for granular recovery.
Deleted properties (1)
  • networkPortGroup[Return Type]— Specifies the object identifier to perform recovery.
New optional properties (1)
  • cloudStorageBucketName[Return Type]— The Cloud Storage bucket name for MS SQL database recovery.
POST/data-protect/protection-groups
  • New properties added
  • New required fields
  • New fields that are always included in the response
Added properties (27)
  • auroraPostgresDbProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS Aurora Postgres DB related Protection Groups.
  • blobStorageProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Blob Storage workload. Objects must be specified.
  • bucketAutoCreate[Request, Return Type]— Specifies whether to auto create the Cloud Storage bucket if it doesn't exist.
  • cassandraProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB Cassandra workload. Objects must be specified.
  • cosmosDBNoSQLProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB NoSQL workload. Objects must be specified.
  • cosmosdbmongodbProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB MongoDB workload. Objects must be specified.
  • diskExclusionParams[Request, Return Type]— Specifies parameters to exclude Azure Disks attached to Azure VM at job or object level. A disk satisfying any of this criteria will be excluded from the backup job.
  • documentDBProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS DocumentDB related Protection Groups.
  • firestoreProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to GCP Firestore related Protection Groups.
  • mySqlProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Google MySQL related Protection Groups.
  • nfsProtocol[Request, Return Type]— Specifies the preferred protocol to use if this device supports multiple protocols.
  • nutanixFSParams[Request, Return Type]— Specifies the parameters which are specific to Nutanix FS related Protection Groups.
  • oracleProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS RDS Oracle related Protection Groups.
  • postgreSqlProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Google PostgreSQL related Protection Groups.
  • postgresParams[Request, Return Type]— Specifies parameters related to the Postgres Protection group.
  • postgresqlProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure PostgreSQL workload. Objects must be specified.
  • protectionType[Return Type]— Specifies the AWS Protection Group type.
  • rdsMsSqlProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS RDS MS SQL related Protection Groups.
  • rdsPostgresDbProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS RDS Postgres DB related Protection Groups.
  • redshiftProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to AWS Redshift related Protection Groups.
  • spannerProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Google Spanner related Protection Groups.
  • sqlDbProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure SQL DB workload. Objects must be specified.
  • sqlMiProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure SQL MI workload. Objects must be specified.
  • sqlServerProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Google SQL Server related Protection Groups.
  • tableApiProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Table API workload. Objects must be specified.
  • tableStorageProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Table Storage workload. Objects must be specified.
  • teamsProtectionTypeParams[Request, Return Type]— Specifies the parameters which are specific to Office 365 Teams related Protection Groups.
New required request fields (1)
  • cloudStorageBucketName[Request]— The Cloud Storage bucket name for Oracle database backup.
Now-guaranteed response fields (1)
  • cloudStorageBucketName[Return Type]— The Cloud Storage bucket name for Oracle database backup.
POST/data-protect/recoveries
  • Breaking change details
  • New properties added
  • Properties removed
  • New optional properties
Breaking details (6)
  • [Request] removed property acropolisParams.recoverVmParams.acropolisTargetParams.recoveryTargetConfig.newSourceConfig.networkConfig.networkPortGroup
  • [Request] type of azureParams.azureMysqlParams.azureTargetParams.newSourceConfig changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
  • [Request] type of azureParams.azureMysqlParams.snapshots[n].recoverAzureMysqlObjectParams changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
  • [Return Type] removed property acropolisParams.recoverVmParams.acropolisTargetParams.recoveryTargetConfig.newSourceConfig.networkConfig.networkPortGroup
  • [Return Type] type of azureParams.azureMysqlParams.azureTargetParams.newSourceConfig changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
  • [Return Type] type of azureParams.azureMysqlParams.snapshots[n].recoverAzureMysqlObjectParams changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
Added properties (28)
  • azureBlobStorageParams[Request, Return Type]— Specifies the parameters to recover Azure Blob Storage .
  • azureCosmosDBCassandraParams[Request, Return Type]— Specifies the parameters to recover Azure CosmosDB Cassandra.
  • azureCosmosDBMongoDBParams[Request, Return Type]— Specifies the parameters to recover Azure CosmosDB MongoDB.
  • azureCosmosDBNoSQLParams[Request, Return Type]— Specifies the parameters to recover Azure CosmosDB NoSQL.
  • azurePostgreSQLParams[Request, Return Type]— Specifies the parameters to recover Azure PostgreSQL.
  • azureSQLDBParams[Request, Return Type]— Specifies the parameters to recover Azure SQL Database.
  • azureSQLMIParams[Request, Return Type]— Specifies the parameters to recover Azure SQL Managed Instance.
  • azureTableAPIParams[Request, Return Type]— Specifies the parameters to recover Azure Table API.
  • azureTableStorageParams[Request, Return Type]— Specifies the parameters to recover Azure Table Storage.
  • bucketAutoCreate[Request, Return Type]— Specifies whether to auto create the Cloud Storage bucket if it does not exist.
  • disableNetwork[Request, Return Type]— Specifies whether the attached network should be left in disabled state. Default is false
  • gcpAlloyDbPostgreSqlParams[Request, Return Type]— Specifies the parameters to recover GCP AlloyDB PostgreSQL database.
  • gcpFirestoreParams[Request, Return Type]— Specifies the parameters to recover GCP Firestore.
  • gcpMySqlParams[Request, Return Type]— Specifies the parameters to recover GCP MySQL database.
  • gcpPostgreSqlParams[Request, Return Type]— Specifies the parameters to recover GCP PostgreSQL database.
  • gcpSqlServerParams[Request, Return Type]— Specifies the parameters to recover GCP SQL Server database.
  • googleSpannerParams[Request, Return Type]— Specifies the parameters to recover Google Spanner.
  • name[Request, Return Type]— Specifies the name of the Recovery.
  • newNetworkConfig[Request, Return Type]— Specifies the new network config parameters to be applied to VMware VMs.
  • nutanixFSParams[Request, Return Type]— Specifies the recovery options specific to NutanixFS environment.
  • postgresParams[Request, Return Type]— Specifies the recovery options specific to Postgres environment.
  • recoverAWSDocumentDBParams[Request, Return Type]— Specifies the parameters to recover AWS DocumentDB.
  • recoverRdsAuroraPostgresDbParams[Request, Return Type]— Specifies the parameters to recover RDS Aurora Postgres.
  • recoverRdsMsSqlParams[Request, Return Type]— Specifies the parameters to recover AWS RDS MS SQL.
  • recoverRdsOracleParams[Request, Return Type]— Specifies the parameters to recover AWS RDS Oracle.
  • recoverRdsPostgresDbParams[Request, Return Type]— Specifies the parameters to recover RDS Postgres.
  • recoverRedshiftParams[Request, Return Type]— Specifies the parameters to recover Redshift.
  • siteUuid[Request, Return Type]— Sharepoint site uuid to which this Drive belongs. This is needed for Teams and Groups having subsites, as multiple items across different subsites can be selected for granular recovery.
Deleted properties (1)
  • networkPortGroup[Request, Return Type]— Specifies the object identifier to perform recovery.
New optional properties (2)
  • cloudStorageBucketName[Request]— The Cloud Storage bucket name for MS SQL database recovery.
  • cloudStorageBucketName[Return Type]— The Cloud Storage bucket name for MS SQL database recovery.
GET/data-protect/recoveries
  • Breaking change details
  • New properties added
  • Properties removed
  • New optional properties
Breaking details (3)
  • [Return Type] removed property recoveries[n].acropolisParams.recoverVmParams.acropolisTargetParams.recoveryTargetConfig.newSourceConfig.networkConfig.networkPortGroup
  • [Return Type] type of recoveries[n].azureParams.azureMysqlParams.azureTargetParams.newSourceConfig changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
  • [Return Type] type of recoveries[n].azureParams.azureMysqlParams.snapshots[n].recoverAzureMysqlObjectParams changed — top-level type is still object, but its nested schema shape changed (e.g. a different $ref, or fields added/removed inside it). Check the full schema for the exact difference.
Added properties (28)
  • azureBlobStorageParams[Return Type]— Specifies the parameters to recover Azure Blob Storage .
  • azureCosmosDBCassandraParams[Return Type]— Specifies the parameters to recover Azure CosmosDB Cassandra.
  • azureCosmosDBMongoDBParams[Return Type]— Specifies the parameters to recover Azure CosmosDB MongoDB.
  • azureCosmosDBNoSQLParams[Return Type]— Specifies the parameters to recover Azure CosmosDB NoSQL.
  • azurePostgreSQLParams[Return Type]— Specifies the parameters to recover Azure PostgreSQL.
  • azureSQLDBParams[Return Type]— Specifies the parameters to recover Azure SQL Database.
  • azureSQLMIParams[Return Type]— Specifies the parameters to recover Azure SQL Managed Instance.
  • azureTableAPIParams[Return Type]— Specifies the parameters to recover Azure Table API.
  • azureTableStorageParams[Return Type]— Specifies the parameters to recover Azure Table Storage.
  • bucketAutoCreate[Return Type]— Specifies whether to auto create the Cloud Storage bucket if it does not exist.
  • disableNetwork[Return Type]— Specifies whether the attached network should be left in disabled state. Default is false
  • gcpAlloyDbPostgreSqlParams[Return Type]— Specifies the parameters to recover GCP AlloyDB PostgreSQL database.
  • gcpFirestoreParams[Return Type]— Specifies the parameters to recover GCP Firestore.
  • gcpMySqlParams[Return Type]— Specifies the parameters to recover GCP MySQL database.
  • gcpPostgreSqlParams[Return Type]— Specifies the parameters to recover GCP PostgreSQL database.
  • gcpSqlServerParams[Return Type]— Specifies the parameters to recover GCP SQL Server database.
  • googleSpannerParams[Return Type]— Specifies the parameters to recover Google Spanner.
  • name[Return Type]— Specifies the name of the Recovery.
  • newNetworkConfig[Return Type]— Specifies the new network config parameters to be applied to VMware VMs.
  • nutanixFSParams[Return Type]— Specifies the recovery options specific to NutanixFS environment.
  • postgresParams[Return Type]— Specifies the recovery options specific to Postgres environment.
  • recoverAWSDocumentDBParams[Return Type]— Specifies the parameters to recover AWS DocumentDB.
  • recoverRdsAuroraPostgresDbParams[Return Type]— Specifies the parameters to recover RDS Aurora Postgres.
  • recoverRdsMsSqlParams[Return Type]— Specifies the parameters to recover AWS RDS MS SQL.
  • recoverRdsOracleParams[Return Type]— Specifies the parameters to recover AWS RDS Oracle.
  • recoverRdsPostgresDbParams[Return Type]— Specifies the parameters to recover RDS Postgres.
  • recoverRedshiftParams[Return Type]— Specifies the parameters to recover Redshift.
  • siteUuid[Return Type]— Sharepoint site uuid to which this Drive belongs. This is needed for Teams and Groups having subsites, as multiple items across different subsites can be selected for granular recovery.
Deleted properties (1)
  • networkPortGroup[Return Type]— Specifies the object identifier to perform recovery.
New optional properties (1)
  • cloudStorageBucketName[Return Type]— The Cloud Storage bucket name for MS SQL database recovery.
Compatible (91)
API EndpointWhat ChangedDetails
GET/network/vlans/{vlanInterfaceGroupName}
  • Newly added endpoint
Get vlan
PUT/network/vlans/{vlanInterfaceGroupName}
  • Newly added endpoint
Update vlan
DELETE/network/vlans/{vlanInterfaceGroupName}
  • Newly added endpoint
Delete vlan
POST/principals
  • Newly added endpoint
Add the specified principals for the users or groups created on the Cohesity Cluster.
POST/users/verify-otp
  • Newly added endpoint
Verify the OTP for a user.
GET/users/{sid}/notifications
  • Newly added endpoint
Get task notifications for the given user.
GET/webserver-certificate
  • Newly added endpoint
Get the Server Certificate configured on the Cluster.
PUT/support-user/mfa
  • Newly added endpoint
Stores the updated MFA configuration.
DELETE/ipmi/cluster-users
  • Newly added endpoint
To delete IPMI Users for cluster
GET/network/vlans
  • Newly added endpoint
Get vlans
GET/fortknox-onprem-clusters/precheck-options
  • New properties added
Added properties (1)
  • isNoRemoteClusters[Return Type]— Specifies if the cluster does not have any remote clusters configured.
POST/fortknox-onprem-primary-clusters/connections
  • New properties added
Added properties (1)
  • allEndpointsReachable[Request]— Specifies if all endpoints on Primary Cluster are reachable.
PUT/fortknox-onprem-primary-clusters/{clusterId}/connections
  • New properties added
Added properties (1)
  • allEndpointsReachable[Request]— Specifies if all endpoints on Primary Cluster are reachable.
GET/fortknox-onprem-vault-clusters/precheck-options
  • New properties added
Added properties (1)
  • isNoRemoteClusters[Return Type]— Specifies if the cluster does not have any remote clusters configured.
POST/node/import/signed-csr
  • Privilege name updated
  • New fields that are always included in the response
Privilege name updated

No API contract change for POST. Only the documented privilege name was updated from Unknown Privileges to CLUSTER_MODIFY. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

Now-guaranteed response fields (2)
  • caCertSHA256[Return Type]— SHA of the CA cert that was using to sign the CSR
  • signedCertSHA256[Return Type]— SHA of the accepted complete signed cert
PUT/proxy-servers/{name}
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • address[Return Type]— Specifies address of the proxy. This can be hostname or IP address.
  • port[Return Type]— Specifies port of the proxy.
GET/secret-manager/cert/{environment}/{thumbprint}
  • Privilege name updated
Privilege name updated

No API contract change for GET. Only the documented privilege name was updated from PROTECTION_VIEW to SECRET_MANAGER_CERT_VIEW. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

GET/secret-manager/certificates/{thumbprint}
  • Privilege name updated
Privilege name updated

No API contract change for GET. Only the documented privilege name was updated from PROTECTION_VIEW to SECRET_MANAGER_CERT_VIEW. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

DELETE/secret-manager/certificates/{thumbprint}
  • Privilege name updated
Privilege name updated

No API contract change for DELETE. Only the documented privilege name was updated from PROTECTION_MODIFY to SECRET_MANAGER_CERT_MODIFY. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

PATCH/secret-manager/certificates/{thumbprint}
  • Privilege name updated
Privilege name updated

No API contract change for PATCH. Only the documented privilege name was updated from PROTECTION_MODIFY to SECRET_MANAGER_CERT_MODIFY. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

GET/support-channel-config
  • New properties added
Added properties (2)
  • enableExtension[Return Type]— Specifies if the support channel extension is allowed.
  • extensionDurationHours[Return Type]— Specifies the support channel extension duration in hours.
PUT/support-channel-config
  • New properties added
Added properties (2)
  • enableExtension[Request, Return Type]— Specifies if the support channel extension is allowed.
  • extensionDurationHours[Request, Return Type]— Specifies the support channel extension duration in hours.
GET/support-user/mfa
  • New properties added
Added properties (2)
  • isQuorumManaged[Return Type]— Specifies whether the MFA configuration is managed by quorum.
  • referenceId[Return Type]— Specifies a reference ID of OTP verification, required if mfaCode is not specified
PATCH/support-user/mfa
  • Description updated
  • New properties added
Description changed

Before:

Update MFA configuration for support user.

After:

Update MFA configuration for support user. NOTE: Some functionality of this API is deprecated. It is recommended to use PUT /v2/support-user/mfa for setting MFA type and updating email. This API should be used only for enabling/disabling MFA.

Added properties (2)
  • isQuorumManaged[Return Type]— Specifies whether the MFA configuration is managed by quorum.
  • referenceId[Request, Return Type]— Specifies a reference ID of OTP verification, required if mfaCode is not specified
POST/support-user/verify-totp
  • New properties added
Added properties (3)
  • purpose[Request]— Specifies the purpose of the totp code verification. * DisableMfa - To be used when disabling the MFA. * VerifyOtp (Default) - To be used when verifying OTP.
  • referenceId[Return Type]— Specifies the reference id of the otp verification request. Generated when TOTP is verified for disabling MFA.
  • supportUserPassword[Request]— Specifies the support user password, required for totp verification while disabling MFA.
GET/active-directory-principals
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • name[Return Type]— Specifies the name of the principal which is being added.
  • objectClass[Return Type]— Specifies the type of principal, a user or a group
GET/clusters/software-components
  • New fields that are always included in the response
Now-guaranteed response fields (3)
  • packageName[Return Type]— Name of sub package
  • release[Return Type]— Release Version of sub package.
  • version[Return Type]— Version of sub package.
GET/groups/{sid}
  • New properties added
  • New fields that are always included in the response
Added properties (1)
  • groupType[Return Type]— Specifies the type of group: local, ad, or idp.
Now-guaranteed response fields (1)
  • groupType[Return Type]— Specifies the type of group: local, ad, or idp.
PUT/groups/{sid}
  • New properties added
  • New fields that are always included in the response
Added properties (1)
  • groupType[Return Type]— Specifies the type of group: local, ad, or idp.
Now-guaranteed response fields (1)
  • groupType[Return Type]— Specifies the type of group: local, ad, or idp.
GET/nodes
  • New fields that are always included in the response
Now-guaranteed response fields (23)
  • chassisModel[Return Type]— Chassis model.
  • chassisSerial[Return Type]— Chassis serial number programmed by manufacturer.
  • clusterId[Return Type]— Specifies the Id of the cluster to which the node belongs.
  • cohesityChassisSerial[Return Type]— Chassis serial number programmed by cohesity software.
  • cohesityNodeSerial[Return Type]— Node serial number programmed by cohesity software.
  • cpu[Return Type]— Number of CPUs
  • hostname[Return Type]— Host name of the node reported by the kernel.
  • incarnationId[Return Type]— Specifies the cluster incarnation Id.
  • ipmiIp[Return Type]— Ipmi IpAddress
  • isNodeReachable[Return Type]— Specifies whether the node is reachable or not
  • nodeId[Return Type]— Specifies the Id of the node.
  • nodeModel[Return Type]— Node model.
  • nodeSerial[Return Type]— Node serial number programmed by manufacturer.
  • productModel[Return Type]— Product Model
  • servicesVersionInfo[Return Type]— Specifies the version information of the cohesity services.
  • slotNumber[Return Type]— Slot number of the node in the chassis.
  • softwareVersion[Return Type]— Version of the Cohesity software running on the node.
  • systemMemoryBytes[Return Type]— System Memory in bytes
  • index[Return Type]— Index of the interface as given by 'ip a' command.
  • name[Return Type]— Name of the interface like bond0.
  • lastCommitTime[Return Type]— LastCommitTime of the service.
  • serviceName[Return Type]— Name of the service.
  • serviceVersion[Return Type]— Version of the service.
GET/ntp-servers
  • New properties added
Added properties (1)
  • ntpServerAuthKeyEncryptionAlgorithm[Return Type]— Specifies the Symmetric Key algorithm used for the encryption key.
PUT/ntp-servers
  • New properties added
Added properties (1)
  • ntpServerAuthKeyEncryptionAlgorithm[Request, Return Type]— Specifies the Symmetric Key algorithm used for the encryption key.
POST/proxy-servers
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • address[Return Type]— Specifies address of the proxy. This can be hostname or IP address.
  • port[Return Type]— Specifies port of the proxy.
GET/proxy-servers
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • address[Return Type]— Specifies address of the proxy. This can be hostname or IP address.
  • port[Return Type]— Specifies port of the proxy.
GET/users/{sid}
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • domain[Return Type]— Specifies the domain of the user. For active directories, this is the fully qualified domain name (FQDN). It is 'LOCAL' for local users on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.
  • username[Return Type]— Specifies the username.
PUT/users/{sid}
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • domain[Return Type]— Specifies the domain of the user. For active directories, this is the fully qualified domain name (FQDN). It is 'LOCAL' for local users on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.
  • username[Return Type]— Specifies the username.
GET/clusters/upgrade-checks/{testRunInstanceId}
  • New fields that are always included in the response
Now-guaranteed response fields (11)
  • error[Return Type]— Error message if test results could not be fetched.
  • requestType[Return Type]— Type of the check(preupgrade/postupgrade).
  • resultStatus[Return Type]— Final result (running/pass/fail) of run.
  • testRunInstanceId[Return Type]— Specifies test run instance of upgrade checks.
  • nodeIp[Return Type]— The node ip
  • nodeTestStatus[Return Type]— The healthcheck run status for node
  • testId[Return Type]— The healthcheck test id
  • testKbLink[Return Type]— The kb link for diagnosing test failure
  • testName[Return Type]— The healthcheck test name
  • testOutput[Return Type]— The healthcheck test output
  • testResult[Return Type]— The healthcheck test result
GET/groups
  • New properties added
  • New fields that are always included in the response
Added properties (1)
  • groupType[Return Type]— Specifies the type of group: local, ad, or idp.
Now-guaranteed response fields (1)
  • groupType[Return Type]— Specifies the type of group: local, ad, or idp.
PUT/kms/{id}
  • New properties added
Added properties (1)
  • gcpKmsParams[Request, Return Type]— GCP KMS configuration updatable parameters.
POST/secret-manager/cert/{environment}
  • Privilege name updated
Privilege name updated

No API contract change for POST. Only the documented privilege name was updated from PROTECTION_MODIFY to SECRET_MANAGER_CERT_MODIFY. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

GET/secret-manager/cert/{environment}
  • Privilege name updated
Privilege name updated

No API contract change for GET. Only the documented privilege name was updated from PROTECTION_VIEW to SECRET_MANAGER_CERT_VIEW. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

POST/secret-manager/certificates
  • Privilege name updated
Privilege name updated

No API contract change for POST. Only the documented privilege name was updated from PROTECTION_MODIFY to SECRET_MANAGER_CERT_MODIFY. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

GET/secret-manager/certificates
  • Privilege name updated
Privilege name updated

No API contract change for GET. Only the documented privilege name was updated from PROTECTION_VIEW to SECRET_MANAGER_CERT_VIEW. Clients using the same request body and path should work the same; verify RBAC/permissions if your integration checks privilege names.

GET/users
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • domain[Return Type]— Specifies the domain of the user. For active directories, this is the fully qualified domain name (FQDN). It is 'LOCAL' for local users on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.
  • username[Return Type]— Specifies the username.
GET/clusters/operation-status
  • New fields that are always included in the response
Now-guaranteed response fields (7)
  • errorMessage[Return Type]— Specifies the error message for the operation.
  • status[Return Type]— Specifies the test run status for node.
  • testId[Return Type]— Specifies the test ID.
  • testKbLink[Return Type]— Specifies the kb link for diagnosing test failure.
  • testName[Return Type]— Specifies the test name.
  • testOutput[Return Type]— Specifies the test output message.
  • testResult[Return Type]— Specifies the test result.
GET/clusters/packages
  • New fields that are always included in the response
Now-guaranteed response fields (3)
  • packageName[Return Type]— Name of sub package
  • release[Return Type]— Release Version of sub package.
  • version[Return Type]— Version of sub package.
POST/data-access/snapshots/sessions/{sessionId}/graph-nodes/differences
  • New properties added
Added properties (1)
  • attributeFilter[Request]— Filter string for node attributes. This filter string is environment-specific and interpretable by respective environment only.
POST/kms
  • New properties added
Added properties (1)
  • gcpKmsParams[Request, Return Type]— GCP KMS configuration parameters.
GET/kms
  • New properties added
Added properties (1)
  • gcpKmsParams[Return Type]— IBM KMS configuration response.
GET/storage-domains
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • allowViewAndTemplateCreationInOptimizedSD[Return Type]— Specifies whether creation of views, templates inside throughput-optimized Storage Domains is allowed.
  • throughputOptimizedSDEnabled[Return Type]— Indicates whether throughput-optimized Storage Domains are enabled.
POST/data-access/snapshots/sessions/graph-nodes/query
  • New properties added
Added properties (1)
  • attributeFilter[Request]— Filter string for node attributes. This filter string is environment-specific and interpretable by respective environment only.
PUT/data-protect/objects/{id}/snapshots/{snapshotId}
  • New properties added
Added properties (1)
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/objects/{id}/tree
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/recoveries/directories
  • New properties added
Added properties (1)
  • oneDriveItemMetadata[Return Type]— Info about a onedrive item.
GET/data-protect/snapshots/{snapshotId}
  • New properties added
Added properties (1)
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/sources/{id}
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/fortknox-onprem-primary-clusters/{clusterId}
  • New properties added
Added properties (1)
  • bandwidthLimit[Return Type]— Specifies settings for limiting the data transfer rate between the local and remote Clusters.
PUT/fortknox-onprem-primary-clusters/{clusterId}
  • New properties added
Added properties (1)
  • bandwidthLimit[Return Type]— Specifies settings for limiting the data transfer rate between the local and remote Clusters.
GET/fortknox-onprem-vault-clusters/{clusterId}
  • New properties added
Added properties (1)
  • bandwidthLimit[Return Type]— Specifies settings for limiting the data transfer rate between the local and remote Clusters.
PUT/data-protect/objects/metadata
  • New properties added
  • New optional properties
Added properties (9)
  • azureCosmosDBCassandraParams[Request]— Specifies the entity metadata of azure cosmosdb cassandra entities.
  • azureCosmosDBMongoDBParams[Request]— Specifies the entity metadata of azure cosmosdb mongodb entities.
  • azureCosmosDBNoSQLParams[Request]— Specifies the entity metadata of azure cosmosdb nosql entities.
  • azurePostgreSQLParams[Request]— Specifies the entity metadata of azure postgresql entities.
  • azureSqlDBParams[Request]— Specifies the entity metadata of azure SQL DB entities.
  • azureSqlMIParams[Request]— Specifies the entity metadata of azure SQL MI entities.
  • documentDBMetadata[Request]— Specifies the entity metadata of aws documentdb entities.
  • documentDBParams[Request]— Specifies the entity metadata of aws documentdb entities.
  • gcpParams[Request]— Specifies the entity metadata of GCP entities.
New optional properties (1)
  • username[Request]— Specifies the username to access target entity.
GET/data-protect/objects/{id}/snapshots
  • New properties added
Added properties (1)
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/objects/{objectId}/indexed-objects/snapshots
  • New properties added
Added properties (1)
  • indexedObjectHash[Return Type]— Specifies the hash of the indexed object. This is currently only applicable for snapshots of the file.
GET/data-protect/objects/{objectId}/protection-groups/{protectionGroupId}/indexed-objects/snapshots
  • New properties added
Added properties (1)
  • indexedObjectHash[Return Type]— Specifies the hash of the indexed object. This is currently only applicable for snapshots of the file.
GET/data-protect/objects/{sourceId}/metadata
  • New properties added
  • New optional properties
Added properties (9)
  • azureCosmosDBCassandraParams[Return Type]— Specifies the entity metadata of azure cosmosdb cassandra entities.
  • azureCosmosDBMongoDBParams[Return Type]— Specifies the entity metadata of azure cosmosdb mongodb entities.
  • azureCosmosDBNoSQLParams[Return Type]— Specifies the entity metadata of azure cosmosdb nosql entities.
  • azurePostgreSQLParams[Return Type]— Specifies the entity metadata of azure postgresql entities.
  • azureSqlDBParams[Return Type]— Specifies the entity metadata of azure SQL DB entities.
  • azureSqlMIParams[Return Type]— Specifies the entity metadata of azure SQL MI entities.
  • documentDBMetadata[Return Type]— Specifies the entity metadata of aws documentdb entities.
  • documentDBParams[Return Type]— Specifies the entity metadata of aws documentdb entities.
  • gcpParams[Return Type]— Specifies the entity metadata of GCP entities.
New optional properties (1)
  • username[Return Type]— Specifies the username to access target entity.
GET/data-protect/search/objects
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/sources
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/sources/registrations/{id}
  • New properties added
  • New fields that are always included in the response
Added properties (4)
  • name[Return Type]— The user specified name for this source.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
  • postgresParams[Return Type]— Specifies the object to hold username and password.
  • useCases[Return Type]— The use cases for which the source is to be registered.
Now-guaranteed response fields (1)
  • entityId[Return Type]— Specifies the entity id of the source. The source can a non-root entity.
PATCH/data-protect/sources/registrations/{id}
  • New properties added
  • New fields that are always included in the response
Added properties (4)
  • name[Return Type]— The user specified name for this source.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
  • postgresParams[Return Type]— Specifies the object to hold username and password.
  • useCases[Return Type]— The use cases for which the source is to be registered.
Now-guaranteed response fields (1)
  • entityId[Return Type]— Specifies the entity id of the source. The source can a non-root entity.
GET/data-protect/sources/{vCenterId}/resource-pools/{id}/entities
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
POST/fortknox-onprem-primary-clusters
  • New properties added
Added properties (1)
  • bandwidthLimit[Request, Return Type]— Specifies settings for limiting the data transfer rate between the local and remote Clusters.
GET/fortknox-onprem-primary-clusters
  • New properties added
Added properties (1)
  • bandwidthLimit[Return Type]— Specifies settings for limiting the data transfer rate between the local and remote Clusters.
GET/fortknox-onprem-vault-clusters
  • New properties added
Added properties (1)
  • bandwidthLimit[Return Type]— Specifies settings for limiting the data transfer rate between the local and remote Clusters.
GET/data-protect/external-targets/settings
  • New properties added
  • New optional properties
Added properties (3)
  • authenticationMethod[Return Type]— Specifies the cloud category parameter which are specific to AWS related External Targets.
  • c2sType[Return Type]— Specifies C2S type of the External Target C2S or SC2S. C2S is for Top secrect Cloud Services. In case the type is not provided, default value is assumed as C2S.
  • wormLockInComplianceMode[Return Type]— Whether archives to this vault should use compliance mode when adding data locks to objects.
New optional properties (2)
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
GET/data-protect/external-targets/{id}
  • New properties added
  • New optional properties
Added properties (3)
  • authenticationMethod[Return Type]— Specifies the cloud category parameter which are specific to AWS related External Targets.
  • c2sType[Return Type]— Specifies C2S type of the External Target C2S or SC2S. C2S is for Top secrect Cloud Services. In case the type is not provided, default value is assumed as C2S.
  • wormLockInComplianceMode[Return Type]— Whether archives to this vault should use compliance mode when adding data locks to objects.
New optional properties (2)
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
PUT/data-protect/external-targets/{id}
  • New properties added
  • New optional properties
Added properties (3)
  • authenticationMethod[Request, Return Type]— Specifies the cloud category parameter which are specific to AWS related External Targets.
  • c2sType[Request, Return Type]— Specifies C2S type of the External Target C2S or SC2S. C2S is for Top secrect Cloud Services. In case the type is not provided, default value is assumed as C2S.
  • wormLockInComplianceMode[Request, Return Type]— Whether archives to this vault should use compliance mode when adding data locks to objects.
New optional properties (4)
  • clientEmailAddress[Request]— Specifies the client email address of the external target.
  • clientEmailAddress[Request]— Specifies the client email address of the external target.
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
GET/data-protect/objects/{id}
  • New properties added
Added properties (1)
  • nutanixFSParams[Return Type]
POST/data-protect/protected-objects
  • New properties added
Added properties (1)
  • nutanixFSParams[Request]
GET/data-protect/recoveries/virtual-disks
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/search/protected-objects
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/sources/application-servers
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/sources/registrations
  • New properties added
  • New fields that are always included in the response
Added properties (4)
  • name[Return Type]— The user specified name for this source.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
  • postgresParams[Return Type]— Specifies the object to hold username and password.
  • useCases[Return Type]— The use cases for which the source is to be registered.
Now-guaranteed response fields (1)
  • entityId[Return Type]— Specifies the entity id of the source. The source can a non-root entity.
POST/data-protect/external-targets
  • New properties added
  • New optional properties
Added properties (3)
  • authenticationMethod[Request, Return Type]— Specifies the cloud category parameter which are specific to AWS related External Targets.
  • c2sType[Request, Return Type]— Specifies C2S type of the External Target C2S or SC2S. C2S is for Top secrect Cloud Services. In case the type is not provided, default value is assumed as C2S.
  • wormLockInComplianceMode[Request, Return Type]— Whether archives to this vault should use compliance mode when adding data locks to objects.
New optional properties (4)
  • clientEmailAddress[Request]— Specifies the client email address of the external target.
  • clientEmailAddress[Request]— Specifies the client email address of the external target.
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
GET/data-protect/external-targets
  • New properties added
  • New optional properties
Added properties (3)
  • authenticationMethod[Return Type]— Specifies the cloud category parameter which are specific to AWS related External Targets.
  • c2sType[Return Type]— Specifies C2S type of the External Target C2S or SC2S. C2S is for Top secrect Cloud Services. In case the type is not provided, default value is assumed as C2S.
  • wormLockInComplianceMode[Return Type]— Whether archives to this vault should use compliance mode when adding data locks to objects.
New optional properties (2)
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
  • clientEmailAddress[Return Type]— Specifies the client email address of the external target.
GET/data-protect/objects
  • New properties added
Added properties (1)
  • nutanixFSParams[Return Type]
GET/data-protect/policies/{id}/summary
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the already added cloud spin target.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
PUT/data-protect/protected-objects/{id}
  • New properties added
Added properties (1)
  • nutanixFSParams[Request, Return Type]
GET/data-protect/protection-groups/{id}
  • New properties added
  • New fields that are always included in the response
Added properties (27)
  • auroraPostgresDbProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS Aurora Postgres DB related Protection Groups.
  • blobStorageProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Blob Storage workload. Objects must be specified.
  • bucketAutoCreate[Return Type]— Specifies whether to auto create the Cloud Storage bucket if it doesn't exist.
  • cassandraProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB Cassandra workload. Objects must be specified.
  • cosmosDBNoSQLProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB NoSQL workload. Objects must be specified.
  • cosmosdbmongodbProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB MongoDB workload. Objects must be specified.
  • diskExclusionParams[Return Type]— Specifies parameters to exclude Azure Disks attached to Azure VM at job or object level. A disk satisfying any of this criteria will be excluded from the backup job.
  • documentDBProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS DocumentDB related Protection Groups.
  • firestoreProtectionTypeParams[Return Type]— Specifies the parameters which are specific to GCP Firestore related Protection Groups.
  • mySqlProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Google MySQL related Protection Groups.
  • nfsProtocol[Return Type]— Specifies the preferred protocol to use if this device supports multiple protocols.
  • nutanixFSParams[Return Type]— Specifies the parameters which are specific to Nutanix FS related Protection Groups.
  • oracleProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS RDS Oracle related Protection Groups.
  • postgreSqlProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Google PostgreSQL related Protection Groups.
  • postgresParams[Return Type]— Specifies parameters related to the Postgres Protection group.
  • postgresqlProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure PostgreSQL workload. Objects must be specified.
  • protectionType[Return Type]— Specifies the protection type of the object if any.
  • rdsMsSqlProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS RDS MS SQL related Protection Groups.
  • rdsPostgresDbProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS RDS Postgres DB related Protection Groups.
  • redshiftProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS Redshift related Protection Groups.
  • spannerProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Google Spanner related Protection Groups.
  • sqlDbProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure SQL DB workload. Objects must be specified.
  • sqlMiProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure SQL MI workload. Objects must be specified.
  • sqlServerProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Google SQL Server related Protection Groups.
  • tableApiProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Table API workload. Objects must be specified.
  • tableStorageProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Table Storage workload. Objects must be specified.
  • teamsProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Office 365 Teams related Protection Groups.
Now-guaranteed response fields (1)
  • cloudStorageBucketName[Return Type]— The Cloud Storage bucket name for Oracle database backup.
POST/data-protect/search/indexed-objects
  • New properties added
Added properties (6)
  • hash[Return Type]— Specifies hash value for this file.
  • hashes[Request]— Specifies a list of the source hashes. Only files matches with these hashes will be returned. Only supported for adapters supported by ThreatHunting.
  • modifiedTimeUsecs[Return Type]— Specifies modification time for this file in usecs.
  • name[Return Type]— Specifies the name of the object.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
  • subsiteItem[Return Type]— Specifies a M365 Subsite item. Currently used for subsites of teams/group root site's subsites.
POST/data-protect/snapshots/restore-points
  • New properties added
Added properties (2)
  • name[Return Type]— Specifies the name of the already added cloud spin target.
  • nutanixFSParams[Return Type]— Specifies the common parameters for Nutanix FS objects.
GET/data-protect/protection-groups
  • New properties added
  • New fields that are always included in the response
Added properties (27)
  • auroraPostgresDbProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS Aurora Postgres DB related Protection Groups.
  • blobStorageProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Blob Storage workload. Objects must be specified.
  • bucketAutoCreate[Return Type]— Specifies whether to auto create the Cloud Storage bucket if it doesn't exist.
  • cassandraProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB Cassandra workload. Objects must be specified.
  • cosmosDBNoSQLProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB NoSQL workload. Objects must be specified.
  • cosmosdbmongodbProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure CosmosDB MongoDB workload. Objects must be specified.
  • diskExclusionParams[Return Type]— Specifies parameters to exclude Azure Disks attached to Azure VM at job or object level. A disk satisfying any of this criteria will be excluded from the backup job.
  • documentDBProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS DocumentDB related Protection Groups.
  • firestoreProtectionTypeParams[Return Type]— Specifies the parameters which are specific to GCP Firestore related Protection Groups.
  • mySqlProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Google MySQL related Protection Groups.
  • nfsProtocol[Return Type]— Specifies the preferred protocol to use if this device supports multiple protocols.
  • nutanixFSParams[Return Type]— Specifies the parameters which are specific to Nutanix FS related Protection Groups.
  • oracleProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS RDS Oracle related Protection Groups.
  • postgreSqlProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Google PostgreSQL related Protection Groups.
  • postgresParams[Return Type]— Specifies parameters related to the Postgres Protection group.
  • postgresqlProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure PostgreSQL workload. Objects must be specified.
  • protectionType[Return Type]— Specifies the protection type of the object if any.
  • rdsMsSqlProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS RDS MS SQL related Protection Groups.
  • rdsPostgresDbProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS RDS Postgres DB related Protection Groups.
  • redshiftProtectionTypeParams[Return Type]— Specifies the parameters which are specific to AWS Redshift related Protection Groups.
  • spannerProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Google Spanner related Protection Groups.
  • sqlDbProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure SQL DB workload. Objects must be specified.
  • sqlMiProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure SQL MI workload. Objects must be specified.
  • sqlServerProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Google SQL Server related Protection Groups.
  • tableApiProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Table API workload. Objects must be specified.
  • tableStorageProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Azure related Protection Groups for Azure Table Storage workload. Objects must be specified.
  • teamsProtectionTypeParams[Return Type]— Specifies the parameters which are specific to Office 365 Teams related Protection Groups.
Now-guaranteed response fields (1)
  • cloudStorageBucketName[Return Type]— The Cloud Storage bucket name for Oracle database backup.
GET/tenants/{id}/assignments
  • New fields that are always included in the response
Now-guaranteed response fields (2)
  • allowViewAndTemplateCreationInOptimizedSD[Return Type]— Specifies whether creation of views, templates inside throughput-optimized Storage Domains is allowed.
  • throughputOptimizedSDEnabled[Return Type]— Indicates whether throughput-optimized Storage Domains are enabled.