Cohesity

  • API Docs
  • GitHub
  • Marketplace
  • Blog

API CHANGELOG

The following section lists the differences between

* 6.6.0d_ent_p7_v1_cohesity_api
* 6.8_spl_verizon_v1_cohesity_api

Incompatible Changes

New Additions

TypeAdded Changes
Required parameter(s)/public/remoteVaults/cloudDomainMigration (get) - Required param migrationUid added
Required parameter(s)/public/remoteVaults/cloudDomainMigration (post) - Required param body added

Deletions

TypeDeleted changes
API response(s)/public/remoteVaults/cloudDomainMigration (post) - Response 200 deleted
A definitionAccountEntitlement
A definitionLinks
A definitionPVCData
Object property(ies)definitions/AgentDeploymentStatusResponse - certificateExpiryTimeUsecs, certificateIssuer, certificateStatus
Object property(ies)definitions/AlertingConfig - raiseObjectLevelFailureAlertAfterEachAttempt, raiseObjectLevelFailureAlertAfterLastAttempt
Object property(ies)definitions/AlertingPolicyProto - raiseObjectLevelFailureAlertAfterEachAttempt, raiseObjectLevelFailureAlertAfterLastAttempt
Object property(ies)allInternalReplicationViewsDeleted
Object property(ies)QueueDurationUsecs
Object property(ies)aesEncryptionMode
Object property(ies)frequency
Object property(ies)definitions/Domain - description, enabled, id, links, name
Object property(ies)enableEncryption
Object property(ies)definitions/Entity - datamoverAgentVersion, datamoverUpgradability, pvcDataVec, veleroUpgradability, veleroVersion
Object property(ies)algorithm
Object property(ies)IpFamily
Object property(ies)definitions/KubernetesProtectionSource - datamoverUpgradability, veleroUpgradability
Object property(ies)definitions/LastProtectionRunStats - numObjectsCancelled, numObjectsInProgress, numObjectsSuccessful
Object property(ies)definitions/LastProtectionRunStatsByEnv - numObjectsCancelled, numObjectsInProgress, numObjectsSuccessful
Object property(ies)MigrateCloneParams
Object property(ies)includeInRestore
Object property(ies)ignorableErrorsInErrorDb
Object property(ies)definitions/ProtectionJobRequestBody - ignorableErrorsInErrorDb, modificationTimeUsecs
Object property(ies)QueueDurationUsecs
Object property(ies)isCascadedReplicationPolicy
Object property(ies)definitions/RegisterProtectionSourceParameters - connectionId, reRegister
Object property(ies)definitions/RemoteCluster - effectiveAesEncryptionMode, supportedAesEncryptionMode
Object property(ies)entitlements
Object property(ies)excludeUsersWithinAlertThreshold
Object property(ies)definitions/SnapshotArchivalCopyPolicy - backupRunType, sourceClusterId
Object property(ies)backupRunType
Object property(ies)definitions/SnapshotReplicationCopyPolicy - backupRunType, sourceClusterId
Object property(ies)backupType
Object property(ies)attemptNum
Object property(ies)OverwritePolicy
Object property(ies)aesEncryptionMode
Object property(ies)definitions/UpdateProtectionSourceParameters - connectionId, reRegister
Object property(ies)OracleOptions
Object property(ies)lastKeyRotationTimestampMsecs

Modifications

TypeModified Changes
DataType of the objectdefinitions/TenantDeletionInfo - Properties category, state-Data type turn from integer to string

Compatible Changes

New Additions

