openapi: 3.2.0
info:
description: Cohesity API provides a RESTful interface to access the various data management operations on Cohesity cluster and Helios.
title: Cohesity REST Protected Objects API
version: '2.0'
servers:
- url: /v2
tags:
- name: Protected Objects
paths:
/data-protect/protected-objects:
post:
description: Create Protect Objects Backup.
tags:
- Protected Objects
summary: Create Object Backup
operationId: ProtectObjectsOfAnyType
responses:
'207':
$ref: '#/components/responses/CreateProtectedObjectsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProtectedObjectsRequest'
description: Specifies the parameters to protect objects.
required: true
/data-protect/protected-objects/actions:
post:
description: Perform actions on Protected Objects.
tags:
- Protected Objects
summary: Perform Actions on Protect Objects
operationId: PerformActionOnProtectObjects
responses:
'202':
$ref: '#/components/responses/ProtectedObjectActionResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProtectdObjectsActionRequest'
description: Specifies the parameters to perform an action on an already protected object.
required: true
/data-protect/protected-objects/{id}:
put:
description: Update Protected object backup configuration given a object id.
tags:
- Protected Objects
summary: Update Object Backup
operationId: UpdateProtectedObjectsOfAnyType
parameters:
- description: Specifies the id of the Protected Object.
name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
$ref: '#/components/responses/GetProtectedObjectResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProtectedObjectsRequest'
description: Specifies the parameters to perform an update on protected objects.
required: true
components:
responses:
CreateProtectedObjectsResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProtectedObjectsResponse'
ProtectedObjectActionResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ProtectedObjectActionResponse'
ErrorResponse:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
GetProtectedObjectResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetProtectedObjectResponse'
schemas:
NasFullThrottlingConfig:
description: Specifies the throttling configuration during full backup run.
type: object
title: NAS Full Backup Throttling Params
properties:
maxMetadataFetchPercentage:
description: Specifies the percentage value of maximum concurrent metadata to be fetched during full backup of the source.
type:
- integer
- 'null'
format: int32
x-order: 0
maxReadWritePercentage:
description: Specifies the percentage value of maximum concurrent read/write during full backup of the source.
type:
- integer
- 'null'
format: int32
x-order: 1
UnprotectActionObjectLevelParams:
description: Specifies the request parameters for Unprotect action on a Protected object.
type: object
allOf:
- $ref: '#/components/schemas/ProtectionObjectInput'
- type: object
properties:
deleteAllSnapshots:
description: Specifies whether to delete all snapshots along with unprotecting object protection. If set to true, all snapshots will be deleted and no more recoverable.
type:
- boolean
- 'null'
x-order: 0
forceUnprotect:
description: If specified as true then it will cancel the ongoing runs and immediatly unprotect.
type:
- boolean
- 'null'
x-order: 1
AzureTargetConfig:
description: Specifies the configuration for adding Azure as replication target
type: object
title: Azure Target Configuration
required:
- sourceId
properties:
sourceId:
description: Specifies the source id of the Azure protection source registered on Cohesity cluster.
type:
- integer
- 'null'
format: int64
x-order: 0
name:
description: Specifies the name of the Azure Replication target.
type:
- string
- 'null'
x-order: 1
readOnly: true
resourceGroup:
description: Specifies id of the Azure resource group used to filter regions in UI.
type:
- integer
- 'null'
format: int64
x-order: 2
resourceGroupName:
description: Specifies name of the Azure resource group used to filter regions in UI.
type:
- string
- 'null'
x-order: 3
readOnly: true
storageAccount:
description: Specifies id of the storage account of Azure replication target which will contain storage container.
type:
- integer
- 'null'
x-order: 4
readOnly: true
storageAccountName:
description: Specifies name of the storage account of Azure replication target which will contain storage container.
type:
- string
- 'null'
x-order: 5
readOnly: true
storageContainer:
description: Specifies id of the storage container of Azure Replication target.
type:
- integer
- 'null'
x-order: 6
readOnly: true
storageContainerName:
description: Specifies name of the storage container of Azure Replication target.
type:
- string
- 'null'
x-order: 7
readOnly: true
storageResourceGroup:
description: Specifies id of the storage resource group of Azure Replication target.
type:
- integer
- 'null'
x-order: 8
readOnly: true
storageResourceGroupName:
description: Specifies name of the storage resource group of Azure Replication target.
type:
- string
- 'null'
x-order: 9
readOnly: true
ArchivalTargetTierInfo:
description: Specifies the tier info for archival.
title: Archival Target Tier Info
allOf:
- $ref: '#/components/schemas/TierLevelSettings'
- type: object
properties:
currentTierType:
description: Specifies the type of the current tier where the snapshot resides. This will be specified if the run is a CAD run.
type:
- string
- 'null'
enum:
- kAmazonS3Standard
- kAmazonS3StandardIA
- kAmazonS3OneZoneIA
- kAmazonS3IntelligentTiering
- kAmazonS3Glacier
- kAmazonS3GlacierDeepArchive
- kAzureTierHot
- kAzureTierCool
- kAzureTierArchive
- kGoogleStandard
- kGoogleRegional
- kGoogleMultiRegional
- kGoogleNearline
- kGoogleColdline
- kOracleTierStandard
- kOracleTierArchive
x-order: 0
ObjectSummary:
description: Specifies the Object Summary.
title: Object Summary
allOf:
- $ref: '#/components/schemas/ObjectIdentifier'
- type: object
properties:
objectHash:
description: Specifies the hash identifier of the object.
type:
- string
- 'null'
x-order: 0
objectType:
description: Specifies the type of the object.
type:
- string
- 'null'
enum:
- kCluster
- kVserver
- kVolume
- kVCenter
- kStandaloneHost
- kvCloudDirector
- kFolder
- kDatacenter
- kComputeResource
- kClusterComputeResource
- kResourcePool
- kDatastore
- kHostSystem
- kVirtualMachine
- kVirtualApp
- kStoragePod
- kNetwork
- kDistributedVirtualPortgroup
- kTagCategory
- kTag
- kOpaqueNetwork
- kOrganization
- kVirtualDatacenter
- kCatalog
- kOrgMetadata
- kStoragePolicy
- kVirtualAppTemplate
- kDomain
- kOutlook
- kMailbox
- kUsers
- kGroups
- kSites
- kUser
- kGroup
- kSite
- kApplication
- kGraphUser
- kPublicFolders
- kPublicFolder
- kTeams
- kTeam
- kKeyspace
- kTable
- kDatabase
- kCollection
- kBucket
- kNamespace
- kSCVMMServer
- kStandaloneCluster
- kHostGroup
- kHypervHost
- kHostCluster
- kCustomProperty
- kSubscription
- kResourceGroup
- kStorageAccount
- kStorageKey
- kStorageContainer
- kStorageBlob
- kNetworkSecurityGroup
- kVirtualNetwork
- kSubnet
- kComputeOptions
- kSnapshotManagerPermit
- kAvailabilitySet
- kOVirtManager
- kHost
- kStorageDomain
- kVNicProfile
- kIAMUser
- kRegion
- kAvailabilityZone
- kEC2Instance
- kVPC
- kInstanceType
- kKeyPair
- kRDSOptionGroup
- kRDSParameterGroup
- kRDSInstance
- kRDSSubnet
- kRDSTag
- kAuroraCluster
- kAccount
- kSubTaskPermit
- kProject
- kLabel
- kMetadata
- kVPCConnector
- kPrismCentral
- kOtherHypervisorCluster
- kDfsGroup
- kDfsTopDir
- kZone
- kMountPoint
- kStorageArray
- kFileSystem
- kContainer
- kFilesystem
- kFileset
- kViewBox
- kView
- kWindowsCluster
- kOracleRACCluster
- kOracleAPCluster
- kService
- kPVC
- kRootContainer
- kDAGRootContainer
- kExchangeNode
- kExchangeDAGDatabaseCopy
- kExchangeStandaloneDatabase
- kExchangeDAG
- kExchangeDAGDatabase
- kDomainController
- kInstance
- kAAG
- kAAGRootContainer
- kRACRootContainer
- kTableSpace
- kPDB
- kObject
x-order: 1
logicalSizeBytes:
description: Specifies the logical size of object in bytes.
type:
- integer
- 'null'
format: int64
x-order: 2
uuid:
description: Specifies the uuid which is a unique identifier of the object.
type:
- string
- 'null'
x-order: 3
protectionType:
description: Specifies the protection type of the object if any.
type:
- string
- 'null'
enum:
- kAgent
- kNative
- kSnapshotManager
- kRDSSnapshotManager
- kAuroraSnapshotManager
- kFile
- kVolume
x-order: 4
osType:
description: Specifies the operating system type of the object.
type:
- string
- 'null'
enum:
- kLinux
- kWindows
- kAix
- kSolaris
- kSapHana
- kOther
x-order: 5
vCenterSummary:
description: Specifies the vCenter object details.
type:
- object
- 'null'
x-order: 6
$ref: '#/components/schemas/ObjectTypeVCenterParams'
CommonMssqlNativeObjectProtectionParams:
description: Specifies the common params to create a Native based MSSQL Object Protection.
allOf:
- type: object
properties:
numStreams:
description: Specifies the number of streams to be used.
type:
- integer
- 'null'
format: int32
x-order: 0
withClause:
description: Specifies the WithClause to be used.
type:
- string
- 'null'
x-order: 1
- $ref: '#/components/schemas/CommonMSSQLProtectionGroupParams'
NetappObjectProtectionParams:
description: Specifies the parameters which are specific to Netapp object protection.
type: object
properties:
protocol:
description: Specifies the protocol of the NAS device being backed up.
type:
- string
- 'null'
enum:
- kNoProtocol
- kNfs3
- kCifs1
- kCifs2
- kCifs3
x-order: 0
excludeObjectIds:
description: Specifies the objects to be excluded in the Protection.
type:
- array
- 'null'
uniqueItems: true
items:
type: integer
format: int64
x-order: 1
snapshotLabel:
description: Specifies the incremental and full snapshot label for Data-Protect Netapp Volumes backup. If field is set , incremental and full snapshot label has to be provided. If field is not set, the snapshot label will be automatically set using timestamp.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/SnapshotLabel'
backupExistingSnapshot:
description: Specifies that snapshot label is not set for Data-Protect Netapp Volumes backup. If field is set to true, existing oldest snapshot is used for backup and subsequent incremental will be selected in ascending order of snapshot create time on the source. If snapshot label is set, this field is set to false.
type:
- boolean
- 'null'
x-order: 3
continuousSnapshots:
description: Specifies the source snapshots to be taken even if there is a pending run in a protection group.
type:
- object
- 'null'
x-order: 4
$ref: '#/components/schemas/ContinuousSnapshotParams'
IsilonObjectProtectionUpdateRequestParams:
description: Specifies the update parameters which are specific to Isilon object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/IsilonObjectProtectionParams'
GenericNasObjectProtectionResponseParams:
description: Specifies the parameters which are specific to Generic NAS object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
ElastifileObjectProtectionParams:
description: Specifies the parameters which are specific to Elastifile object protection.
type: object
properties:
protocol:
description: Specifies the protocol of the NAS device being backed up.
type:
- string
- 'null'
enum:
- kNoProtocol
- kNfs3
- kCifs1
- kCifs2
- kCifs3
x-order: 0
SlaRule:
description: Specifies an SLA rule for a specific Protection Group run type.
type: object
properties:
backupRunType:
description: Specifies the type of run this rule should apply to.
type:
- string
- 'null'
enum:
- kIncremental
- kFull
x-order: 0
slaMinutes:
description: Specifies the number of minutes allotted to a run of the specified type before SLA is considered violated.
type:
- integer
- 'null'
format: int64
minimum: 1
x-order: 1
ReplicationTargetResult:
description: Replication result for a target.
title: Replication result for a target.
allOf:
- $ref: '#/components/schemas/ReplicationTargetSummaryInfo'
- type: object
properties:
startTimeUsecs:
description: Specifies the start time of replication in Unix epoch Timestamp(in microseconds) for a target.
type:
- integer
- 'null'
format: int64
x-order: 0
endTimeUsecs:
description: Specifies the end time of replication in Unix epoch Timestamp(in microseconds) for a target.
type:
- integer
- 'null'
format: int64
x-order: 1
queuedTimeUsecs:
description: Specifies the time when the replication is queued for schedule in Unix epoch Timestamp(in microseconds) for a target.
type:
- integer
- 'null'
format: int64
x-order: 2
status:
description: Status of the replication for a target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
type:
- string
- 'null'
enum:
- Accepted
- Running
- Canceled
- Canceling
- Failed
- Missed
- Succeeded
- SucceededWithWarning
- OnHold
x-order: 3
message:
description: Message about the replication run.
type:
- string
- 'null'
x-order: 4
percentageCompleted:
description: Specifies the progress in percentage.
type:
- integer
- 'null'
format: int32
x-order: 5
stats:
description: Replication data statistics for a target.
x-order: 6
$ref: '#/components/schemas/ReplicationDataStats'
isManuallyDeleted:
description: Specifies whether the snapshot is deleted manually.
type:
- boolean
- 'null'
x-order: 7
expiryTimeUsecs:
description: Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 8
replicationTaskId:
description: Task UID for a replication protection run. This is for tasks that are replicated from another cluster.
type:
- string
- 'null'
x-order: 9
entriesChanged:
description: Specifies the number of metadata actions completed during the protection run.
type:
- integer
- 'null'
format: int32
x-order: 10
isInBound:
description: Specifies the direction of the replication. If the snapshot is replicated to this cluster, then isInBound is true. If the snapshot is replicated from this cluster to another cluster, then isInBound is false.
type:
- boolean
- 'null'
x-order: 11
VmwareObjectProtectionResponseParams:
description: Specifies the parameters which are specific to VMware object protection.
type: object
allOf:
- $ref: '#/components/schemas/VmwareObjectProtectionResponse'
- $ref: '#/components/schemas/CommonVmwareProtectionParams'
MssqlObjectProtectionResponseParams:
description: Specifies the response parameters specific to MSSQL object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonMssqlObjectProtectionParams'
NetappObjectProtectionResponseParams:
description: Specifies the parameters which are specific to Netapp object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/NetappObjectProtectionParams'
VmwareObjectProtectionResponse:
description: Specifies the input for a protection object in the VMware environment.
type: object
allOf:
- $ref: '#/components/schemas/CommonVmwareObjectParams'
- type: object
properties:
excludeObjectIds:
description: Specifies the list of IDs of the objects to not be protected in this backup. This field only applies if provided object id is non leaf entity such as Tag or a folder. This can be used to ignore specific objects under a parent object which has been included for protection.
type: array
items:
type:
- integer
- 'null'
format: int64
x-order: 0
cdpInfo:
description: Specifies the CDP related information for a given object. This field will only be populated when protection group is configured with policy having CDP retnetion settings.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/VmwareCdpObject'
Office365UserMailboxObjectProtectionUpdateRequestParams:
description: Specifies the update parameters specific to Microsoft 365 User Mailbox object protection.
type: object
allOf:
- $ref: '#/components/schemas/Office365ObjectProtectionCommonParams'
VmwareObjectProtectionRequest:
description: Specifies the VMware object level settings for object protection.
type: object
allOf:
- type: object
required:
- id
properties:
id:
description: Specifies the id of the object being protected. This can be a leaf level or non leaf level object.
type:
- integer
- 'null'
format: int64
x-order: 0
excludeObjectIds:
description: Specifies the list of IDs of the objects to not be protected in this backup. This field only applies if provided object id is non leaf entity such as Tag or a folder. This can be used to ignore specific objects under a parent object which has been included for protection.
type: array
items:
type:
- integer
- 'null'
format: int64
x-order: 1
- $ref: '#/components/schemas/CommonVmwareObjectParams'
CommonPrePostScriptParams:
description: Specifies the path to the remote script and any common parameters expected by the remote script.
type: object
title: Common PrePost Script Params
required:
- path
properties:
path:
description: Specifies the absolute path to the script on the remote host.
type: string
x-order: 0
params:
description: 'Specifies the arguments or parameters and values to pass into the remote script. For example if the script expects values for the ''database'' and ''user'' parameters, specify the parameters and values using the following string: "database=myDatabase user=me".'
type:
- string
- 'null'
x-order: 1
timeoutSecs:
description: Specifies the timeout of the script in seconds. The script will be killed if it exceeds this value. By default, no timeout will occur if left empty.
type:
- integer
- 'null'
format: int32
minimum: 1
x-order: 2
isActive:
description: Specifies whether the script should be enabled, default value set to true.
type:
- boolean
- 'null'
x-order: 3
CommonCloudTierSettings:
description: Specifies the common settings required for configuring cloud tiering.
type: object
properties:
moveAfterUnit:
description: Specifies the unit for moving the data from current tier to next tier. This unit will be a base unit for the 'moveAfter' field specified below.
type:
- string
- 'null'
enum:
- Days
- Weeks
- Months
- Years
x-order: 0
moveAfter:
description: Specifies the time period after which the backup will be moved from current tier to next tier.
type:
- integer
- 'null'
format: int64
x-order: 1
OracleTiers:
description: Specifies Oracle tiers.
type: object
required:
- tiers
properties:
tiers:
description: Specifies the tiers that are used to move the archived backup from current tier to next tier. The order of the tiers determines which tier will be used next for moving the archived backup. The first tier input should always be default tier where backup will be acrhived. Each tier specifies how much time after the backup will be moved to next tier from the current tier.
type:
- array
- 'null'
minLength: 1
items:
$ref: '#/components/schemas/OracleTier'
x-order: 0
EnvSpecificObjectProtectionResponseParams:
description: Specifies the parameters which are specific to adapter identified by enviournment.
type: object
properties:
environment:
description: Specifies the environment for current object.
type:
- string
- 'null'
enum:
- kVMware
- kHyperV
- kAzure
- kGCP
- kKVM
- kAcropolis
- kAWS
- kPhysical
- kGPFS
- kElastifile
- kNetapp
- kGenericNas
- kIsilon
- kFlashBlade
- kPure
- kSQL
- kExchange
- kAD
- kOracle
- kView
- kRemoteAdapter
- kO365
- kKubernetes
- kCassandra
- kMongoDB
- kCouchbase
- kHdfs
- kHive
- kHBase
- kUDA
x-order: 0
vmwareParams:
description: Specifies the parameters which are specific to VMware related Object Backup.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/VmwareObjectProtectionResponseParams'
genericNasParams:
description: Specifies the parameters which are specific to Generic Nas related Object Backup.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/GenericNasObjectProtectionResponseParams'
gpfsParams:
description: Specifies the parameters which are specific to Gpfs related Object Backup.
type:
- object
- 'null'
x-order: 3
$ref: '#/components/schemas/GpfsObjectProtectionResponseParams'
elastifileParams:
description: Specifies the parameters which are specific to Elastifile related Object Backup.
type:
- object
- 'null'
x-order: 4
$ref: '#/components/schemas/ElastifileObjectProtectionResponseParams'
netappParams:
description: Specifies the parameters which are specific to Netapp related Object Backup.
type:
- object
- 'null'
x-order: 5
$ref: '#/components/schemas/NetappObjectProtectionResponseParams'
isilonParams:
description: Specifies the parameters which are specific to Isilon related Object Backup.
type:
- object
- 'null'
x-order: 6
$ref: '#/components/schemas/IsilonObjectProtectionResponseParams'
flashbladeParams:
description: Specifies the parameters which are specific to Flashblade related Object Backup.
type:
- object
- 'null'
x-order: 7
$ref: '#/components/schemas/FlashbladeObjectProtectionResponseParams'
mssqlParams:
description: Specifies the parameters which are specific to Mssql related Object Backup.
type:
- object
- 'null'
x-order: 8
$ref: '#/components/schemas/MssqlObjectProtectionResponseParams'
office365UserMailboxParams:
description: Specifies the parameters which are specific to Microsoft 365 user mailbox related Object Backup.
type:
- object
- 'null'
x-order: 9
$ref: '#/components/schemas/Office365UserMailboxObjectProtectionResponseParams'
Office365UserMailboxObjectProtectionRequestParams:
description: Specifies the request parameters specific to Microsoft 365 User Mailbox object protection.
type: object
allOf:
- $ref: '#/components/schemas/Office365ObjectProtectionCommonParams'
NetappObjectProtectionRequestParams:
description: Specifies the parameters which are specific to Netapp object protection.
type: object
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the objects to be protected.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/ProtectionObjectInput'
x-order: 0
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/NetappObjectProtectionParams'
ElastifileObjectProtectionResponseParams:
description: Specifies the parameters which are specific to Elastifile object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/ElastifileObjectProtectionParams'
AWSTiers:
description: Specifies aws tiers.
type: object
required:
- tiers
properties:
tiers:
description: Specifies the tiers that are used to move the archived backup from current tier to next tier. The order of the tiers determines which tier will be used next for moving the archived backup. The first tier input should always be default tier where backup will be acrhived. Each tier specifies how much time after the backup will be moved to next tier from the current tier.
type:
- array
- 'null'
minLength: 1
items:
$ref: '#/components/schemas/AWSTier'
x-order: 0
PauseActionObjectLevelParams:
description: Specifies the request parameters for Pause action on a Protected object.
type: object
allOf:
- $ref: '#/components/schemas/ProtectionObjectInput'
VmwareObjectProtectionUpdateRequestParams:
description: Specifies the parameters which are specific to VMware object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonVmwareProtectionParams'
- $ref: '#/components/schemas/CommonVmwareObjectParams'
- type: object
properties:
excludeObjectIds:
description: Specifies the list of IDs of the objects to not be protected in this backup. This field only applies if provided object id is non leaf entity such as Tag or a folder. This can be used to ignore specific objects under a parent object which has been included for protection.
type: array
items:
type:
- integer
- 'null'
format: int64
x-order: 0
CdpLocalBackupInfo:
description: Specifies the last local backup information for a given CDP object.
type: object
properties:
startTimeInUsecs:
description: Specifies the start time of the last local backup taken.
type:
- integer
- 'null'
format: int64
x-order: 0
endTimeInUsecs:
description: Specifies the end time of the last local backup taken.
type:
- integer
- 'null'
format: int64
x-order: 1
AzureCloudSpinParams:
description: Specifies various resources when converting and deploying a VM to Azure.
type: object
title: Azure Parameters.
properties:
networkResourceGroupId:
description: Specifies id of the resource group for the selected virtual network.
type:
- integer
- 'null'
format: int64
x-order: 0
resourceGroupId:
description: Specifies id of the Azure resource group. Its value is globally unique within Azure.
type:
- integer
- 'null'
format: int64
x-order: 1
storageAccountId:
description: Specifies id of the storage account that will contain the storage container within which we will create the blob that will become the VHD disk for the cloned VM.
type:
- integer
- 'null'
format: int64
x-order: 2
storageContainerId:
description: Specifies id of the storage container within the above storage account.
type:
- integer
- 'null'
format: int64
x-order: 3
storageResourceGroupId:
description: Specifies id of the resource group for the selected storage account.
type:
- integer
- 'null'
format: int64
x-order: 4
availabilitySetId:
description: Specifies the availability set.
type:
- integer
- 'null'
format: int64
x-order: 5
tempVmResourceGroupId:
description: Specifies id of the temporary Azure resource group.
type:
- integer
- 'null'
format: int64
x-order: 6
tempVmStorageAccountId:
description: Specifies id of the temporary VM storage account that will contain the storage container within which we will create the blob that will become the VHD disk for the cloned VM.
type:
- integer
- 'null'
format: int64
x-order: 7
tempVmStorageContainerId:
description: Specifies id of the temporary VM storage container within the above storage account.
type:
- integer
- 'null'
format: int64
x-order: 8
tempVmSubnetId:
description: Specifies Id of the temporary VM subnet within the above virtual network.
type:
- integer
- 'null'
format: int64
x-order: 9
tempVmVirtualNetworkId:
description: Specifies Id of the temporary VM Virtual Network.
type:
- integer
- 'null'
format: int64
x-order: 10
TierLevelSettings:
description: 'Specifies the settings tier levels configured with each archival target. The tier settings need to be applied in specific order and default tier should always be passed as first entry in tiers array. The following example illustrates how to configure tiering input for AWS tiering. Same type of input structure applied to other cloud platforms also.
If user wants to achieve following tiering for backup,
User Desired Tiering-
1.Archive Full back up for 12 Months
2.Tier Levels
[1,12] [
s3 (1 to 2 months), (default tier)
s3 Intelligent tiering (3 to 6 months),
s3 One Zone (7 to 9 months)
Glacier (10 to 12 months)]
API Input
1.tiers-[
{''tierType'': ''S3'',''moveAfterUnit'':''months'',
''moveAfter'':2 - move from s3 to s3Inte after 2 months},
{''tierType'': ''S3Inte'',''moveAfterUnit'':''months'',
''moveAfter'':4 - move from S3Inte to Glacier after 4 months},
{''tierType'': ''Glacier'', ''moveAfterUnit'':''months'',
''moveAfter'': 3 - move from Glacier to S3 One Zone after 3 months },
{''tierType'': ''S3 One Zone'', ''moveAfterUnit'': nil,
''moveAfter'': nil - For the last record, ''moveAfter'' and ''moveAfterUnit''
will be ignored since there are no further tier for data movement }
}]'
type: object
required:
- cloudPlatform
properties:
cloudPlatform:
description: Specifies the cloud platform to enable tiering.
type:
- string
- 'null'
enum:
- AWS
- Azure
- Oracle
- Google
x-order: 0
awsTiering:
description: Specifies the settings for AWS Tiers.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/AWSTiers'
azureTiering:
description: Specifies the settings for Azure Tiers.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/AzureTiers'
googleTiering:
description: Specifies the settings for Google Tiers.
type:
- object
- 'null'
x-order: 3
$ref: '#/components/schemas/GoogleTiers'
oracleTiering:
description: Specifies the settings for Oracle Tiers.
type:
- object
- 'null'
x-order: 4
$ref: '#/components/schemas/OracleTiers'
UpdateProtectedObjectsRequest:
description: Specifies the request to update an object backup configuration.
type: object
allOf:
- $ref: '#/components/schemas/CommonObjectProtectParams'
- $ref: '#/components/schemas/EnvSpecificObjectProtectionUpdateRequestParams'
MssqlNativeObjectProtectionParams:
description: Specifies the params to create a Native based MSSQL Object Protection.
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the list of objects to be protected.
type:
- array
- 'null'
minItems: 1
items:
$ref: '#/components/schemas/MssqlNativeObjectProtection'
x-order: 0
numStreams:
description: Specifies the number of streams to be used.
type:
- integer
- 'null'
format: int32
x-order: 1
withClause:
description: Specifies the WithClause to be used.
type:
- string
- 'null'
x-order: 2
- $ref: '#/components/schemas/CommonMSSQLProtectionGroupParams'
ClusterIdentifier:
description: Specifies the information about a cluster.
type: object
title: Cluster Identifier
properties:
clusterId:
description: Specifies the id of the cluster.
type:
- integer
- 'null'
format: int64
x-order: 0
clusterIncarnationId:
description: Specifies the incarnation id of the cluster.
type:
- integer
- 'null'
format: int64
x-order: 1
clusterName:
description: Specifies the name of the cluster.
type:
- string
- 'null'
x-order: 2
readOnly: true
BackupAttempt:
description: Specifies a backup attempt for an object.
type: object
title: Attempt information for an object.
properties:
startTimeUsecs:
description: Specifies the start time of attempt in Unix epoch Timestamp(in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 0
endTimeUsecs:
description: Specifies the end time of attempt in Unix epoch Timestamp(in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 1
admittedTimeUsecs:
description: Specifies the time at which the backup task was admitted to run in Unix epoch Timestamp(in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 2
permitGrantTimeUsecs:
description: Specifies the time when gatekeeper permit is granted to the backup task. If the backup task is rescheduled due to errors, the field is updated to the time when permit is granted again.
type:
- integer
- 'null'
format: int64
x-order: 3
queueDurationUsecs:
description: Specifies the duration between the startTime and when gatekeeper permit is granted to the backup task. If the backup task is rescheduled due to errors, the field is updated considering the time when permit is granted again. Queue duration = PermitGrantTimeUsecs - StartTimeUsecs
type:
- integer
- 'null'
format: int64
x-order: 4
snapshotCreationTimeUsecs:
description: Specifies the time at which the source snapshot was taken in Unix epoch Timestamp(in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 5
status:
description: Status of the attempt for an object. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
type:
- string
- 'null'
enum:
- Accepted
- Running
- Canceled
- Canceling
- Failed
- Missed
- Succeeded
- SucceededWithWarning
- OnHold
x-order: 6
stats:
description: Statistics about backup data for an object.
x-order: 7
$ref: '#/components/schemas/BackupDataStats'
progressTaskId:
description: Progress monitor task for an object..
type:
- string
- 'null'
x-order: 8
message:
description: A message about the error if encountered while performing backup.
type:
- string
- 'null'
x-order: 9
CreateProtectedObjectsRequest:
description: Specifies the request for creating an object backup.
type: object
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the list of objects to be protected. Multiple objects from different adapters can be provided as input.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EnvSpecificObjectProtectionRequestParams'
x-order: 0
- $ref: '#/components/schemas/CommonObjectProtectParams'
NasThrottlingConfig:
description: Specifies the source throttling parameters to be used during full or incremental backup of the NAS source.
type: object
title: Nas Source and Protection Throttling Configuration
properties:
fullBackupConfig:
description: Specifies the throttling configuration during full backup run.
x-order: 0
$ref: '#/components/schemas/NasFullThrottlingConfig'
incrementalBackupConfig:
description: Specifies the throttling configuration during incremental backup run.
x-order: 1
$ref: '#/components/schemas/NasIncrementalThrottlingConfig'
ProtectdObjectsActionRequest:
description: Specifies the request for performing various actions on protected objects.
type: object
required:
- action
properties:
action:
description: Specifies the action type to be performed on object getting protected. Based on selected action, provide the action params.
type: string
enum:
- Pause
- Resume
- UnProtect
- ProtectNow
x-order: 0
pauseParams:
description: If provided action is 'Pause' then this object should be provided as input.
type: object
x-order: 1
$ref: '#/components/schemas/ProtectedObjectPauseActionParams'
resumeParams:
description: If provided action is 'Resume' then this object should be provided as input.
type: object
x-order: 2
$ref: '#/components/schemas/ProtectedObjectResumeActionParams'
runNowParams:
description: If provided action is 'RunNow' then this object should be provided as input.
type: object
x-order: 3
$ref: '#/components/schemas/ProtectedObjectRunNowActionParams'
unProtectParams:
description: If provided action is 'UnProtect' then this object should be provided as input.
type: object
x-order: 4
$ref: '#/components/schemas/ProtectedObjectUnProtectActionParams'
FileFilteringPolicy:
description: 'Specifies a set of filters for a file based Protection Group.
These values are strings which can represent a prefix or suffix.
Example: ''/tmp'' or ''*.mp4''. For file based Protection Groups, all files
under prefixes specified by the ''includeFilters'' list will be protected
unless they are explicitly excluded by the ''excludeFilters'' list.'
type: object
properties:
includeList:
description: Specifies the list of included files for this Protection Group.
type: array
items:
type: string
x-order: 0
excludeList:
description: 'Specifies the list of excluded files for this protection
Protection Group. Exclude filters have a higher priority than include
filters.'
type: array
items:
type: string
x-order: 1
RunNowActionObjectLevelResponse:
description: Specifies the infomration about status of run now action.
type: object
properties:
error:
description: If the action fails for this object, then error will be return here.
x-order: 0
$ref: '#/components/schemas/Error'
ResumeActionObjectLevelResponse:
description: Specifies the infomration about status of resume action.
type: object
properties:
error:
description: If the action fails for this object, then error will be return here.
x-order: 0
$ref: '#/components/schemas/Error'
GetProtectedObjectResponse:
description: Specifies the protected objects response.
type: object
properties:
object:
description: Specifies the protected object backup configuration and lastRun details if it has happned.
type:
- object
- 'null'
x-order: 0
$ref: '#/components/schemas/ProtectedObjectInfo'
CommonPreBackupScriptParams:
description: Specifies the common params for PreBackup scripts.
title: Common PreBackup Script Params
allOf:
- $ref: '#/components/schemas/CommonPrePostScriptParams'
- type: object
properties:
continueOnError:
description: Specifies if the script needs to continue even if there is an occurence of an error. If this flag is set to true, then Backup Run will start even if the pre backup script fails. If not specified or false, then backup run will not start when script fails.
type:
- boolean
- 'null'
x-order: 0
SnapshotInfo:
description: Snapshot info for an object.
type: object
title: Snapshot information for an object.
properties:
snapshotId:
description: Snapshot id for a successful snapshot. This field will not be set if the Protection Group Run has no successful attempt.
type:
- string
- 'null'
x-order: 0
status:
description: Status of snapshot.
type:
- string
- 'null'
enum:
- kInProgress
- kSuccessful
- kFailed
- kWaitingForNextAttempt
- kWarning
x-order: 1
startTimeUsecs:
description: Specifies the start time of attempt in Unix epoch Timestamp(in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 2
endTimeUsecs:
description: Specifies the end time of attempt in Unix epoch Timestamp(in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 3
admittedTimeUsecs:
description: Specifies the time at which the backup task was admitted to run in Unix epoch Timestamp(in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 4
permitGrantTimeUsecs:
description: Specifies the time when gatekeeper permit is granted to the backup task. If the backup task is rescheduled due to errors, the field is updated to the time when permit is granted again.
type:
- integer
- 'null'
format: int64
x-order: 5
queueDurationUsecs:
description: Specifies the duration between the startTime and when gatekeeper permit is granted to the backup task. If the backup task is rescheduled due to errors, the field is updated considering the time when permit is granted again. Queue duration = PermitGrantTimeUsecs - StartTimeUsecs
type:
- integer
- 'null'
format: int64
x-order: 6
snapshotCreationTimeUsecs:
description: Specifies the time at which the source snapshot was taken in Unix epoch Timestamp(in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 7
stats:
description: Statistics about backup data for an object.
x-order: 8
$ref: '#/components/schemas/BackupDataStats'
progressTaskId:
description: Progress monitor task for an object.
type:
- string
- 'null'
x-order: 9
warnings:
description: Specifies a list of warning messages.
type:
- array
- 'null'
items:
type: string
x-order: 10
isManuallyDeleted:
description: Specifies whether the snapshot is deleted manually.
type:
- boolean
- 'null'
x-order: 11
expiryTimeUsecs:
description: Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 12
totalFileCount:
description: The total number of file and directory entities visited in this backup. Only applicable to file based backups.
type:
- integer
- 'null'
format: int64
x-order: 13
backupFileCount:
description: The total number of file and directory entities that are backed up in this run. Only applicable to file based backups.
type:
- integer
- 'null'
format: int64
x-order: 14
FileLevelDataLockConfig:
description: 'Specifies a config to lock files in a view - to protect from malicious or
an accidental attempt to delete or modify the files in this view.'
type: object
title: File Level Data Lock Configurations.
properties:
autoLockAfterDurationIdleMsecs:
description: 'Specifies the duration to lock a file that has not been accessed or
modified (ie. has been idle) for a certain duration of time in
milliseconds. Do not set if it is required to disable auto lock.'
type:
- integer
- 'null'
format: uint64
x-order: 0
defaultRetentionDurationMsecs:
description: 'Specifies a global default retention duration for files in this view, if
file lock is enabled for this view. Also, it is a required field if file
lock is enabled. Set to -1 if the required default retention period is
forever.'
type:
- integer
- 'null'
format: int64
x-order: 1
expiryTimestampMsecs:
description: Specifies a definite timestamp in milliseconds for retaining the file.
type:
- integer
- 'null'
format: uint64
x-order: 2
lockingProtocol:
description: 'Specifies the supported mechanisms to explicity lock a file from NFS/SMB
interface. Supported locking protocols: SetReadOnly, SetAtime.
''SetReadOnly'' is compatible with Isilon/Netapp behaviour. This locks the
file and the retention duration is determined in this order:
1) atime, if set by user/application and within min and max retention
duration.
2) Min retention duration, if set.
3) Otherwise, file is switched to expired data automatically.
''SetAtime'' is compatible with Data Domain behaviour.'
type:
- string
- 'null'
enum:
- SetReadOnly
- SetAtime
x-order: 3
maxRetentionDurationMsecs:
description: 'Specifies a maximum duration in milliseconds for which any file in this
view can be retained for. Set to -1 if the required retention duration is
forever. If set, it should be greater than or equal to the default
retention period as well as the min retention period.'
type:
- integer
- 'null'
format: int64
x-order: 4
minRetentionDurationMsecs:
description: 'Specifies a minimum retention duration in milliseconds after a file gets
locked. The file cannot be modified or deleted during this timeframe. Set
to -1 if the required retention duration is forever. This should be set
less than or equal to the default retention duration.'
type:
- integer
- 'null'
format: int64
x-order: 5
mode:
description: 'Specifies the mode of file level datalock.
Enterprise mode can be upgraded to Compliance mode, but Compliance mode
cannot be downgraded to Enterprise mode.
Compliance: This mode would disallow all user to delete/modify file or
view under any condition when it ''s in locked status except for deleting
view when the view is empty.
Enterprise: This mode would follow the rules as compliance mode for
normal users. But it would allow the storage admin
(1) to delete view or file anytime no matter
it is in locked status or expired.
(2) to rename the view
(3) to bring back the retention period when it''s in locked mode
A lock mode of a file in a view can be in one of the following:
''Compliance'': Default mode of datalock, in this mode, Data Security Admin
cannot modify/delete this view when datalock is in effect. Data Security
Admin can delete this view when datalock is expired.
''kEnterprise'' : In this mode, Data Security Admin can change view name or
delete view when datalock is in effect. Datalock in this mode can be
upgraded to ''Compliance'' mode.'
type:
- string
- 'null'
enum:
- Compliance
- Enterprise
x-order: 6
CommonVmwareProtectionParams:
description: Specifies the common parameters which are specific to VMware related protection.
type: object
properties:
appConsistentSnapshot:
description: Specifies whether or not to quiesce apps and the file system in order to take app consistent snapshots.
type:
- boolean
- 'null'
x-order: 0
fallbackToCrashConsistentSnapshot:
description: Specifies whether or not to fallback to a crash consistent snapshot in the event that an app consistent snapshot fails. This parameter defaults to true and only changes the behavior of the operation if 'appConsistentSnapshot' is set to 'true'.
type:
- boolean
- 'null'
x-order: 1
skipPhysicalRDMDisks:
description: Specifies whether or not to skip backing up physical RDM disks. Physical RDM disks cannot be backed up, so if you attempt to backup a VM with physical RDM disks and this value is set to 'false', then those VM backups will fail.
type:
- boolean
- 'null'
x-order: 2
indexingPolicy:
description: Specifies the indexing policy for VMs in this group.
x-order: 3
$ref: '#/components/schemas/IndexingPolicy'
prePostScript:
description: Specifies the pre and post script parameters associated with a given backup.
type:
- object
- 'null'
x-order: 4
$ref: '#/components/schemas/PrePostScriptParams'
leverageSanTransport:
description: If this field is set to true, then the backup for the objects will be performed using dedicated storage area network (SAN) instead of LAN or managment network.
type:
- boolean
- 'null'
x-order: 5
enableNBDSSLFallback:
description: If this field is set to true and SAN transport backup fails, then backup will fallback to use NBDSSL transport. This field only applies if 'leverageSanTransport' is set to true.
type:
- boolean
- 'null'
x-order: 6
NasIncrementalThrottlingConfig:
type: object
title: NAS Full Backup Throttling Params
properties:
maxMetadataFetchPercentage:
description: Specifies the percentage value of maximum concurrent metadata to be fetched during incremental backup of the source.
type:
- integer
- 'null'
format: int32
x-order: 0
maxReadWritePercentage:
description: Specifies the percentage value of maximum concurrent read/write during incremental backup of the source.
type:
- integer
- 'null'
format: int32
x-order: 1
ObjectTypeVCenterParams:
type: object
title: Object Type VCenter Params
properties:
isCloudEnv:
description: Specifies that registered vCenter source is a VMC (VMware Cloud) environment or not.
type:
- boolean
- 'null'
x-order: 0
FlashbladeObjectProtectionParams:
description: Specifies the parameters which are specific to Flashblade object protection.
type: object
properties:
protocol:
description: Specifies the protocol of the NAS device being backed up.
type:
- string
- 'null'
enum:
- kNoProtocol
- kNfs3
- kCifs1
- kCifs2
- kCifs3
x-order: 0
BackupDataStats:
description: Specifies statistics about local snapshot.
type: object
title: Local snapshot statistics.
properties:
logicalSizeBytes:
description: Specifies total logical size of object(s) in bytes.
type:
- integer
- 'null'
format: int64
x-order: 0
bytesWritten:
description: Specifies total size of data in bytes written after taking backup.
type:
- integer
- 'null'
format: int64
x-order: 1
bytesRead:
description: Specifies total logical bytes read for creating the snapshot.
type:
- integer
- 'null'
format: int64
x-order: 2
VmwareObjectProtectionRequestParams:
description: Specifies the parameters which are specific to VMware object protection.
type: object
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the objects to include in the backup.
type: array
items:
$ref: '#/components/schemas/VmwareObjectProtectionRequest'
x-order: 0
globalExcludeDisks:
description: Specifies a list of disks to exclude from the backup.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DiskInfo'
x-order: 1
- $ref: '#/components/schemas/CommonVmwareProtectionParams'
ArchivalTargetSummaryInfo:
description: Specifies archival target summary information.
type: object
title: Archival target.
properties:
targetId:
description: Specifies the archival target ID.
type:
- integer
- 'null'
format: int64
x-order: 0
archivalTaskId:
description: Specifies the archival task id. This is a protection group UID which only applies when archival type is 'Tape'.
type:
- string
- 'null'
x-order: 1
targetName:
description: Specifies the archival target name.
type:
- string
- 'null'
x-order: 2
targetType:
description: Specifies the archival target type.
type:
- string
- 'null'
enum:
- Tape
- Cloud
- Nas
x-order: 3
tierSettings:
description: Specifies the tier level settings configured with archival target. This will be specified if the run is a CAD run.
type:
- object
- 'null'
x-order: 4
$ref: '#/components/schemas/ArchivalTargetTierInfo'
NetappObjectProtectionUpdateRequestParams:
description: Specifies the update parameters which are specific to Netapp object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/NetappObjectProtectionParams'
GpfsObjectProtectionRequestParams:
description: Specifies the parameters which are specific to Gpfs object protection.
type: object
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the objects to be protected.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/ProtectionObjectInput'
x-order: 0
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/GpfsObjectProtectionParams'
CloudSpinDataStats:
description: Specifies statistics about Cloud Spin data.
type: object
title: Cloud Spin data statistics.
properties:
physicalBytesTransferred:
description: Specifies the physical bytes transferred.
type:
- integer
- 'null'
format: int64
x-order: 0
CreateProtectedObjectsResponse:
description: Specifies the protected objects response.
type: object
properties:
protectedObjects:
description: Specifies the list of protected objects.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectProtectionSummary'
x-order: 0
UnprotectActionObjectLevelResponse:
description: Specifies the infomration about status of Unprotect action.
type: object
properties:
error:
description: If the action fails for this object, then error will be return here.
x-order: 0
$ref: '#/components/schemas/Error'
TimeOfDay:
description: Specifies the time of day. Used for scheduling purposes.
type: object
required:
- hour
- minute
properties:
hour:
description: Specifies the hour of the day (0-23).
type:
- integer
- 'null'
format: int32
maximum: 23
minimum: 0
x-order: 0
minute:
description: Specifies the minute of the hour (0-59).
type:
- integer
- 'null'
format: int32
maximum: 59
minimum: 0
x-order: 1
timeZone:
description: Specifies the time zone of the user. If not specified, default value is assumed as America/Los_Angeles.
type:
- string
- 'null'
default: America/Los_Angeles
x-order: 2
AzureTier:
description: Specifies the settings for a Azure tier.
type: object
allOf:
- $ref: '#/components/schemas/CommonCloudTierSettings'
- type: object
required:
- tierType
properties:
tierType:
description: Specifies the Azure tier types.
type:
- string
- 'null'
enum:
- kAzureTierHot
- kAzureTierCool
- kAzureTierArchive
x-order: 0
Office365ObjectProtectionCommonParams:
description: Specifies the parameters which are specific to Microsoft 365 Object Protection.
type: object
required:
- objects
properties:
objects:
description: Specifies the objects to be included in the Object Protection.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/Office365ObjectProtectionObjectParams'
x-order: 0
excludeObjectIds:
description: Specifies the objects to be excluded in the Object Protection.
type:
- array
- 'null'
uniqueItems: true
items:
type: integer
format: int64
x-order: 1
indexingPolicy:
description: Specifies the fields required to enable indexing of the protected objects.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/IndexingPolicy'
sourceId:
description: Specifies the id of the parent of the objects.
type:
- integer
- 'null'
format: int64
x-order: 3
readOnly: true
sourceName:
description: Specifies the name of the parent of the objects.
type:
- string
- 'null'
x-order: 4
readOnly: true
ObjectIdentifier:
description: Specifies the basic info to identify an object.
title: Object Identifier.
properties:
id:
description: Specifies object id.
type:
- integer
- 'null'
format: int64
x-order: 0
name:
description: Specifies the name of the object.
type:
- string
- 'null'
x-order: 1
sourceId:
description: Specifies registered source id to which object belongs.
type:
- integer
- 'null'
format: int64
x-order: 2
sourceName:
description: Specifies registered source name to which object belongs.
type:
- string
- 'null'
x-order: 3
environment:
description: Specifies the environment of the object.
type:
- string
- 'null'
enum:
- kVMware
- kHyperV
- kAzure
- kKVM
- kAWS
- kAcropolis
- kGCP
- kPhysical
- kPhysicalFiles
- kIsilon
- kNetapp
- kGenericNas
- kFlashBlade
- kElastifile
- kGPFS
- kPure
- kNimble
- kSQL
- kOracle
- kExchange
- kAD
- kView
- kO365
- kHyperFlex
- kKubernetes
- kCassandra
- kMongoDB
- kCouchbase
- kHdfs
- kHive
- kHBase
- kUDA
x-order: 4
IsilonObjectProtectionParams:
description: Specifies the parameters which are specific to Isilon object protection.
type: object
properties:
protocol:
description: Specifies the protocol of the NAS device being backed up.
type:
- string
- 'null'
enum:
- kNoProtocol
- kNfs3
- kCifs1
- kCifs2
- kCifs3
x-order: 0
continuousSnapshots:
description: Specifies the source snapshots to be taken even if there is a pending run in a protection group.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/ContinuousSnapshotParams'
useChangelist:
description: Specify whether to use the Isilon Changelist API to directly discover changed files/directories for faster incremental backup. Cohesity will keep an extra snapshot which will be deleted by the next successful backup.
type:
- boolean
- 'null'
x-order: 2
RunNowActionObjectLevelParams:
description: Specifies the request parameters for RunNow action on a Protected object.
type: object
allOf:
- $ref: '#/components/schemas/ProtectionObjectInput'
- type: object
properties:
takeLocalSnapshotOnly:
description: If sepcified as true then runNow will only take local snapshot ignoring all other targets such as replication, archivals etc. If not sepcified or specified as false then runNow will follow the policy settings.
type:
- boolean
- 'null'
x-order: 0
backupType:
description: Specifies the backup type should be used for RunNow action.
type: string
enum:
- kRegular
- kFull
- kLog
- kSystem
- kHydrateCDP
x-order: 1
GenericNasObjectProtectionRequestParams:
description: Specifies the parameters which are specific to Generic NAS object protection.
type: object
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the objects to be protected.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/ProtectionObjectInput'
x-order: 0
- $ref: '#/components/schemas/CommonNasProtectionParams'
AwsCloudSpinParams:
description: Specifies various resources when converting and deploying a VM to AWS.
type: object
title: AWS Parameters.
required:
- region
properties:
region:
description: Specifies id of the AWS region in which to deploy the VM.
type:
- integer
- 'null'
format: int64
x-order: 0
vpcId:
description: Specifies id of the Virtual Private Cloud to chose for the instance type.
type:
- integer
- 'null'
format: int64
x-order: 1
subnetId:
description: Specifies id of the subnet within above VPC.
type:
- integer
- 'null'
format: int64
x-order: 2
CommonMssqlFileObjectProtectionParams:
description: Specifies the common params to create a File based MSSQL Object Protection.
allOf:
- $ref: '#/components/schemas/CommonMSSQLProtectionGroupParams'
GpfsObjectProtectionParams:
description: Specifies the parameters which are specific to Gpfs object protection.
type: object
properties:
protocol:
description: Specifies the protocol of the NAS device being backed up.
type:
- string
- 'null'
enum:
- kNoProtocol
- kNfs3
- kCifs1
- kCifs2
- kCifs3
x-order: 0
CommonVmwareObjectParams:
description: Specifies the common object parameters required for VMware protection.
type: object
properties:
excludeDisks:
description: Specifies a list of disks to exclude from being protected. This is only applicable to VM objects.
type: array
items:
$ref: '#/components/schemas/DiskInfo'
x-order: 0
truncateExchangeLogs:
description: Specifies whether or not to truncate MS Exchange logs while taking an app consistent snapshot of this object. This is only applicable to objects which have a registered MS Exchange app.
type:
- boolean
- 'null'
x-order: 1
ArchivalDataStats:
description: Specifies statistics about archival data.
type: object
title: Archival data statistics.
properties:
logicalSizeBytes:
description: Specifies the logicalSizeBytes.
type:
- integer
- 'null'
format: int64
x-order: 0
bytesRead:
description: Specifies total logical bytes read for creating the snapshot.
type:
- integer
- 'null'
format: int64
x-order: 1
logicalBytesTransferred:
description: Specifies the logical bytes transferred.
type:
- integer
- 'null'
format: int64
x-order: 2
physicalBytesTransferred:
description: Specifies the physical bytes transferred.
type:
- integer
- 'null'
format: int64
x-order: 3
avgLogicalTransferRateBps:
description: Specifies the average rate of transfer in bytes per second.
type:
- integer
- 'null'
format: int64
x-order: 4
fileWalkDone:
description: Specifies whether the file system walk is done. Only applicable to file based backups.
type:
- boolean
- 'null'
x-order: 5
totalFileCount:
description: Specifies the total number of file and directory entities visited in this backup. Only applicable to file based backups.
type:
- integer
- 'null'
format: int64
x-order: 6
backupFileCount:
description: Specifies the total number of file and directory entities that are backed up in this run. Only applicable to file based backups.
type:
- integer
- 'null'
format: int64
x-order: 7
CommonObjectProtectParams:
description: Specifies the common parameters for object backup. These parameters are common across all types of adapters and objects.
type: object
allOf:
- $ref: '#/components/schemas/CommonBackupParams'
FlashbladeObjectProtectionResponseParams:
description: Specifies the parameters which are specific to Flashblade object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/FlashbladeObjectProtectionParams'
ContinuousSnapshotParams:
description: Specifies the source snapshots to be taken even if there is a pending run in a protection group.
type: object
title: Continuous Snapshot Params
required:
- isEnabled
properties:
isEnabled:
description: Specifies whether source snapshots should be taken even if there is a pending run.
type:
- boolean
- 'null'
x-order: 0
maxAllowedSnapshots:
description: Specifies the maximum number of source snapshots allowed for a given object in a protection group. This is only applicable if isContinuousSnapshottingEnabled is set to true.
type:
- integer
- 'null'
format: int32
x-order: 1
HostBasedBackupScriptParams:
description: Specifies params of a pre/post scripts to be executed before and after a backup run.
type: object
title: Host Based Backup Script Params
required:
- host
properties:
host:
description: Specifies the host and its params.
type:
- object
- 'null'
x-order: 0
$ref: '#/components/schemas/ScriptHost'
preScript:
description: Specifies the pre script and its params.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/CommonPreBackupScriptParams'
postScript:
description: Specifies the post script and its params.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/CommonPostBackupScriptParams'
MssqlObjectProtectionUpdateRequestParams:
description: Specifies the update parameters specific to MSSQL object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonMssqlObjectProtectionParams'
ReplicationDataStats:
description: Specifies statistics about replication data.
type: object
title: Replication data statistics.
properties:
logicalSizeBytes:
description: Specifies the total logical size in bytes.
type:
- integer
- 'null'
format: int64
x-order: 0
logicalBytesTransferred:
description: Specifies the total logical bytes transferred.
type:
- integer
- 'null'
format: int64
x-order: 1
physicalBytesTransferred:
description: Specifies the total physical bytes transferred.
type:
- integer
- 'null'
format: int64
x-order: 2
ProtectedObjectPauseActionParams:
description: Specifies the request parameters for Pause action on Protected objects.
type: object
properties:
objects:
description: Specifies the list of objects to perform an action. If provided object id is not explicitly protected by object protection, then given action will not be performed on that.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/PauseActionObjectLevelParams'
x-order: 0
CommonNasProtectionParams:
description: Specifies the parameters which are specific to NAS Protection.
type: object
properties:
indexingPolicy:
description: Specifies the fields required to enable indexing of the protected objects such as files and directories.
type:
- object
- 'null'
x-order: 0
$ref: '#/components/schemas/IndexingPolicy'
continueOnError:
description: Specifies whether or not the backup should continue regardless of whether or not an error was encountered.
type:
- boolean
- 'null'
x-order: 1
encryptionEnabled:
description: Specifies whether the encryption should be used while backup or not.
type:
- boolean
- 'null'
x-order: 2
fileLockConfig:
description: Optional config that enables file locking for this view. It cannot be disabled during the edit of a view, if it has been enabled during the creation of the view. Also, it cannot be enabled if it was disabled during the creation of the view.
x-order: 3
$ref: '#/components/schemas/FileLevelDataLockConfig'
fileFilters:
description: Specifies file paths to include or exclude.
type:
- object
- 'null'
x-order: 4
$ref: '#/components/schemas/FileFilteringPolicy'
prePostScript:
description: Specifies the pre script and post script to run before and after the backup.
type:
- object
- 'null'
x-order: 5
$ref: '#/components/schemas/HostBasedBackupScriptParams'
throttlingConfig:
description: Specifies the source throttling parameters to be used during full or incremental backup of the NAS source.
x-order: 6
$ref: '#/components/schemas/NasThrottlingConfig'
PauseActionObjectLevelResponse:
description: Specifies the infomration about status of pause action.
type: object
properties:
error:
description: If the action fails for this object, then error will be return here.
x-order: 0
$ref: '#/components/schemas/Error'
MssqlFileObjectProtectionParams:
description: Specifies the params to create a File based MSSQL Object Protection.
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the list of objects to be protected.
type:
- array
- 'null'
minItems: 1
items:
$ref: '#/components/schemas/MssqlFileObjectProtection'
x-order: 0
- $ref: '#/components/schemas/CommonMSSQLProtectionGroupParams'
Office365ObjectProtectionObjectParams:
description: Specifies the object parameters to create a Microsoft 365 Object Protection.
type: object
title: Microsoft 365 Object Protection Object Params
required:
- id
properties:
id:
description: Specifies the id of the object.
type: integer
format: int64
x-order: 0
name:
description: Specifies the name of the object.
type:
- string
- 'null'
x-order: 1
readOnly: true
CloudSpinTarget:
description: Specifies the details about Cloud Spin target where backup snapshots may be converted and stored.
type: object
properties:
id:
description: Specifies the unique id of the cloud spin entity.
type:
- integer
- 'null'
format: int64
x-order: 0
awsParams:
description: Specifies various resources when converting and deploying a VM to AWS.
type:
- object
- 'null'
title: Contains information needed to identify various resources when deploying VMs to Cloud.
x-order: 1
$ref: '#/components/schemas/AwsCloudSpinParams'
azureParams:
description: Specifies various resources when converting and deploying a VM to Azure.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/AzureCloudSpinParams'
name:
description: Specifies the name of the already added cloud spin target.
type:
- string
- 'null'
x-order: 3
readOnly: true
VmwareCdpObject:
description: Specifies the VMware specific CDP object details.
type: object
allOf:
- $ref: '#/components/schemas/CdpObjectInfo'
- type: object
properties:
ioFilterStatus:
description: Specifies the state of CDP IO filter. CDP IO filter is an agent which will be installed on the object for performing continuous backup.
1. 'kNotInstalled' specifies that CDP is enabled on this object but filter is not installed.
2. 'kInstallFilterInProgress' specifies that IO filter installation is triggered and in progress.
3. 'kFilterInstalledIOInactive' specifies that IO filter is installed but IO streaming is disabled due to missing backup or explicitly disabled by the user.
4. 'kIOActivationInProgress' specifies that IO filter is activated to start streaming.
5. 'kIOActive' specifies that filter is attached to the object and started streaming.
6. 'kIODeactivationInProgress' specifies that deactivation has been initiated to stop the IO streaming.
7. 'kUninstallFilterInProgress' specifies that uninstallation of IO filter is in progress.
type:
- string
- 'null'
enum:
- NotInstalled
- InstallFilterInProgress
- FilterInstalledIOInactive
- FilterInstalled
- IOInactive
- IOActivationInProgress
- IOActive
- IODeactivationInProgress
- UninstallFilterInProgress
- UpgradeFilterInProgress
- UpgradeFilterFailed
x-order: 0
ioFilterErrorMessage:
description: Specifies the error message related to IO filter if there is any.
type:
- string
- 'null'
x-order: 1
ProtectedObjectBackupConfig:
description: Specifies the backup configuration for protected object.
type: object
allOf:
- $ref: '#/components/schemas/CommonObjectProtectParams'
- $ref: '#/components/schemas/EnvSpecificObjectProtectionResponseParams'
- type: object
properties:
isAutoProtectConfig:
description: Specifies whether or not this configuration is applied to an autoprotected object rather than this specific object.
type:
- boolean
- 'null'
x-order: 0
autoProtectParentId:
description: Specifies the parent ID of the object which the backup configuration is applied to if this is an auto protect config.
type:
- integer
- 'null'
format: int64
x-order: 1
isPaused:
description: Specifies whether or not protection has been paused on this object.
type:
- boolean
- 'null'
x-order: 2
isActive:
description: Specifies whether or not protection has been deactivated on this object.
type:
- boolean
- 'null'
x-order: 3
CommonMSSQLProtectionGroupParams:
description: Specifies the common params to create a MSSQL Protection Group.
type: object
title: Common MSSQL Protection Group Request Params.
properties:
userDbBackupPreferenceType:
description: Specifies the preference type for backing up user databases on the host.
type:
- string
- 'null'
enum:
- kBackupAllDatabases
- kBackupAllExceptAAGDatabases
- kBackupOnlyAAGDatabases
x-order: 0
backupSystemDbs:
description: Specifies whether to backup system databases. If not specified then parameter is set to true.
type:
- boolean
- 'null'
x-order: 1
useAagPreferencesFromServer:
description: Specifies whether or not the AAG backup preferences specified on the SQL Server host should be used.
type:
- boolean
- 'null'
x-order: 2
aagBackupPreferenceType:
description: Specifies the preference type for backing up databases that are part of an AAG. If not specified, then default preferences of the AAG server are applied. This field wont be applicable if user DB preference is set to skip AAG databases.
type:
- string
- 'null'
enum:
- kPrimaryReplicaOnly
- kSecondaryReplicaOnly
- kPreferSecondaryReplica
- kAnyReplica
x-order: 3
fullBackupsCopyOnly:
description: Specifies whether full backups should be copy-only.
type:
- boolean
- 'null'
x-order: 4
prePostScript:
description: Specifies the pre and post script parameters associated with a protection group.
type:
- object
- 'null'
x-order: 5
$ref: '#/components/schemas/PrePostScriptParams'
excludeFilters:
description: Specifies the list of exclusion filters applied during the group creation or edit. These exclusion filters can be wildcard supported strings or regular expressions. Objects satisfying the will filters will be excluded during backup and also auto protected objects will be ignored if filtered by any of the filters.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Filter'
x-order: 6
ObjectProtectionSummary:
description: Specifies the summary of a protected object.
type: object
allOf:
- $ref: '#/components/schemas/ObjectSummary'
- type: object
properties:
error:
description: Specifies the error message if an error occurred during creation of the object protection.
type:
- string
- 'null'
x-order: 0
CommonBackupParams:
description: Specifies the common parameters for backup. These parameters are common across protection group and object protection.
type: object
required:
- policyId
properties:
policyId:
description: Specifies the unique id of the Protection Policy. The Policy settings will be attached with every object and will be used in backup.
type:
- string
- 'null'
x-order: 0
storageDomainId:
description: Specifies the Storage Domain (View Box) ID where the object backup will be taken. This is not required if Cloud archive direct is benig used.
type:
- integer
- 'null'
format: int64
x-order: 1
startTime:
description: Specifies the start time for the backup to trigger. If no start time is specified, the start time will default to 2am. This field is only used if the policy has a daily or monthly schedule.
x-order: 2
$ref: '#/components/schemas/TimeOfDay'
priority:
description: Specifies the priority for the objects backup.
type:
- string
- 'null'
enum:
- kLow
- kMedium
- kHigh
x-order: 3
sla:
description: Specifies the SLA parameters for list of objects.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SlaRule'
x-order: 4
qosPolicy:
description: Specifies whether object backup will be written to HDD or SSD.
type:
- string
- 'null'
enum:
- kBackupHDD
- kBackupSSD
- kTestAndDevHigh
- kBackupAll
x-order: 5
abortInBlackouts:
description: Specifies whether currently executing object backup should abort if a blackout period specified by a policy starts. Available only if the selected policy has at least one blackout period. Default value is false.
type:
- boolean
- 'null'
x-order: 6
CommonMssqlObjectProtectionParams:
description: Specifies the common parameters for MSSQL Object Protection.
type: object
required:
- objectProtectionType
properties:
objectProtectionType:
description: Specifies the MSSQL Object Protection type.
type: string
enum:
- kFile
- kVolume
- kNative
x-order: 0
commonFileObjectProtectionTypeParams:
description: Specifies the common File based MSSQL Object Protection params.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/CommonMssqlFileObjectProtectionParams'
commonNativeObjectProtectionTypeParams:
description: Specifies the common Native based MSSQL Object Protection params.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/CommonMssqlNativeObjectProtectionParams'
Tenant:
description: Specifies a tenant object.
type: object
title: Tenant
properties:
id:
description: Specifies the id of the tenant.
type:
- string
- 'null'
x-order: 0
name:
description: Specifies the name of the tenant.
type:
- string
- 'null'
x-order: 1
CdpObjectInfo:
description: Specifies the CDP related information for a given object. This field will only be populated when protection group is configured with policy having CDP retention settings.
type: object
properties:
cdpEnabled:
description: Specifies whether CDP is currently active or not. CDP might have been active on this object before, but it might not be anymore.
type:
- boolean
- 'null'
x-order: 0
lastRunInfo:
description: Specifies the details about last continious backup taken for this object.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/CdpObjectLastRunInfo'
protectionGroupId:
description: Specifies the protection group id to which this CDP object belongs.
type:
- string
- 'null'
x-order: 2
readOnly: true
ProtectedObjectUnProtectActionParams:
description: Specifies the request parameters for Unprotect action on Protected objects.
type: object
properties:
objects:
description: Specifies the list of objects to perform an action. If provided object id is not explicitly protected by object protection, then given action will not be performed on that.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/UnprotectActionObjectLevelParams'
x-order: 0
GpfsObjectProtectionUpdateRequestParams:
description: Specifies the update parameters which are specific to Gpfs object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/GpfsObjectProtectionParams'
ReplicationTargetSummaryInfo:
description: Specifies replication target summary information.
title: Replication target.
allOf:
- $ref: '#/components/schemas/ClusterIdentifier'
- type: object
properties:
awsTargetConfig:
x-order: 0
$ref: '#/components/schemas/AWSTargetConfig'
azureTargetConfig:
x-order: 1
$ref: '#/components/schemas/AzureTargetConfig'
OracleTier:
description: Specifies the settings for a Oracle tier.
type: object
allOf:
- $ref: '#/components/schemas/CommonCloudTierSettings'
- type: object
required:
- tierType
properties:
tierType:
description: Specifies the Oracle tier types.
type:
- string
- 'null'
enum:
- kOracleTierStandard
- kOracleTierArchive
x-order: 0
Filter:
description: Specifies the filter details.
type: object
properties:
filterString:
description: Specifies the filter string using wildcard supported strings or regular expressions.
type:
- string
- 'null'
x-order: 0
isRegularExpression:
description: Specifies whether the provided filter string is a regular expression or not. This need to be explicitly set to true if user is trying to filter by regular expressions. Not providing this value in case of regular expression can result in unintended results. The default value is assumed to be false.
type:
- boolean
- 'null'
default: false
x-order: 1
Error:
description: Specifies the error object with error code and a message.
type: object
title: Error.
properties:
errorCode:
description: Specifies the error code.
type:
- string
- 'null'
x-order: 0
message:
description: Specifies the error message.
type:
- string
- 'null'
x-order: 1
ElastifileObjectProtectionUpdateRequestParams:
description: Specifies the update parameters which are specific to Elastifile object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/ElastifileObjectProtectionParams'
ProtectionObjectInput:
description: Specifies an object protected by a Protection Group.
type: object
required:
- id
properties:
id:
description: Specifies the ID of the object.
type:
- integer
- 'null'
format: int64
x-order: 0
name:
description: Specifies the name of the object.
type:
- string
- 'null'
x-order: 1
readOnly: true
DiskInfo:
description: Specifies information about a disk.
type: object
title: Disk Information
required:
- busNumber
- unitNumber
properties:
controllerType:
description: Specifies the disk controller type.
type:
- string
- 'null'
enum:
- kScsi
- kIde
- kSata
x-order: 0
unitNumber:
description: Specifies the disk file name. This is the VMDK name and not the flat file name.
type:
- integer
- 'null'
format: int64
x-order: 1
busNumber:
description: Specifies the Id of the controller bus that controls the disk.
type:
- integer
- 'null'
format: int64
x-order: 2
ProtectedObjectGroupBackupConfig:
description: Specifies the parameters of a protection group which is protecting an object.
type: object
properties:
protectionGroupId:
description: Specifies the protection group id, if given object is also protected by a protection group.
type:
- string
- 'null'
x-order: 0
protectionGroupName:
description: Specifies the protection group name, if given object is also protected by a protection group.
type:
- string
- 'null'
x-order: 1
readOnly: true
EnvSpecificObjectProtectionUpdateRequestParams:
description: Specifies the update parameters which are specific to adapter identified by enviournment.
type: object
properties:
environment:
description: Specifies the environment for current object.
type:
- string
- 'null'
enum:
- kVMware
- kHyperV
- kAzure
- kGCP
- kKVM
- kAcropolis
- kAWS
- kPhysical
- kGPFS
- kElastifile
- kNetapp
- kGenericNas
- kIsilon
- kFlashBlade
- kPure
- kSQL
- kExchange
- kAD
- kOracle
- kView
- kRemoteAdapter
- kO365
- kKubernetes
- kCassandra
- kMongoDB
- kCouchbase
- kHdfs
- kHive
- kHBase
- kUDA
x-order: 0
vmwareParams:
description: Specifies the parameters which are specific to VMware related Object Backup.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/VmwareObjectProtectionUpdateRequestParams'
genericNasParams:
description: Specifies the parameters which are specific to Generic Nas related Object Backup.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/GenericNasObjectProtectionUpdateRequestParams'
gpfsParams:
description: Specifies the parameters which are specific to Gpfs related Object Backup.
type:
- object
- 'null'
x-order: 3
$ref: '#/components/schemas/GpfsObjectProtectionUpdateRequestParams'
elastifileParams:
description: Specifies the parameters which are specific to Elastifile related Object Backup.
type:
- object
- 'null'
x-order: 4
$ref: '#/components/schemas/ElastifileObjectProtectionUpdateRequestParams'
netappParams:
description: Specifies the parameters which are specific to Netapp related Object Backup.
type:
- object
- 'null'
x-order: 5
$ref: '#/components/schemas/NetappObjectProtectionUpdateRequestParams'
isilonParams:
description: Specifies the parameters which are specific to Isilon related Object Backup.
type:
- object
- 'null'
x-order: 6
$ref: '#/components/schemas/IsilonObjectProtectionUpdateRequestParams'
flashbladeParams:
description: Specifies the parameters which are specific to Flashblade related Object Backup.
type:
- object
- 'null'
x-order: 7
$ref: '#/components/schemas/FlashbladeObjectProtectionUpdateRequestParams'
mssqlParams:
description: Specifies the parameters which are specific to Mssql related Object Backup.
type:
- object
- 'null'
x-order: 8
$ref: '#/components/schemas/MssqlObjectProtectionUpdateRequestParams'
office365UserMailboxParams:
description: Specifies the parameters which are specific to Microsoft 365 user mailbox related Object Backup.
type:
- object
- 'null'
x-order: 9
$ref: '#/components/schemas/Office365UserMailboxObjectProtectionUpdateRequestParams'
PrePostScriptParams:
description: Specifies the params for pre and post scripts.
type: object
title: Pre and Post Script Params.
properties:
preScript:
description: Specifies the pre backup script params. This script will be executed before starting backup run.
type:
- object
- 'null'
x-order: 0
$ref: '#/components/schemas/CommonPreBackupScriptParams'
postScript:
description: Specifies the post backup script params. This script will be executed after backup run finishes.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/CommonPostBackupScriptParams'
EnvSpecificObjectProtectionRequestParams:
description: Specifies the parameters which are specific to adapter identified by enviournment.
type: object
properties:
environment:
description: Specifies the environment for current object.
type:
- string
- 'null'
enum:
- kVMware
- kHyperV
- kAzure
- kGCP
- kKVM
- kAcropolis
- kAWS
- kPhysical
- kGPFS
- kElastifile
- kNetapp
- kGenericNas
- kIsilon
- kFlashBlade
- kPure
- kSQL
- kExchange
- kAD
- kOracle
- kView
- kRemoteAdapter
- kO365
- kKubernetes
- kCassandra
- kMongoDB
- kCouchbase
- kHdfs
- kHive
- kHBase
- kUDA
x-order: 0
vmwareParams:
description: Specifies the parameters which are specific to VMware related Object Backup.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/VmwareObjectProtectionRequestParams'
genericNasParams:
description: Specifies the parameters which are specific to Generic Nas related Object Backup.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/GenericNasObjectProtectionRequestParams'
gpfsParams:
description: Specifies the parameters which are specific to Gpfs related Object Backup.
type:
- object
- 'null'
x-order: 3
$ref: '#/components/schemas/GpfsObjectProtectionRequestParams'
elastifileParams:
description: Specifies the parameters which are specific to Elastifile related Object Backup.
type:
- object
- 'null'
x-order: 4
$ref: '#/components/schemas/ElastifileObjectProtectionRequestParams'
netappParams:
description: Specifies the parameters which are specific to Netapp related Object Backup.
type:
- object
- 'null'
x-order: 5
$ref: '#/components/schemas/NetappObjectProtectionRequestParams'
isilonParams:
description: Specifies the parameters which are specific to Isilon related Object Backup.
type:
- object
- 'null'
x-order: 6
$ref: '#/components/schemas/IsilonObjectProtectionRequestParams'
flashbladeParams:
description: Specifies the parameters which are specific to Flashblade related Object Backup.
type:
- object
- 'null'
x-order: 7
$ref: '#/components/schemas/FlashbladeObjectProtectionRequestParams'
mssqlParams:
description: Specifies the parameters which are specific to Mssql related Object Backup.
type:
- object
- 'null'
x-order: 8
$ref: '#/components/schemas/MssqlObjectProtectionRequestParams'
office365UserMailboxParams:
description: Specifies the parameters which are specific to Microsoft 365 user mailbox related Object Backup.
type:
- object
- 'null'
x-order: 9
$ref: '#/components/schemas/Office365UserMailboxObjectProtectionRequestParams'
GenericNasObjectProtectionUpdateRequestParams:
description: Specifies the update parameters which are specific to Generic NAS object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
ResumeActionObjectLevelParams:
description: Specifies the request parameters for Resume action on a Protected object.
type: object
allOf:
- $ref: '#/components/schemas/ProtectionObjectInput'
IsilonObjectProtectionRequestParams:
description: Specifies the parameters which are specific to Isilon object protection.
type: object
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the objects to be protected.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/ProtectionObjectInput'
x-order: 0
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/IsilonObjectProtectionParams'
CommonPostBackupScriptParams:
description: Specifies the common params for PostBackup scripts.
title: Common PostBackup Script Params
allOf:
- $ref: '#/components/schemas/CommonPrePostScriptParams'
GpfsObjectProtectionResponseParams:
description: Specifies the parameters which are specific to Gpfs object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/GpfsObjectProtectionParams'
FlashbladeObjectProtectionUpdateRequestParams:
description: Specifies the update parameters which are specific to Flashblade object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/FlashbladeObjectProtectionParams'
ProtectedObjectResumeActionParams:
description: Specifies the request parameters for Resume action on Protected objects.
type: object
properties:
objects:
description: Specifies the list of objects to perform an action. If provided object id is not explicitly protected by object protection, then given action will not be performed on that.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/ResumeActionObjectLevelParams'
x-order: 0
ScriptHost:
description: Specifies the params for the host of a pre / post script.
type: object
title: Pre/Post Script Host
properties:
hostname:
description: Specifies the Hostname or IP address of the host where the pre and post script will be run.
type:
- string
- 'null'
x-order: 0
username:
description: Specifies the username for the host.
type:
- string
- 'null'
x-order: 1
hostType:
description: Specifies the Operating system type of the host.
type:
- string
- 'null'
enum:
- kLinux
- kWindows
- kAix
- kSolaris
- kSapHana
- kOther
x-order: 2
MssqlFileObjectProtection:
description: Specifies the object params to create File based MSSQL Object Protection
type: object
required:
- id
properties:
id:
description: Specifies the ID of the object being protected. If this is a non leaf level object, then the object will be auto-protected unless leaf objects are specified for exclusion.
type:
- integer
- 'null'
format: int64
x-order: 0
MssqlObjectProtectionRequestParams:
description: Specifies the request parameters specific to MSSQL object protection.
type: object
allOf:
- $ref: '#/components/schemas/MssqlObjectProtectionParams'
MssqlObjectProtectionParams:
description: Specifies the parameters specific to MSSQL Object Protection.
type: object
required:
- objectProtectionType
properties:
objectProtectionType:
description: Specifies the MSSQL Object Protection type.
type: string
enum:
- kFile
- kVolume
- kNative
x-order: 0
fileObjectProtectionTypeParams:
description: Specifies the File based MSSQL Object Protection params.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/MssqlFileObjectProtectionParams'
nativeObjectProtectionTypeParams:
description: Specifies the Native based MSSQL Object Protection params.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/MssqlNativeObjectProtectionParams'
IsilonObjectProtectionResponseParams:
description: Specifies the parameters which are specific to Isilon object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/IsilonObjectProtectionParams'
ProtectedObjectActionResponse:
description: Specifies the response upon performing an action on protected objects.
type: object
properties:
action:
description: Specifies the action type to be performed on object getting protected. Based on selected action, provide the action params.
type: string
enum:
- Pause
- Resume
- UnProtect
- ProtectNow
x-order: 0
objects:
description: Specifies the list of objects on which the provided action was performed.
type: array
items:
$ref: '#/components/schemas/ActionObjectLevelResponse'
x-order: 1
ProtectedObjectRunNowActionParams:
description: Specifies the request parameters for RunNow action on Protected objects.
type: object
properties:
objects:
description: Specifies the list of objects to perform an action. If provided object id is not explicitly protected by object protection, then given action will not be performed on that.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/RunNowActionObjectLevelParams'
x-order: 0
ActionObjectLevelResponse:
description: Specifies the object level response params after performing an action on a protected object.
type: object
allOf:
- $ref: '#/components/schemas/ProtectionObjectInput'
- type: object
properties:
resumeStatus:
description: Specifies the infomration about status of resume action.
x-order: 0
$ref: '#/components/schemas/ResumeActionObjectLevelResponse'
pauseStatus:
description: Specifies the infomration about status of pause action.
x-order: 1
$ref: '#/components/schemas/PauseActionObjectLevelResponse'
runNowStatus:
description: Specifies the infomration about status of run now action.
x-order: 2
$ref: '#/components/schemas/RunNowActionObjectLevelResponse'
unProtectStatus:
description: Specifies the infomration about status of Unprotect action.
x-order: 3
$ref: '#/components/schemas/UnprotectActionObjectLevelResponse'
ArchivalRun:
description: Specifies information about archival run for an object.
type: object
title: Archival run information for an object.
properties:
archivalTargetResults:
description: Archival result for an archival target.
type: array
items:
$ref: '#/components/schemas/ArchivalTargetResult'
x-order: 0
GoogleTiers:
description: Specifies Google tiers.
type: object
required:
- tiers
properties:
tiers:
description: Specifies the tiers that are used to move the archived backup from current tier to next tier. The order of the tiers determines which tier will be used next for moving the archived backup. The first tier input should always be default tier where backup will be acrhived. Each tier specifies how much time after the backup will be moved to next tier from the current tier.
type:
- array
- 'null'
minLength: 1
items:
$ref: '#/components/schemas/GoogleTier'
x-order: 0
AWSTargetConfig:
description: Specifies the configuration for adding AWS as repilcation target
type: object
title: AWS Target Configuration
required:
- sourceId
- region
properties:
sourceId:
description: Specifies the source id of the AWS protection source registered on Cohesity cluster.
type:
- integer
- 'null'
format: int64
x-order: 0
name:
description: Specifies the name of the AWS Replication target.
type:
- string
- 'null'
x-order: 1
readOnly: true
region:
description: Specifies id of the AWS region in which to replicate the Snapshot to. Applicable if replication target is AWS target.
type:
- integer
- 'null'
format: int64
x-order: 2
regionName:
description: Specifies name of the AWS region in which to replicate the Snapshot to. Applicable if replication target is AWS target.
type:
- string
- 'null'
x-order: 3
readOnly: true
ElastifileObjectProtectionRequestParams:
description: Specifies the parameters which are specific to Elastifile object protection.
type: object
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the objects to be protected.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/ProtectionObjectInput'
x-order: 0
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/ElastifileObjectProtectionParams'
ReplicationRun:
description: Specifies information about replication run for an object.
type: object
title: Replication run information for an object.
properties:
replicationTargetResults:
description: Replication result for a target.
type: array
items:
$ref: '#/components/schemas/ReplicationTargetResult'
x-order: 0
ArchivalTargetResult:
description: Archival result for an archival target.
title: Archival result for a target.
allOf:
- $ref: '#/components/schemas/ArchivalTargetSummaryInfo'
- type: object
properties:
runType:
description: Type of Protection Group run. 'kRegular' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. 'kSystem' indicates system volume backup. It produces an image for bare metal recovery.
type:
- string
- 'null'
enum:
- kRegular
- kFull
- kLog
- kSystem
- kHydrateCDP
x-order: 0
isSlaViolated:
description: Indicated if SLA has been violated for this run.
type:
- boolean
- 'null'
x-order: 1
snapshotId:
description: Snapshot id for a successful snapshot. This field will not be set if the archival Run fails to take the snapshot.
type:
- string
- 'null'
x-order: 2
startTimeUsecs:
description: Specifies the start time of replication run in Unix epoch Timestamp(in microseconds) for an archival target.
type:
- integer
- 'null'
format: int64
x-order: 3
endTimeUsecs:
description: Specifies the end time of replication run in Unix epoch Timestamp(in microseconds) for an archival target.
type:
- integer
- 'null'
format: int64
x-order: 4
queuedTimeUsecs:
description: Specifies the time when the archival is queued for schedule in Unix epoch Timestamp(in microseconds) for a target.
type:
- integer
- 'null'
format: int64
x-order: 5
isIncremental:
description: Whether this is an incremental archive. If set to true, this is an incremental archive, otherwise this is a full archive.
type:
- boolean
- 'null'
x-order: 6
isForeverIncremental:
description: Whether this is forever incremental or not
type:
- boolean
- 'null'
x-order: 7
status:
description: Status of the replication run for an archival target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
type:
- string
- 'null'
enum:
- Accepted
- Running
- Canceled
- Canceling
- Failed
- Missed
- Succeeded
- SucceededWithWarning
- OnHold
x-order: 8
message:
description: Message about the archival run.
type:
- string
- 'null'
x-order: 9
progressTaskId:
description: Progress monitor task id for archival.
type:
- string
- 'null'
x-order: 10
indexingTaskId:
description: Progress monitor task for indexing.
type:
- string
- 'null'
x-order: 11
successfulObjectsCount:
description: Specifies the count of objects for which backup was successful.
type:
- integer
- 'null'
format: int64
x-order: 12
failedObjectsCount:
description: Specifies the count of objects for which backup failed.
type:
- integer
- 'null'
format: int64
x-order: 13
cancelledObjectsCount:
description: Specifies the count of objects for which backup was cancelled.
type:
- integer
- 'null'
format: int64
x-order: 14
successfulAppObjectsCount:
description: Specifies the count of app objects for which backup was successful.
type:
- integer
- 'null'
format: int32
x-order: 15
failedAppObjectsCount:
description: Specifies the count of app objects for which backup failed.
type:
- integer
- 'null'
format: int32
x-order: 16
cancelledAppObjectsCount:
description: Specifies the count of app objects for which backup was cancelled.
type:
- integer
- 'null'
format: int32
x-order: 17
stats:
description: Archival data statistics for a target.
x-order: 18
$ref: '#/components/schemas/ArchivalDataStats'
isManuallyDeleted:
description: Specifies whether the snapshot is deleted manually.
type:
- boolean
- 'null'
x-order: 19
expiryTimeUsecs:
description: Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds).
type:
- integer
- 'null'
format: int64
x-order: 20
FlashbladeObjectProtectionRequestParams:
description: Specifies the parameters which are specific to Flashblade object protection.
type: object
allOf:
- type: object
required:
- objects
properties:
objects:
description: Specifies the objects to be protected.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/ProtectionObjectInput'
x-order: 0
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/FlashbladeObjectProtectionParams'
ObjectProtectionRunInfo:
description: Specifies the run info for a run protecting an object.
title: Object Protection Run Info.
properties:
runId:
description: Specifies the ID of the protection run.
type:
- string
- 'null'
x-order: 0
runType:
description: Type of Protection run. 'kRegular' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. 'kSystem' indicates system volume backup. It produces an image for bare metal recovery.
type:
- string
- 'null'
enum:
- kRegular
- kFull
- kLog
- kSystem
- kHydrateCDP
x-order: 1
isSlaViolated:
description: Indicated if SLA has been violated for this run.
type:
- boolean
- 'null'
x-order: 2
protectionGroupId:
description: ProtectionGroupId to which this run belongs. This will only be populated if the object is protected by a protection group.
type:
- string
- 'null'
x-order: 3
protectionGroupName:
description: Name of the Protection Group to which this run belongs. This will only be populated if the object is protected by a protection group.
type:
- string
- 'null'
x-order: 4
isLocalSnapshotsDeleted:
description: Specifies if snapshots for this run has been deleted.
type:
- boolean
- 'null'
x-order: 5
isReplicationRun:
description: Specifies if this protection run is a replication run.
type:
- boolean
- 'null'
x-order: 6
isCloudArchivalDirect:
description: Specifies whether the run is a CAD run if cloud archive direct feature is enabled. If this field is true, the primary backup copy will only be available at the given archived location.
type:
- boolean
- 'null'
x-order: 7
policyId:
description: Specifies the unique id of the Protection Policy associated with the Protection Run. The Policy provides retry settings Protection Schedules, Priority, SLA, etc.
type:
- string
- 'null'
x-order: 8
policyName:
description: Specifies Specifies the name of the Protection Policy.
type:
- string
- 'null'
x-order: 9
storageDomainId:
description: Specifies the Storage Domain (View Box) ID where this Protection Run writes data.
type:
- integer
- 'null'
format: int64
x-order: 10
permissions:
description: Specifies the list of tenants that have permissions for this protection group run.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Tenant'
x-order: 11
originClusterIdentifier:
description: Specifies the information of the primary cluster if this run is a replication run.
x-order: 12
$ref: '#/components/schemas/ClusterIdentifier'
originProtectionGroupId:
description: ProtectionGroupId to which this run belongs on the primary cluster if this run is a replication run.
type:
- string
- 'null'
x-order: 13
localSnapshotInfo:
description: Information about local snapshot run for this object.
x-order: 14
$ref: '#/components/schemas/BackupRun'
originalBackupInfo:
description: Information about snapshot run on the original cluster. This only applies to replication run.
x-order: 15
$ref: '#/components/schemas/BackupRun'
replicationInfo:
description: Information about replication run for this object.
x-order: 16
$ref: '#/components/schemas/ReplicationRun'
archivalInfo:
description: Information about archival run for this object.
x-order: 17
$ref: '#/components/schemas/ArchivalRun'
cloudSpinInfo:
description: Information about Cloud Spin run for this object.
x-order: 18
$ref: '#/components/schemas/CloudSpinRun'
onLegalHold:
description: Specifies if object's snapshot is on legal hold.
type:
- boolean
- 'null'
x-order: 19
dataLock:
description: "Specifies WORM retention type for the local backeup. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept until the maximum of the snapshot retention time. During that time, the snapshots cannot be deleted. \n'Compliance' implies WORM retention is set for compliance reason. \n'Administrative' implies WORM retention is set for administrative purposes."
type:
- string
- 'null'
enum:
- Compliance
- Administrative
x-order: 20
ObjectProtectionRunSummary:
description: Specifies the response body of the get object runs request.
title: Object Protection Run Summary.
allOf:
- $ref: '#/components/schemas/ObjectIdentifier'
- $ref: '#/components/schemas/ObjectProtectionRunInfo'
AzureTiers:
description: Specifies Azure tiers.
type: object
required:
- tiers
properties:
tiers:
description: Specifies the tiers that are used to move the archived backup from current tier to next tier. The order of the tiers determines which tier will be used next for moving the archived backup. The first tier input should always be default tier where backup will be acrhived. Each tier specifies how much time after the backup will be moved to next tier from the current tier.
type:
- array
- 'null'
minLength: 1
items:
$ref: '#/components/schemas/AzureTier'
x-order: 0
ProtectedObjectInfo:
description: Specifies the details of a protected object.
type: object
allOf:
- $ref: '#/components/schemas/ObjectSummary'
- type: object
properties:
permissions:
description: Specifies the list of tenants that have permissions for this accessing given protected object.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Tenant'
x-order: 0
objectBackupConfiguration:
description: Specifies the object based protection info associated with this object.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/ProtectedObjectBackupConfig'
protectionGroupConfigurations:
description: Specifies the protection info associated with every object. There can be multiple instances of protection info since the same object can be protected in multiple protection groups.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ProtectedObjectGroupBackupConfig'
x-order: 2
lastRun:
description: Specifies the last run information for a given object. This is the most recent run across all protection groups and object backup config.
type: object
x-order: 3
$ref: '#/components/schemas/ObjectProtectionRunSummary'
SnapshotLabel:
description: Specifies the snapshot label for incremental and full backup of Secondary Netapp volumes (Data-Protect Volumes).
type: object
title: Snapshot Label
properties:
incrementalLabel:
description: Specifies the incremental snapshot label value
type:
- string
- 'null'
x-order: 0
fullLabel:
description: Specifies the full snapshot label value
type:
- string
- 'null'
x-order: 1
AWSTier:
description: Specifies the settings for a aws tier.
type: object
allOf:
- $ref: '#/components/schemas/CommonCloudTierSettings'
- type: object
required:
- tierType
properties:
tierType:
description: Specifies the AWS tier types.
type:
- string
- 'null'
enum:
- kAmazonS3Standard
- kAmazonS3StandardIA
- kAmazonS3OneZoneIA
- kAmazonS3IntelligentTiering
- kAmazonS3Glacier
- kAmazonS3GlacierDeepArchive
x-order: 0
GoogleTier:
description: Specifies the settings for a Google tier.
type: object
allOf:
- $ref: '#/components/schemas/CommonCloudTierSettings'
- type: object
required:
- tierType
properties:
tierType:
description: Specifies the Google tier types.
type:
- string
- 'null'
enum:
- kGoogleStandard
- kGoogleRegional
- kGoogleMultiRegional
- kGoogleNearline
- kGoogleColdline
x-order: 0
MssqlNativeObjectProtection:
description: Specifies the object params to create Native based MSSQL Object Protection.
type: object
required:
- id
properties:
id:
description: Specifies the ID of the object being protected. If this is a non leaf level object, then the object will be auto-protected unless leaf objects are specified for exclusion.
type:
- integer
- 'null'
format: int64
x-order: 0
CloudSpinTargetResult:
description: Cloud Spin result for a target.
title: Cloud Spin result for a target.
allOf:
- $ref: '#/components/schemas/CloudSpinTarget'
- type: object
properties:
startTimeUsecs:
description: Specifies the start time of Cloud Spin in Unix epoch Timestamp(in microseconds) for a target.
type:
- integer
- 'null'
format: int64
x-order: 0
endTimeUsecs:
description: Specifies the end time of Cloud Spin in Unix epoch Timestamp(in microseconds) for a target.
type:
- integer
- 'null'
format: int64
x-order: 1
status:
description: Status of the Cloud Spin for a target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
type:
- string
- 'null'
enum:
- Accepted
- Running
- Canceled
- Canceling
- Failed
- Missed
- Succeeded
- SucceededWithWarning
- OnHold
x-order: 2
message:
description: Message about the Cloud Spin run.
type:
- string
- 'null'
x-order: 3
stats:
description: Cloud Spin data statistics for a target.
x-order: 4
$ref: '#/components/schemas/CloudSpinDataStats'
isManuallyDeleted:
description: Specifies whether the snapshot is deleted manually.
type:
- boolean
- 'null'
x-order: 5
expiryTimeUsecs:
description: Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.
type:
- integer
- 'null'
format: int64
x-order: 6
cloudspinTaskId:
description: Task ID for a CloudSpin protection run.
type:
- string
- 'null'
x-order: 7
progressTaskId:
description: Progress monitor task id for Cloud Spin run.
type:
- string
- 'null'
x-order: 8
CdpObjectLastRunInfo:
description: Specifies the last backup information for a given CDP object.
type: object
properties:
localBackupInfo:
description: Specifies the last backup information for a given CDP object.
type:
- object
- 'null'
x-order: 0
$ref: '#/components/schemas/CdpLocalBackupInfo'
IndexingPolicy:
description: Specifies settings for indexing files found in an Object (such as a VM) so these files can be searched and recovered. This also specifies inclusion and exclusion rules that determine the directories to index.
type: object
title: Indexing Policy.
required:
- enableIndexing
properties:
enableIndexing:
description: Specifies if the files found in an Object (such as a VM) should be indexed. If true (the default), files are indexed.
type: boolean
x-order: 0
includePaths:
description: 'Array of Indexed Directories. Specifies a list of directories to index. Regular expression can also be specified to provide the directory paths. Example: /Users//AppData'
type:
- array
- 'null'
items:
type: string
x-order: 1
excludePaths:
description: 'Array of Excluded Directories. Specifies a list of directories to exclude from indexing.Regular expression can also be specified to provide the directory paths. Example: /Users//AppData'
type:
- array
- 'null'
items:
type: string
x-order: 2
CloudSpinRun:
description: Specifies information about Cloud Spin run for an object.
type: object
title: Cloud Spin run information for an object.
properties:
cloudSpinTargetResults:
description: Cloud Spin result for a target.
type: array
items:
$ref: '#/components/schemas/CloudSpinTargetResult'
x-order: 0
Office365UserMailboxObjectProtectionResponseParams:
description: Specifies the response parameters specific to Microsoft 365 User Mailbox object protection.
type: object
allOf:
- $ref: '#/components/schemas/Office365ObjectProtectionCommonParams'
BackupRun:
description: Specifies information about backup run for an object.
type: object
title: Snapshot run information for an object.
properties:
snapshotInfo:
description: Snapshot information for an object.
x-order: 0
$ref: '#/components/schemas/SnapshotInfo'
failedAttempts:
description: Failed backup attempts for an object.
type: array
items:
$ref: '#/components/schemas/BackupAttempt'
x-order: 1
securitySchemes:
APIKeyHeader:
in: header
name: apiKey
type: apiKey