TypeAdded Changes
Optional parameter(s)/public/kmsConfig (get) - includeRpaasKms
Optional parameter(s)/public/protectionSources (get) - getTeamsChannels, excludeKubernetesTypes, includeObjectProtectionInfo
Optional parameter(s)/public/remoteClusters (get) - verifyReverseRegistration
API response(s)/public/remoteVaults/cloudDomainMigration (post) - Response 204 added
Optional parameter(s)/public/statistics/timeSeriesStats (get) - prorateDataPoints
Optional parameter(s)/public/stats/protectionRuns/lastRun (get) - fromTimeUsecs, toTimeUsecs
Optional parameter(s)/public/stats/views (get) - lastHours, protocol
Optional parameter(s)/public/vaults (get) - globalId
An API URL/public/kmsStatus
An API URL/public/licenseAgreement
Optional property(ies)definitions/AdObjectsRestoreStatus - numObjectsRunning
Optional property(ies)definitions/AdditionalConnectorParams - maxVmwareHttpSessions, o365EmulatorEntityInfo, registeredEntitySfdcParams, useGetSearchableMailboxesApi
Optional property(ies)definitions/AgentInformation - fileCbtInfo, volCbtInfo
Optional property(ies)definitions/Alert - regionId
Optional property(ies)definitions/AppInstance - deploymentParameters, exposedNodePorts, uiClusterIPSvcAddr, uiClusterIPSvcPort, upgradableNewerVersionPresent
Optional property(ies)definitions/AppMetadata - deploymentParameters
Optional property(ies)definitions/ArchivalTarget - ownershipContext, usageType
Optional property(ies)definitions/AwsParams - customTagList
Optional property(ies)definitions/AzureCloudCredentials - isWormEnabled
Optional property(ies)definitions/BackupJobProto - dataTransferInfo, isSourcePausedMap, logBackupSlaTimeMins, pauseInBlackoutWindow, performBrickBasedDedup, skipRigelForBackup, storageArraySnapshot
Optional property(ies)definitions/BackupSourceParams - hypervParams, sfdcParams, sharepointParams
Optional property(ies)definitions/BackupSourceStats - queueDurationUsecs
Optional property(ies)definitions/BasicClusterInfo - clusterDomains
Optional property(ies)definitions/CassandraBackupJobParams - graphHandlingEnabled
Optional property(ies)definitions/CassandraRecoverJobParams - graphHandlingEnabled
Optional property(ies)definitions/CloneViewRequest - enableMetadataAccelerator
Optional property(ies)definitions/CloudDeployInfoProto - warnings
Optional property(ies)definitions/Cluster - clusterSize, hardwareEncryptionEnabled, isAthenaSubnetClash, trustDomain
Optional property(ies)definitions/ClusterConfigProto_Vault_CloudProperties_AzureProperties - enableLambdaBasedGc, lambdaFunctionVersion, wormEnabled
Optional property(ies)definitions/ClusterConfigProto_Vault_CloudTierInfo - honorTierInfo
Optional property(ies)definitions/ConnectorParameters - connectorGroupId
Optional property(ies)definitions/ConnectorParams - connectorGroupId, networkRealmInfoVec
Optional property(ies)definitions/CreateCloudClusterParameters - clusterSize
Optional property(ies)definitions/CreatePhysicalClusterParameters - trustDomain
Optional property(ies)definitions/CreateRemoteVaultSearchJobParameters - JobUids, clusterId
Optional property(ies)definitions/CreateViewRequest - enableMetadataAccelerator, s3FolderSupportEnabled
Optional property(ies)definitions/CreateVirtualClusterParameters - trustDomain
Optional property(ies)definitions/DataUsageStats - dataInBytesPrev, dataInBytesPrevTimestampUsec, dataWrittenBytesPrev, dataWrittenBytesPrevTimestampUsec, localTierResiliencyImpactBytesPrev, localTierResiliencyImpactBytesPrevTimestampUsec, numDirectories, numDirectoriesPrev, numFiles, numFilesPrev
Optional property(ies)definitions/DeployVMsToAWSParams - customTagVec
Optional property(ies)definitions/DeployVMsToAzureParams - dataTransferInfo
Optional property(ies)definitions/Domain - domainName, trustedDomains
A description/definitions/Domain/ - Description added: Specifies a domain and its trusted domains.
Optional property(ies)definitions/EBSVolumeExclusionParams - rawQuery, tagParamsVec
Optional property(ies)definitions/EbsVolumeInfo - tags
Optional property(ies)definitions/EncryptionConfiguration - enableHardwareEncryption, enableSoftwareEncryption
Optional property(ies)definitions/Entity - namespace
Optional property(ies)definitions/EntityPermissionInformation - isRegisteredBySp, registeringTenantId
Optional property(ies)definitions/EnvBackupParams - sfdcBackupJobParams
Optional property(ies)definitions/FileStatInfo - backupSourceInodeId
Optional property(ies)definitions/FileStubbingParams - enableChecksumVerification
Optional property(ies)definitions/GranularityBucket - exactDates
Optional property(ies)definitions/IdpUserInfo - groupSids, isFloatingUser
Optional property(ies)definitions/IoPreferentialTier - cloudChunkRepoIOPreferentialTier
Optional property(ies)definitions/IpUnconfig - ipFamily
Optional property(ies)definitions/KmsConfigurationResponse - ownershipContext, usageType
Optional property(ies)definitions/KmsCreateRequestParameters - ownershipContext, usageType
Optional property(ies)definitions/KubernetesEnvParams - vlanParams
Optional property(ies)definitions/LaunchAppInstance - deploymentParameters
Optional property(ies)definitions/NasBackupParams - modifySourcePermissions
Optional property(ies)definitions/NasCredentials - kerberosRealmName, nfsSecurityType, nfsVersionNumber
Optional property(ies)definitions/NetappProtectionSource - licenseTypes, versionTuple
Optional property(ies)definitions/NetappVolumeInfo - extendedStyle
Optional property(ies)definitions/NoSqlBackupJobParams - immediateAncestorMap
Optional property(ies)definitions/Node - inMaintenanceMode, removalProgressList, servicesAckedList, servicesNotAcked, servicesNotAckedList
Optional property(ies)definitions/NodePort - serviceName
Optional property(ies)definitions/NodeStatusResult - inMaintenanceMode, removalProgressList
Optional property(ies)definitions/O365BackupEnvParams - teamsBackupParams
Optional property(ies)definitions/Office365ProtectionSource - teamInfo
Optional property(ies)definitions/Office365UserInfo - isMailboxEnabled, isOneDriveEnabled, mailboxType
Optional property(ies)definitions/OldSyslogServer - isAlertAuditingEnabled
Optional property(ies)definitions/OracleUpdateRestoreTaskOptions - migrateCloneParams
Optional property(ies)definitions/PerformRestoreJobStateProto - restoreJobUid, skipRigelForRestore
Optional property(ies)definitions/PerformRestoreJobStateProto_RestoreTask - preprocessingError
Optional property(ies)definitions/PerformRestoreTaskStateProto - isMultiStageRestore, multiStageRestoreTaskState, restoredDataStorageDomainId, sfdcRecoverJobParams, skipRigelForRestore
Optional property(ies)definitions/PhysicalFileBackupParams_GlobalIncludeExclude - fsExclude
Optional property(ies)definitions/PhysicalProtectionSource - clusterSourceType
Optional property(ies)definitions/PodMetadata_VolumeInfo - storageClass
Optional property(ies)definitions/PrivilegeInfo - isSaaSOnly
Optional property(ies)definitions/ProtectionJob - logProtectionSlaTimeMins, performBrickBasedDedup
Optional property(ies)definitions/ProtectionJobRequestBody - logProtectionSlaTimeMins, performBrickBasedDedup
Optional property(ies)definitions/ProtectionJobRunStats - queueDurationUsecs
Optional property(ies)definitions/ProtectionPolicy - numSecsToKeep, storageArraySnapshotSchedulingPolicy
Optional property(ies)definitions/ProtectionPolicyRequest - numSecsToKeep, storageArraySnapshotSchedulingPolicy
Optional property(ies)definitions/ProtectionSource - connectionId, connectorGroupId, sfdcProtectionSource
Optional property(ies)definitions/ProtectionSourceNode - objectProtectionInfo
Optional property(ies)definitions/RegisterProtectionSourceParameters - IsStorageArraySnapshotEnabled, office365ServiceAccountCredentialsList, useExistingCredentials
Optional property(ies)definitions/RegisterRemoteCluster - reverseRegisted
Optional property(ies)definitions/RegisteredSourceInfo - isStorageArraySnapshotEnabled, o365Params, office365ServiceAccountCredentialsList, progressMonitorPath, userMessages
Optional property(ies)definitions/RemoteCluster - reverseRegisted
Optional property(ies)definitions/RemoteVaultRestoreTaskStatus - vaultId, vaultName
Optional property(ies)definitions/RestoreFilesParams - destinationEpUuid, glacierFlrRestoreOption, isSourceInitiatedRestore, objectstoreConfigName, s3Viewbackupproperties, sourceSnapshotName, viewId, viewName
Optional property(ies)definitions/RestoreHyperVVMParams - useSmbService
Optional property(ies)definitions/RestoreInfoProto_RestoreEntity - restoredViewName, totalBytesRestored
Optional property(ies)definitions/RestoreO365TeamsParams - targetChannel
Optional property(ies)definitions/RestoreO365TeamsParams_MSTeamInfo - sourceChannelVec
Optional property(ies)definitions/RestoreObject - backupType, restoreVappInfo, sfdcRecoverParams
Optional property(ies)definitions/RestoreOracleAppObjectParams - attemptCompleteRecovery, oracleArchiveLogRestoreInfo, oracleRecoveryValidationInfo, restoreSpfileOrPfileInfo, rollForwardLogPathVec, rollForwardTimeMsecs, skipCloneNid, useScnForRestore
Optional property(ies)definitions/RestoreOracleAppObjectParams_AlternateLocationParams - newnameClause, nofilenamecheck
A description/definitions/RestoreOutlookParams/properties/targetFolderPath/ - Description added: User will type the target folder path. This will always be specified (whether target_mailbox is original mailbox or alternate). If multiple folders are selected, they will all be restored to this folder. The appropriate hierarchy along with the folder names will be preserved.
Optional property(ies)definitions/RestoreOutlookParams - skipMbxPermitForPst
Optional property(ies)definitions/RestoreSiteParams - targetFolderPathPrefix
Optional property(ies)definitions/RestoreTaskStateBaseProto - preprocessingError, taskUid
Optional property(ies)definitions/RestoreVMwareVMParams - isOnPremDeploy
Optional property(ies)definitions/RestoredFileInfo - inodeNumber
Optional property(ies)definitions/RetrieveArchiveInfo_RetrievedEntity - uptierExpiryTimestampUsecs
Optional property(ies)definitions/RetrieveArchiveTaskStateProto - glacierFlrRestoreOption, isUptierRestoreJob
Optional property(ies)definitions/Route - advmss
Optional property(ies)definitions/S3BucketConfigProto - bucketPolicy, enableObjStoreAccess, initClusterId, initClusterIncarnationId, ownershipControls
Optional property(ies)definitions/S3ViewBackupProperties - snapshotPrefixName, viewId
Optional property(ies)definitions/SalesforceAccountInfo - heliosAccessGrantStatus, isDGaaSUser, isDRaaSUser, isRPaaSUser
Optional property(ies)definitions/SchedulingPolicyProto - dateSchedule, yearlySchedule
Optional property(ies)definitions/SchedulingPolicyProto_MonthlySchedule - dayOfMonth
Optional property(ies)definitions/SnapshotInfoProto - reacquirePermit
Optional property(ies)definitions/SnapshotTarget - onpremDeployTarget
Optional property(ies)definitions/SqlBackupJobParams - logBackupNumStreams, logBackupWithClause
Optional property(ies)definitions/SqlProtectionSource - isEncrypted
Optional property(ies)definitions/SqlRestoreParameters - overwritePolicy
Optional property(ies)definitions/StorageStats - viewBackupLogicalUsageBytes, viewBackupPhysicalUsageBytes
Optional property(ies)definitions/TaskNotification - agentUpgradeTask
Optional property(ies)definitions/ThrottlingConfiguration - throttlingWindows
Optional property(ies)definitions/ThrottlingPolicyParameters - storageArraySnapshotConfig
Optional property(ies)definitions/UdaBackupJobParams - backupJobArgumentsMap, entitySupport
Optional property(ies)definitions/UdaConnectParams - credentials, sourceRegistrationArguments
Optional property(ies)definitions/UdaObjects - id
Optional property(ies)definitions/UdaRecoverJobParams - restoreJobArgumentsMap, sourceArgumentsMap, sourceType
Optional property(ies)definitions/UdaRestoreObject - entityId
Optional property(ies)definitions/UdaSourceCapabilities - dynamicConfig, entitySupport
Optional property(ies)definitions/UpdateProtectionJobRun - runType
Optional property(ies)definitions/UpdateProtectionSourceParameters - IsStorageArraySnapshotEnabled, office365ServiceAccountCredentialsList, useExistingCredentials
Optional property(ies)definitions/UpdateRestoreTaskParams - childRestoreTaskIds, options, oracleOptions
Optional property(ies)definitions/UpdateViewParam - enableMetadataAccelerator
Optional property(ies)definitions/User - allowDsoModify, isAccountMfaEnabled, subscriptionInfo, tenantAccesses
Optional property(ies)definitions/UserParameters - tenantAccesses
Optional property(ies)definitions/VMwareBackupEnvParams - vappsToVmsList
Optional property(ies)definitions/Vault - cloudDomainList, globalId, vaultOwnership, viewBoxName
Optional property(ies)definitions/View - enableMetadataAccelerator, intent, s3FolderSupportEnabled
Optional property(ies)definitions/ViewBox - cloudDomainId, vaultId
Optional property(ies)definitions/ViewStatInfo - stats
Optional property(ies)definitions/WormRetentionProto - enableWormOnExternalTarget
A definitionAgentUpgradeTaskInfo
A definitionAuroraClusterInfo
A definitionBackupJobProto_IsSourcePausedMapEntry
A definitionBucketOwnershipControls
A definitionBucketPolicy
A definitionCbtInfo
A definitionCloudDomainList
A definitionCloudDomainMigrationQueryResult
A definitionCommonJobInfo
A definitionComponentRemovalProgress
A definitionCondition
A definitionConditionKeyValues
A definitionCondition_ConditionKeyValuesMapEntry
A definitionCreateCloudDomainMigrationParameters
A definitionCustomTag
A definitionCustomTagParams
A definitionDataGovernanceInfo
A definitionDataProtectInfo
A definitionDataTransferInfo
A definitionDataTransferInfo_PrivateNetworkInfo
A definitionDateTime
A definitionDayTime
A definitionDayTimeWindow
A definitionDeployVMsToOnPremParams
A definitionEBSVolumeExclusionParams_Tag
A definitionEBSVolumeExclusionParams_TagParams
A definitionEBSVolumeTag
A definitionFeatureFlag
A definitionGranularityBucket_ExactDatesInfo
A definitionHyperVBackupSourceParams
A definitionKMSStatusResponse
A definitionM365TeamsChannelInfo
A definitionMultiStageRestoreFinalizeActionParams
A definitionMultiStageRestoreTaskStateProto
A definitionNetappVersionTuple
A definitionNetworkRealmInfo
A definitionNoSqlBackupJobParams_ImmediateAncestorMapEntry
A definitionO365ConnectParams
A definitionObjectLevelParams
A definitionObjectProtectionInfo
A definitionObjectsDiscoveryParams
A definitionOffice365TeamInfo
A definitionOnPremDeployTarget
A definitionOracleArchiveLogInfo
A definitionOracleArchiveLogInfo_OracleArchiveLogRange
A definitionOracleArchiveLogInfo_OracleArchiveLogRange_RangeAttributes
A definitionOracleRecoveryValidationInfo
A definitionOwnershipControlsRule
A definitionRansomwareInfo
A definitionRegisteredEntitySfdcParams
A definitionRestoreO365TeamsParams_SourceChannel
A definitionRestoreO365TeamsParams_TargetChannel
A definitionRestoreSpfileOrPfileInfo
A definitionRestoreVappInfo
A definitionS3BucketInfo
A definitionSchedulingPolicyProto_DateSchedule
A definitionSchedulingPolicyProto_YearlySchedule
A definitionSfdcBackupJobParams
A definitionSfdcBackupSourceParamsProto
A definitionSfdcObject
A definitionSfdcOrg
A definitionSfdcProtectionSource
A definitionSfdcRecoverJobParams
A definitionSfdcRecoverParams
A definitionSfdcRestoreObject
A definitionSfdcRestoreObjectParams
A definitionSharepointBackupSourceParams
A definitionSiteContinuityInfo
A definitionStatement
A definitionStorageArraySnapshotConfigParams
A definitionStorageArraySnapshotMaxSnapshotConfigParams
A definitionStorageArraySnapshotMaxSpaceConfigParams
A definitionStorageArraySnapshotThrottlingPolicy
A definitionSubscriptionInfo
A definitionTeamsBackupEnvParams
A definitionTenantAccess
A definitionThrottlingWindow
A definitionTieringInfo
A definitionUdaBackupJobParams_BackupJobArgumentsMapEntry
A definitionUdaCustomArgument
A definitionUdaRecoverJobParams_RestoreJobArgumentsMapEntry
A definitionUdaRecoverJobParams_SourceArgumentsMapEntry
A definitionUpdateRestoreTaskOptions
A definitionUsersDiscoveryParams
A definitionVMwareBackupEnvParams_VAppChildVMsList
A definitionViewIntent
A definitionViewStatsInLastHours
A definitionViewStatsInfo

Deletions

TypeDeleted Changes
Parameter(s)/public/apps (post) - Param appUrl deleted
Parameter(s)/public/protectionRuns - filterByEndTime, filterByCopyTaskEndTime, copyRunTypes, onlyIncludeSuccessfulCopyRuns
Parameter(s)/public/protectionSources - ExcludeKubernetesTypes, IncludeObjectProtectionInfo, getTeamsChannels, excludeKubernetesTypes, includeObjectProtectionInfo
Parameter(s)/public/protectionSources/protectedObjects (get) - Param requestInitiatorType deleted
Parameter(s)/public/restore/files - startTimeUsecs, endTimeUsecs
  • Incompatible Changes
    • New Additions
    • Deletions
    • Modifications
  • Compatible Changes
    • New Additions
    • Deletions
Copyright © 2024 Cohesity, Inc. All Rights Reserved.
Privacy Policy | Legal | cohesity.com | 1-855-9COHESITY