openapi: 3.2.0
info:
title: Cohesity Objects API
version: '1.0'
description: 'Operations tagged Objects across 2 of this provider''s published API definitions: cohesity-cluster-v2-openapi-original.yml, cohesity-site-continuity-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /v2
- url: https://helios.cohesity.com/v2/mcm/site-continuity/v2
tags:
- name: Objects
paths:
/data-protect/objects:
get:
description: Get Objects Configurations.
tags:
- Objects
summary: Get Objects
operationId: GetProtectedObjectsOfAnyType
parameters:
- description: Filter by a list of Object ids.
name: ids
in: query
schema:
type: array
items:
type: integer
format: int64
- description: Filter by Policy ids that are associated with Protected Objects.
name: policyIds
in: query
schema:
type: array
items:
type: string
- description: Filter by Parent Id. Parent id is a unique object Id which may contain protected objects underneath in the source tree.
name: parentId
in: query
schema:
type: integer
format: int64
- description: If true, the response will include only objects which have been protected.
name: onlyProtectedObjects
in: query
schema:
type: boolean
- description: Filter by Storage Domain id. Only Objects protected to this Storage Domain will be returned.
name: storageDomainId
in: query
schema:
type: integer
format: int64
- description: Filter by environment types such as 'kVMware', 'kView', etc. Only Protected objects protecting the specified environment types are returned.
name: environments
in: query
schema:
type: array
items:
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
type: string
- description: TenantIds contains ids of the tenants for which objects are to be returned.
name: tenantIds
in: query
schema:
type: array
items:
type: string
- description: If true, the response will include Objects which were protected by all tenants which the current user has permission to see. If false, then only objects protected by the current user will be returned.
name: includeTenants
in: query
schema:
type: boolean
- description: If true, the response will include information about the last protection run on this object.
name: includeLastRunInfo
in: query
schema:
type: boolean
- description: If true, the response will include only the auto protected objects.
name: onlyAutoProtectedObjects
in: query
schema:
type: boolean
- description: If true, the response will include only the leaf level objects.
name: onlyLeafObjects
in: query
schema:
type: boolean
responses:
'200':
$ref: '#/components/responses/GetProtectedObjectsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/actions:
post:
description: Specifies the request to perform various actions on multiple objects.
tags:
- Objects
summary: Actions on Objects
operationId: ObjectsActions
responses:
'204':
$ref: '#/components/responses/NoContentResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectsActionRequest'
description: Specifies the paramteres to execute actions on given list of objects.
required: true
servers:
- url: /v2
/data-protect/objects/last-run:
get:
description: Get last protection run of objects.
tags:
- Objects
summary: Get last protection run of objects
operationId: GetObjectsLastRun
parameters:
- description: Specifies a list of object ids, only last runs for these objects will be returned.
name: ids
in: query
schema:
type: array
items:
type: integer
format: int64
- description: TenantIds contains ids of the tenants for which objects are to be returned.
name: tenantIds
in: query
schema:
type: array
items:
type: string
- description: If true, the response will include Objects which belongs to all tenants which the current user has permission to see.
name: includeTenants
in: query
schema:
type: boolean
- description: Specifies the pagination cookie with which subsequent parts of the response can be fetched.
name: paginationCookie
in: query
schema:
type: string
- description: Specifies the number of objects to be fetched for the specified pagination cookie.
name: count
in: query
schema:
type: integer
format: int32
responses:
'200':
$ref: '#/components/responses/GetObjectsLastRunResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/runs/cancel:
post:
description: Cancel object runs for object based protection. This does not apply to Group based protection.
tags:
- Objects
summary: Cancel object runs
operationId: CancelObjectRuns
responses:
'207':
$ref: '#/components/responses/CancelObjectRunsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancelObjectRunsRequest'
description: Specifies the parameters to cancel object runs.
required: true
servers:
- url: /v2
/data-protect/objects/{id}:
get:
description: Get Object configrations for given object id.
tags:
- Objects
summary: Get an Object
operationId: GetProtectedObjectOfAnyTypeById
parameters:
- description: Specifies the id of the Object.
name: id
in: path
required: true
schema:
type: integer
format: int64
- description: If true, the response will include only objects which have been protected.
name: onlyProtectedObjects
in: query
schema:
type: boolean
- description: Filter by Storage Domain id. Only Objects protected to this Storage Domain will be returned.
name: storageDomainId
in: query
schema:
type: integer
format: int64
- description: Filter by environment types such as 'kVMware', 'kView', etc. Only Protected objects protecting the specified environment types are returned.
name: environments
in: query
schema:
type: array
items:
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
type: string
- description: TenantIds contains ids of the tenants for which objects are to be returned.
name: tenantIds
in: query
schema:
type: array
items:
type: string
- description: If true, the response will include Objects which were protected by all tenants which the current user has permission to see. If false, then only objects protected by the current user will be returned.
name: includeTenants
in: query
schema:
type: boolean
- description: If true, the response will include information about the last protection run on this object.
name: includeLastRunInfo
in: query
schema:
type: boolean
- description: If true, the response will include only the auto protected objects.
name: onlyAutoProtectedObjects
in: query
schema:
type: boolean
- description: If true, the response will include only the leaf level objects.
name: onlyLeafObjects
in: query
schema:
type: boolean
responses:
'200':
$ref: '#/components/responses/ProtectedObjectResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/{id}/actions:
post:
description: Perform an action on an object. Depending on the object environment type, different actions are available.
tags:
- Objects
summary: Perform an action on an object
operationId: PerformActionOnObject
parameters:
- description: Specifies the id of the Object.
name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'204':
$ref: '#/components/responses/NoContentResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
requestBody:
content:
application/json:
schema:
x-cohesity-discriminator-ref: CommonObjectActionRequest
$ref: '#/components/schemas/CommonObjectActionRequest29deb3fe-3bb8-42f6-a5c7-b42ed20de014'
description: Specifies the parameters to perform an action on an object.
required: true
servers:
- url: /v2
/data-protect/objects/{id}/pit-ranges:
get:
description: Returns the time ranges within which the specified protected object can be restored to any Point in time.
tags:
- Objects
summary: Get PIT ranges for an object
operationId: GetPITRangesForProtectedObject
parameters:
- description: Specifies the ID of the protected object.
name: id
in: path
required: true
schema:
type: integer
format: int64
- description: If specified, return the time ranges that lie after this timestamp. This parameter is specified as the timestamp in Unix time epoch in microseconds.
name: fromTimeUsecs
in: query
schema:
type: integer
format: int64
- description: If specified, return the time ranges that lie before this timestamp. This parameter is specified as the timestamp in Unix time epoch in microseconds.
name: toTimeUsecs
in: query
schema:
type: integer
format: int64
- description: If specified, return only the points in time corresponding to these protection group IDs.
name: protectionGroupIds
in: query
schema:
type: array
items:
type: string
responses:
'200':
$ref: '#/components/responses/GetPITRangesProtectedObjectResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/{id}/runs:
get:
description: Get the runs for a particular object.
tags:
- Objects
summary: Get the list of runs for an object
operationId: GetObjectRuns
parameters:
- description: Specifies a unique id of the object.
name: id
in: path
required: true
schema:
type: integer
format: int64
- description: Specifies a unique id of the run.
name: runId
in: query
schema:
type: string
- description: Filter by a start time when the run starts. Specify the start time as a Unix epoch Timestamp (in microseconds).
name: startTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Filter by a end time when the run starts. Specify the start time as a Unix epoch Timestamp (in microseconds).
name: endTimeUsecs
in: query
schema:
type: integer
format: int64
- description: TenantIds contains ids of the tenants for which objects are to be returned.
name: tenantIds
in: query
schema:
type: array
items:
type: string
- description: If true, the response will include Protection Group Runs which were created by all tenants which the current user has permission to see. If false, then only Protection Group Runs created by the current user will be returned.
name: includeTenants
in: query
schema:
type: boolean
- description: Filter by run type. Only protection run matching the specified types will be returned.
name: runTypes
in: query
schema:
type: array
items:
enum:
- kAll
- kLog
- kSystem
- kIncremental
- kFull
type: string
uniqueItems: true
- description: Specifies a list of status for the object in the backup run.
name: localBackupObjectStatus
in: query
schema:
type: array
items:
enum:
- kInProgress
- kSuccessful
- kFailed
- kWaitingForNextAttempt
- kWarning
type: string
- description: Specifies a list of status for the object in the replication run.
name: replicationObjectStatus
in: query
schema:
type: array
items:
enum:
- kInProgress
- kSuccessful
- kFailed
- kWaitingForNextAttempt
- kWarning
type: string
- description: Specifies a list of status for the object in the archival run.
name: archivalObjectStatus
in: query
schema:
type: array
items:
enum:
- kInProgress
- kSuccessful
- kFailed
- kWaitingForNextAttempt
- kWarning
type: string
- description: Specifies a list of status for the object in the cloud spin run.
name: cloudSpinRunStatus
in: query
schema:
type: array
items:
enum:
- kInProgress
- kSuccessful
- kFailed
- kWaitingForNextAttempt
- kWarning
type: string
- description: Specifies the max number of runs. If not specified, at most 100 runs will be returned.
name: numRuns
in: query
schema:
type: integer
format: int64
- description: Specifies the pagination cookie with which subsequent parts of the response can be fetched. Users can use this to get next runs
name: paginationCookie
in: query
schema:
type: string
- description: Specifies whether to exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.
name: excludeNonRestorableRuns
in: query
schema:
type: boolean
default: false
responses:
'200':
$ref: '#/components/responses/GetObjectRunsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/{id}/runs/{runId}:
get:
description: Get a run for an object.
tags:
- Objects
summary: Get a run for an object
operationId: GetObjectRunByRunId
parameters:
- description: Specifies a unique id of the object.
name: id
in: path
required: true
schema:
type: integer
format: int64
- description: Specifies the id of the run.
name: runId
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/GetObjectRunResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/{id}/snapshots:
get:
description: List the snapshots for a given object.
tags:
- Objects
summary: List the snapshots for a given object
operationId: GetObjectSnapshots
parameters:
- description: Specifies the id of the Object.
name: id
in: path
required: true
schema:
type: integer
format: int64
- description: Specifies the timestamp in Unix time epoch in microseconds to filter Object's snapshots which were taken after this value.
name: fromTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Specifies the timestamp in Unix time epoch in microseconds to filter Object's snapshots which were taken before this value.
name: toTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Specifies the timestamp in Unix time epoch in microseconds to filter Object's snapshots which were run after this value.
name: runStartFromTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Specifies the timestamp in Unix time epoch in microseconds to filter Object's snapshots which were run before this value.
name: runStartToTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Filter by run type. Only protection run matching the specified types will be returned. By default, CDP hydration snapshots are not included, unless explicitly queried using this field.
name: runTypes
in: query
schema:
type: array
items:
enum:
- kRegular
- kFull
- kLog
- kSystem
- kHydrateCDP
type: string
uniqueItems: true
- description: If specified, this returns only the snapshots of the specified object ID, which belong to the provided protection group IDs.
name: protectionGroupIds
in: query
schema:
type: array
items:
type: string
- description: Filter by a list run instance ids. If specified, only snapshots created by these protection runs will be returned.
name: runInstanceIds
in: query
schema:
type: array
items:
type: integer
format: int64
responses:
'200':
$ref: '#/components/responses/GetObjectSnapshotsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/{id}/snapshots/{snapshotId}:
put:
description: Update an object snapshot.
tags:
- Objects
summary: Update an object snapshot
operationId: UpdateObjectSnapshot
parameters:
- description: Specifies the id of the Object.
name: id
in: path
required: true
schema:
type: integer
format: int64
- description: 'Specifies the id of the snapshot.
Note: 1. If the snapshotid of one of the apps is specified, it applies for all the databases in the Protection Run.
2. In case of volume based jobs, please specify the snapshotid of the source not the database. if source snapshot is specified, applied to source snapshot. if database snapshotid is specified in case of volume based jobs, then it is applicable for host''s snapshot.'
name: snapshotId
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/UpdateObjectSnapshotResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateObjectSnapshotRequest'
description: Specifies the parameters update an object snapshot.
required: true
servers:
- url: /v2
/data-protect/objects/{id}/stats:
get:
description: Get stats for a given object.
tags:
- Objects
summary: Get stats for a given object
operationId: GetObjectStats
parameters:
- description: Specifies the id of the Object.
name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
$ref: '#/components/responses/GetObjectStatsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/{id}/tree:
get:
description: Get the objects tree hierarchy for for an Object. If the object does not have a hierarchy then a single object will be returned.
tags:
- Objects
summary: Get the objects tree hierarchy for for an Object
operationId: GetObjectTree
parameters:
- description: Specifies the id of the Object.
name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
$ref: '#/components/responses/ObjectTreeResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/{objectId}/indexed-objects/snapshots:
get:
description: Get snapshots of indexed object.
tags:
- Objects
summary: Get snapshots of indexed object
operationId: GetAllIndexedObjectSnapshots
parameters:
- description: Specifies the object id.
name: objectId
in: path
required: true
schema:
type: integer
format: int64
- description: Specifies the indexed object name.
name: indexedObjectName
in: query
required: true
schema:
type: string
- description: Specifies the protection group id.
name: protectionGroupId
in: query
schema:
type: string
- description: Specifies whether to only return snapshots which are indexed. In an indexed snapshot files are guaranteed to exist, while in a non-indexed snapshot files may not exist.
name: includeIndexedSnapshotsOnly
in: query
schema:
type: boolean
default: false
- description: Specifies the timestamp in Unix time epoch in microseconds to filter indexed object's snapshots which are taken after this value.
name: fromTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Specifies the timestamp in Unix time epoch in microseconds to filter indexed object's snapshots which are taken before this value.
name: toTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Filter by run type. Only protection run matching the specified types will be returned. By default, CDP hydration snapshots are not included, unless explicitly queried using this field.
name: runTypes
in: query
schema:
type: array
items:
enum:
- kRegular
- kFull
- kLog
- kSystem
- kHydrateCDP
type: string
uniqueItems: true
responses:
'200':
$ref: '#/components/responses/GetIndexedObjectSnapshotsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/objects/{objectId}/protection-groups/{protectionGroupId}/indexed-objects/snapshots:
get:
description: Get snapshots of indexed object.
tags:
- Objects
summary: Get snapshots of indexed object
operationId: GetIndexedObjectSnapshots
parameters:
- description: Specifies the protection group id.
name: protectionGroupId
in: path
required: true
schema:
type: string
- description: Specifies the object id.
name: objectId
in: path
required: true
schema:
type: integer
format: int64
- description: Specifies the indexed object name.
name: indexedObjectName
in: query
required: true
schema:
type: string
- description: Specifies whether to only return snapshots which are indexed. In an indexed snapshots file are guaranteened to exist, while in a non-indexed snapshots file may not exist.
name: includeIndexedSnapshotsOnly
in: query
schema:
type: boolean
default: false
- description: Specifies the timestamp in Unix time epoch in microseconds to filter indexed object's snapshots which are taken after this value.
name: fromTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Specifies the timestamp in Unix time epoch in microseconds to filter indexed object's snapshots which are taken before this value.
name: toTimeUsecs
in: query
schema:
type: integer
format: int64
- description: Filter by run type. Only protection run matching the specified types will be returned. By default, CDP hydration snapshots are not included, unless explicitly queried using this field.
name: runTypes
in: query
schema:
type: array
items:
enum:
- kRegular
- kFull
- kLog
- kSystem
- kHydrateCDP
type: string
uniqueItems: true
responses:
'200':
$ref: '#/components/responses/GetIndexedObjectSnapshotsResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/snapshots/{snapshotId}:
get:
description: Get details of object snapshot.
tags:
- Objects
summary: Get details of object snapshot
operationId: GetObjectSnapshotInfo
parameters:
- description: Specifies the snapshot id.
name: snapshotId
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/GetObjectSnapshotInfoResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/snapshots/{snapshotId}/metaInfo:
post:
description: Construct meta info from object snapshot and some additional params.
tags:
- Objects
summary: Construct meta info for any workflow from object snapshot and some other…
operationId: ConstructMetaInfo
parameters:
- description: Specifies the snapshot id.
name: snapshotId
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/ConstructMetaInfoResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConstructMetaInfoParams'
description: Specifies the parameters to construct meta info for desired workflow.
required: true
servers:
- url: /v2
/data-protect/snapshots/{snapshotId}/volume:
get:
description: Get volume info of object snapshot.
tags:
- Objects
summary: Get volume info of object snapshot
operationId: GetObjectSnapshotVolumeInfo
parameters:
- description: Specifies the snapshot id.
name: snapshotId
in: path
required: true
schema:
type: string
- description: Specifies whether to only return supported volumes.
name: includeSupportedOnly
in: query
schema:
type: boolean
- description: Specifies the point-in-time timestamp (in usecs from epoch) between snapshots for which the volume info is to be returned.
name: pointInTimeUsecs
in: query
schema:
type: number
format: int64
responses:
'200':
$ref: '#/components/responses/GetObjectSnapshotVolumeInfoResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/data-protect/sources/{sourceId}/objects:
get:
description: List objects which can be used for data protection.
tags:
- Objects
summary: List objects on a source which can be used for data protection
operationId: GetSourceHierarchyObjects
parameters:
- description: Specifies the source ID for which objects should be returned.
name: sourceId
in: path
required: true
schema:
type: integer
format: int64
- description: Specifies the parent ID under which objects should be returned.
name: parentId
in: query
schema:
type: integer
format: int64
- description: TenantIds contains ids of the tenants for which objects are to be returned.
name: tenantIds
in: query
schema:
type: array
items:
type: string
- description: If true, the response will include Objects which belongs to all tenants which the current user has permission to see.
name: includeTenants
in: query
schema:
type: boolean
- description: Specifies the VMware object types to filter objects.
name: vmwareObjectTypes
in: query
schema:
type: array
items:
enum:
- kVCenter
- kStandaloneHost
- kvCloudDirector
- kFolder
- kDatacenter
- kComputeResource
- kClusterComputeResource
- kResourcePool
- kDatastore
- kHostSystem
- kVirtualMachine
- kVirtualApp
- kStoragePod
- kNetwork
- kDistributedVirtualPortgroup
- kTagCategory
- kTag
- kOpaqueNetwork
- kOrganization
- kVirtualDatacenter
- kCatalog
- kOrgMetadata
- kStoragePolicy
- kVirtualAppTemplate
type: string
- description: Specifies the Netapp object types to filter objects.
name: netappObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kVserver
- kVolume
type: string
- description: Specifies the Office 365 object types to filter objects.
name: o365ObjectTypes
in: query
schema:
type: array
items:
enum:
- kDomain
- kOutlook
- kMailbox
- kUsers
- kGroups
- kSites
- kUser
- kGroup
- kSite
- kApplication
- kGraphUser
- kPublicFolders
- kPublicFolder
- kTeams
- kTeam
type: string
- description: Specifies the Cassandra object types to filter objects.
name: cassandraObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kKeyspace
- kTable
type: string
- description: Specifies the Mongo DB object types to filter objects.
name: mongodbObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kDatabase
- kCollection
type: string
- description: Specifies the Couchbase object types to filter objects.
name: couchbaseObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kBucket
type: string
- description: Specifies the HDFS object types to filter objects.
name: hdfsObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
type: string
- description: Specifies the Hbase object types to filter objects.
name: hbaseObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kNamespace
- kTable
type: string
- description: Specifies the Hive object types to filter objects.
name: hiveObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kDatabase
- kTable
type: string
- description: Specifies the HyperV object types to filter objects.
name: hypervObjectTypes
in: query
schema:
type: array
items:
enum:
- kSCVMMServer
- kStandaloneHost
- kStandaloneCluster
- kHostGroup
- kHypervHost
- kHostCluster
- kVirtualMachine
- kNetwork
- kDatastore
- kTag
- kCustomProperty
type: string
- description: Specifies the Azure object types to filter objects.
name: azureObjectTypes
in: query
schema:
type: array
items:
enum:
- kSubscription
- kResourceGroup
- kVirtualMachine
- kStorageAccount
- kStorageKey
- kStorageContainer
- kStorageBlob
- kNetworkSecurityGroup
- kVirtualNetwork
- kSubnet
- kComputeOptions
- kSnapshotManagerPermit
- kTag
- kAvailabilitySet
type: string
- description: Specifies the KVM object types to filter objects.
name: kvmObjectTypes
in: query
schema:
type: array
items:
enum:
- kOVirtManager
- kStandaloneHost
- kDatacenter
- kCluster
- kHost
- kVirtualMachine
- kNetwork
- kStorageDomain
- kVNicProfile
type: string
- description: Specifies the AWS object types to filter objects.
name: awsObjectTypes
in: query
schema:
type: array
items:
enum:
- kIAMUser
- kRegion
- kAvailabilityZone
- kEC2Instance
- kVPC
- kSubnet
- kNetworkSecurityGroup
- kInstanceType
- kKeyPair
- kTag
- kRDSOptionGroup
- kRDSParameterGroup
- kRDSInstance
- kRDSSubnet
- kRDSTag
- kAuroraCluster
- kAccount
- kSubTaskPermit
type: string
- description: Specifies the GCP object types to filter objects.
name: gcpObjectTypes
in: query
schema:
type: array
items:
enum:
- kIAMUser
- kProject
- kRegion
- kAvailabilityZone
- kVirtualMachine
- kVPC
- kSubnet
- kNetworkSecurityGroup
- kInstanceType
- kLabel
- kMetadata
- kTag
- kVPCConnector
type: string
- description: Specifies the Acropolis object types to filter objects.
name: acropolisObjectTypes
in: query
schema:
type: array
items:
enum:
- kPrismCentral
- kStandaloneCluster
- kOtherHypervisorCluster
- kCluster
- kHost
- kVirtualMachine
- kNetwork
- kStorageContainer
type: string
- description: Specifies the generic NAS object types to filter objects.
name: genericNasObjectTypes
in: query
schema:
type: array
items:
enum:
- kGroup
- kHost
- kDfsGroup
- kDfsTopDir
type: string
- description: Specifies the Isilon object types to filter objects.
name: isilonObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kZone
- kMountPoint
type: string
- description: Specifies the Flashblade object types to filter objects.
name: flashbladeObjectTypes
in: query
schema:
type: array
items:
enum:
- kStorageArray
- kFileSystem
type: string
- description: Specifies the Elastifile object types to filter objects.
name: elastifileObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kContainer
type: string
- description: Specifies the GPFS object types to filter objects.
name: gpfsObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kFilesystem
- kFileset
type: string
- description: Specifies the Pure object types to filter objects.
name: pureObjectTypes
in: query
schema:
type: array
items:
enum:
- kStorageArray
- kVolume
type: string
- description: Specifies the Nimble object types to filter objects.
name: nimbleObjectTypes
in: query
schema:
type: array
items:
enum:
- kStorageArray
- kVolume
type: string
- description: Specifies the Physical object types to filter objects.
name: physicalObjectTypes
in: query
schema:
type: array
items:
enum:
- kGroup
- kHost
- kWindowsCluster
- kOracleRACCluster
- kOracleAPCluster
type: string
- description: Specifies the Kubernetes object types to filter objects.
name: kubernetesObjectTypes
in: query
schema:
type: array
items:
enum:
- kCluster
- kNamespace
- kService
- kPVC
- kLabel
type: string
- description: Specifies the Exchange object types to filter objects.
name: exchangeObjectTypes
in: query
schema:
type: array
items:
enum:
- kRootContainer
- kDAGRootContainer
- kExchangeNode
- kExchangeDAGDatabaseCopy
- kExchangeStandaloneDatabase
- kExchangeDAG
- kExchangeDAGDatabase
type: string
- description: Specifies the AD object types to filter objects.
name: adObjectTypes
in: query
schema:
type: array
items:
enum:
- kRootContainer
- kDomainController
type: string
- description: Specifies the MSSQL object types to filter objects.
name: mssqlObjectTypes
in: query
schema:
type: array
items:
enum:
- kInstance
- kDatabase
- kAAG
- kAAGRootContainer
- kRootContainer
type: string
- description: Specifies the Oracle object types to filter objects.
name: oracleObjectTypes
in: query
schema:
type: array
items:
enum:
- kRACRootContainer
- kRootContainer
- kHost
- kDatabase
- kTableSpace
- kTable
- kPDB
type: string
responses:
'200':
$ref: '#/components/responses/SourceHierarchyObjectSummariesResponse'
default:
$ref: '#/components/responses/ErrorResponse'
security:
- APIKeyHeader: []
servers:
- url: /v2
/objects/operations:
post:
description: 'Privileges: DRAAS_MODIFY
Initiate operations to check, gather information and
perform computations using objects.'
tags:
- Objects
summary: Initiates asynchronous operations
operationId: SCCreateObjectsOperation
responses:
201:
$ref: '#/components/responses/SCCreateObjectsOperationResponse'
default:
$ref: '#/components/responses/SCErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SCCreateObjectsOperationParams'
description: Specifies the parameters to perform operation using objects.
required: true
security:
- ApiKeyAuth: []
servers:
- url: https://helios.cohesity.com/v2/mcm/site-continuity/v2
/objects/operations/{operationId}:
get:
description: 'Privileges: DRAAS_VIEW
Get results of operation using objects.'
tags:
- Objects
summary: Returns an operation by ID
operationId: SCGetObjectsOperationResults
parameters:
- name: operationId
description: Specifies the operation id to track the progress of operation performed using objects.
in: path
required: true
schema:
type: string
responses:
200:
$ref: '#/components/responses/SCGetObjectsOperationResultsResponse'
default:
$ref: '#/components/responses/SCErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: https://helios.cohesity.com/v2/mcm/site-continuity/v2
components:
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
OracleRestoreMetaInfoResult:
description: Result to store oracle meta-info from snapshot id and other oracle params.
type: object
title: OracleRestoreMetaInfoResult
properties:
restrictedPfileParamMap:
description: Specifies map for restricted pfile params.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/KeyValuePair'
x-order: 0
inheritedPfileParamMap:
description: Specifies map for inherited pfile params.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/KeyValuePair'
x-order: 1
cohesityPfileParamMap:
description: Specifies map for cohesity controlled pfile params.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/KeyValuePair'
x-order: 2
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'
CommonNasObjectParams:
description: Specifies the common parameters for NAS objects.
type: object
properties:
supportedNasMountProtocols:
description: Specifies a list of NAS mount protocols supported by this object.
type:
- array
- 'null'
items:
type: string
enum:
- kNoProtocol
- kNfs3
- kCifs1
- kCifs2
- kCifs3
x-order: 0
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'
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'
CancelObjectRunsResults:
description: Results after canceling object runs. If no errors happen, this will not be returned.
type: object
properties:
results:
description: Specifies results after canceling object runs.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CancelObjectRunsResult'
x-order: 0
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
RecoveryTimeRangeInfo:
description: Specifies a valid time range to which this object can be recovered.
type: object
title: Time range.
properties:
startTimeUsecs:
description: Specifies the start time of this time range.
type:
- integer
- 'null'
format: int64
x-order: 0
endTimeUsecs:
description: Specifies the end time of this time range.
type:
- integer
- 'null'
format: int64
x-order: 1
protectionGroupId:
description: Specifies id of the Protection Group corresponding to this time range.
type:
- string
- 'null'
pattern: ^\d+:\d+:\d+$
x-order: 2
NetappObjectParams:
description: Specifies the common parameters for Netapp objects.
type: object
properties:
supportedNasMountProtocols:
description: Specifies a list of NAS mount protocols supported by this object.
type:
- array
- 'null'
items:
type: string
enum:
- kNfs
- kCifs
- kIscsi
- kFc
- kFcache
- kHttp
- kNdmp
- kManagement
- kNvme
x-order: 0
volumeType:
description: Specifies the Netapp volume type.
type:
- string
- 'null'
enum:
- ReadWrite
- LoadSharing
- DataProtection
- DataCache
- Temp
- UnkownType
x-order: 1
CancelObjectRunsResult:
description: Result after canceling object runs.
type: object
properties:
objectId:
description: Specifies the id of the object.
type:
- integer
- 'null'
format: int64
x-order: 0
errorMessage:
description: Specifies the error message if any error happens.
type:
- string
- 'null'
x-order: 1
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'
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
GetProtectedObjectsResponse:
description: Specifies the protected objects response.
type: object
properties:
objects:
description: Specifies the protected object backup configuration and lastRun details if it has happned.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ProtectedObjectInfo'
x-order: 0
paginationInfo:
description: Specifies the information needed in order to support pagination. This will not be included for the last page of results.
x-order: 1
$ref: '#/components/schemas/PaginationInfo'
Object:
description: Specifies information about an object.
title: Object information
allOf:
- $ref: '#/components/schemas/CommonObjectSummary'
- type: object
properties:
vmwareParams:
description: Specifies the parameters which are specific to VMware objects.
type:
- object
- 'null'
x-cohesity-discriminator-value: kVMware
x-order: 0
$ref: '#/components/schemas/VmwareObjectEntityParams'
isilonParams:
description: Specifies the parameters for Isilon object.
allOf:
- $ref: '#/components/schemas/IsilonObjectParams'
- {}
x-order: 1
netappParams:
description: Specifies the parameters for NetApp object.
allOf:
- $ref: '#/components/schemas/NetappObjectParams'
- {}
x-order: 2
genericNasParams:
description: Specifies the parameters for GenericNas object.
allOf:
- $ref: '#/components/schemas/CommonNasObjectParams'
- {}
x-order: 3
flashbladeParams:
description: Specifies the parameters for Flashblade object.
allOf:
- $ref: '#/components/schemas/FlashbladeObjectParams'
- {}
x-order: 4
elastifileParams:
description: Specifies the parameters for Elastifile object.
allOf:
- $ref: '#/components/schemas/CommonNasObjectParams'
- {}
x-order: 5
gpfsParams:
description: Specifies the parameters for GPFS object.
allOf:
- $ref: '#/components/schemas/CommonNasObjectParams'
- {}
x-order: 6
mssqlParams:
description: Specifies the parameters for Msssql object.
allOf:
- $ref: '#/components/schemas/MssqlObjectEntityParams'
- {}
x-order: 7
oracleParams:
description: Specifies the parameters for Oracle object.
allOf:
- $ref: '#/components/schemas/OracleObjectEntityParams'
- {}
x-order: 8
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'
DeviceTreeNode:
description: Specifies the tree structure of a logical volume. The leaves are slices of partitions and the other nodes are assemled by combining nodes in some mode.
type: object
properties:
isLeaf:
description: Specifies if the node is a leaf node.
type:
- boolean
- 'null'
x-order: 0
leafNodeParams:
description: Specifies the parameters for a leaf node.
allOf:
- $ref: '#/components/schemas/DeviceTreeLeafNode'
- {}
x-order: 1
nonLeafNodeParams:
description: Specifies the parameters for a non leaf node.
allOf:
- $ref: '#/components/schemas/DeviceTreeNonLeafNode'
- {}
x-order: 2
OracleObjectEntityParams:
description: Object details for Oracle.
type: object
properties:
databaseEntityInfo:
description: Specifies the database entity information about the type of Oracle database.
type:
- object
- 'null'
x-order: 0
$ref: '#/components/schemas/DatabaseEntityInfo'
hostInfo:
description: Specifies the host information for the Oracle object.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/HostInformation'
CommonObjectSnapshotVolumeParams:
description: Specifies volume info of snapshot across all enviroments.
type: object
properties:
volumes:
description: Specifies a list of volume info.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/VolumeInfo'
x-order: 0
CancelObjectRunParams:
description: One object run to cancel.
type: object
required:
- runId
properties:
runId:
description: Specifies the id of the run to cancel.
type:
- string
- 'null'
x-order: 0
cancelLocalRun:
description: Specifies whether to cancel the local backup run. Default is false.
type:
- boolean
- 'null'
x-order: 1
archivalTargetIds:
description: Specifies the archival target ids where the tasks run. If specified, the archival target ids must be present within the run specified by the runId above.
type:
- array
- 'null'
items:
type: integer
format: int64
x-order: 2
replicationTargets:
description: Specifies the cluster identifiers where the tasks run. If specified, the archival target ids must be present within the run specified by the runId above.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ClusterIdentifier'
x-order: 3
cloudSpinTargetIds:
description: Specifies the cloud spin target ids where the tasks run. If specified, the archival target ids must be present within the run specified by the runId above.
type:
- array
- 'null'
items:
type: integer
format: int64
x-order: 4
HostInformation:
description: Specifies the host information for a objects. This is mainly populated in case of App objects where app object is hosted by another object such as VM or physical server.
type: object
properties:
id:
description: Specifies the id of the host object.
type:
- string
- 'null'
x-order: 0
name:
description: Specifies the name of the host object.
type:
- string
- 'null'
x-order: 1
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: 2
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
FlashbladeObjectParams:
description: Specifies the common parameters for Flashblade objects.
type: object
properties:
supportedNasMountProtocols:
description: Specifies a list of NAS mount protocols supported by this object.
type:
- array
- 'null'
items:
type: string
enum:
- kNfs
- kCifs2
- kHttp
x-order: 0
KeyValuePair:
description: Specifies a map structure to store Key and Values.
type: object
title: KeyValuePair
required:
- key
- value
properties:
key:
description: key
type:
- string
- 'null'
x-order: 0
value:
description: value
type:
- string
- 'null'
x-order: 1
GetIndexedObjectSnapshotsResponseBody:
description: Specifies the snapshots of an indexed object.
type: object
properties:
snapshots:
description: Specifies a list of snapshots containing the indexed object.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/IndexedObjectSnapshot'
x-order: 0
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'
CancelObjectRunsParams:
description: Request to cancel object runs.
type: object
required:
- objectId
properties:
objectId:
description: Specifies object id
type:
- integer
- 'null'
format: int64
x-order: 0
runsConfig:
description: Specifies a list of runs to cancel. If no runs are specified, then all the outstanding runs will be canceled.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CancelObjectRunParams'
x-order: 1
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
IndexedObjectSnapshot:
description: Specifies a snapshot containing the indexed object.
type: object
properties:
indexedObjectName:
description: Specifies the indexed object name.
type:
- string
- 'null'
x-order: 0
objectSnapshotid:
description: Specifies snapshot id of the object containing this indexed object.
type:
- string
- 'null'
x-order: 1
snapshotTimestampUsecs:
description: Specifies a unix timestamp when the object snapshot was taken in micro seconds.
type:
- integer
- 'null'
format: int64
x-order: 2
runType:
description: Specifies the type of protection run created this snapshot.
type:
- string
- 'null'
enum:
- kRegular
- kFull
- kLog
- kSystem
- kHydrateCDP
x-order: 3
protectionGroupId:
description: Specifies the protection group id which contains this snapshot.
type:
- string
- 'null'
x-order: 4
protectionGroupName:
description: Specifies the protection group name which contains this snapshot.
type:
- string
- 'null'
x-order: 5
storageDomainId:
description: Specifies the storage domain id containing this snapshot.
type:
- integer
- 'null'
format: int64
x-order: 6
attempts:
description: Specifies the number of runs have been executed before the run completed successfully.
type:
- integer
- 'null'
format: int64
x-order: 7
sizeBytes:
description: Specifies the indexed object size in bytes.
type:
- integer
- 'null'
format: int64
x-order: 8
lastModifiedTimeUsecs:
description: Specifies the last time file was modified in unix timestamp.
type:
- integer
- 'null'
format: int64
x-order: 9
externalTargetInfo:
description: Specifies the external target information if this is an archival snapshot.
allOf:
- $ref: '#/components/schemas/ArchivalTargetSummaryInfo'
- {}
x-order: 10
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
ObjectStats:
description: Specifies the object stats.
type: object
title: Object Stats.
properties:
snapshotsSummary:
description: Specifies a summary of the object snapshots.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SnapshotsSummary'
x-order: 0
AzureSnapshotParams:
description: Specifies parameters of Azure type snapshots.
type: object
properties:
protectionType:
description: Specifies the protection type of Azure snapshots.
type:
- string
- 'null'
enum:
- kAgent
- kNative
- kSnapshotManager
x-order: 0
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
GetPITRangesProtectedObjectResponseBody:
description: Specifies the points in time available for restore as a set of one or more time ranges. If the number of available ranges exceeds 1000, then the latest 1000 will be returned.
type: object
title: Points in time for restore
properties:
timeRanges:
description: Specifies the time ranges within which this object can be restored to any point in time. If the number of available ranges exceeds 1000, then the latest 1000 will be returned.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RecoveryTimeRangeInfo'
x-order: 0
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
SourceHierarchyObjectSummary:
description: Specifies the list of Object Summaries for Objects under a given Source.
type: object
title: SourceHierarchyObjectSummaries
allOf:
- $ref: '#/components/schemas/ObjectSummary'
- type: object
properties:
parentId:
description: Specifies the ID of the direct parent of this object in the source hierarchy.
type:
- integer
- 'null'
format: int64
x-order: 0
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
CommonObjectActionRequest29deb3fe-3bb8-42f6-a5c7-b42ed20de014:
description: Specifies the common request parameters for performing an action on Object.
type: object
title: Common Object Action Request.
required:
- environment
properties:
environment:
description: Specifies the environment type 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: 0
x-cohesity-discriminator-details:
propertyName: environment
x-discriminator:
mapping:
kVMware: '#/definitions/CommonObjectActionRequest29deb3fe-3bb8-42f6-a5c7-b42ed20de014VmwareObjectActionParamsWrapper'
propertyName: environment
PermissionInfo:
description: Specifies the list of users, groups and users that have permissions for a given object.
type: object
title: Permissions Information
properties:
objectId:
description: Specifies the id of the object.
type:
- integer
- 'null'
format: int64
x-order: 0
users:
description: Specifies the list of users which has the permissions to the object.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/User'
x-order: 1
groups:
description: Specifies the list of user groups which has permissions to the object.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Group'
x-order: 2
tenant:
description: Specifies the tenant which has access to the object.
type:
- object
- 'null'
x-order: 3
$ref: '#/components/schemas/Tenant'
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'
ObjectsActionRequest:
description: Specifies the type of the action need to be performed on given set of objects.
type: object
properties:
action:
description: Specifies the action type that need to be performed.
type:
- string
- 'null'
enum:
- Link
- UnLink
x-order: 0
linkParams:
description: Specifies the parameters for object linking.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/ObjectLinkingParams'
unLinkParams:
description: Specifies the parameters for object unlinking.
type:
- object
- 'null'
x-order: 2
$ref: '#/components/schemas/ObjectUnLinkingParams'
ObjectWithChildren:
description: Specifies information of the object and its children objects.
title: Object information
allOf:
- $ref: '#/components/schemas/Object'
- type: object
properties:
objects:
description: Specifies a list of child nodes for this specific node.
type: array
items:
$ref: '#/components/schemas/ObjectWithChildren'
x-go-name: ObjectNode
x-order: 0
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
CommonObjectsActionParams:
description: Specifies the comon action params needed for performing bulk actions on list of objects.
type: object
properties:
objectMap:
description: Specifies the objectMap that will be used to perform bulk actions such as linking and unlinking.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ActionObjectMapping'
x-order: 0
SourceHierarchyObjectSummaries:
description: Specifies a list of Source Hierarchy Object Summaries.
type: object
title: ObjectSummaries
properties:
objects:
description: Specifies a list of Source Hierarchy Object summaries.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SourceHierarchyObjectSummary'
x-order: 0
PhysicalSnapshotParams:
description: Specifies paramsters of Physical type snapshots.
type: object
properties:
protectionType:
description: Specifies the protection type of Physical snapshots.
type:
- string
- 'null'
enum:
- kFile
- kVolume
x-order: 0
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
GetObjectRunsResponseBody:
description: Specifies the response body of the get object run request.
title: Get Object Run Response Body.
properties:
protectionRuns:
description: Specifies the protection runs of the given object.
type: array
items:
$ref: '#/components/schemas/ObjectProtectionRunSummary'
x-order: 0
paginationInfo:
description: Specifies the information needed in order to support pagination. This will not be included for the last page of results.
x-order: 1
$ref: '#/components/schemas/PaginationInfo'
ObjectSnapshotVolumeInfo:
description: Detail info of an object snapshot volume.
allOf:
- $ref: '#/components/schemas/CommonObjectSnapshotVolumeParams'
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
ObjectSnapshot:
description: Specifies an Object Snapshot.
type: object
title: Object Snapshot.
properties:
id:
description: Specifies the id of the snapshot.
type:
- string
- 'null'
x-order: 0
snapshotTargetType:
description: Specifies the target type where the Object's snapshot resides.
type:
- string
- 'null'
enum:
- Local
- Archival
x-order: 1
indexingStatus:
description: Specifies the indexing status of objects in this snapshot.
'InProgress' indicates the indexing is in progress.
'Done' indicates indexing is done.
'NoIndex' indicates indexing is not applicable.
'Error' indicates indexing failed with error.
type:
- string
- 'null'
enum:
- InProgress
- Done
- NoIndex
- Error
x-order: 2
protectionGroupId:
description: Specifies id of the Protection Group.
type:
- string
- 'null'
pattern: ^\d+:\d+:\d+$
x-order: 3
protectionGroupName:
description: Specifies name of the Protection Group.
type:
- string
- 'null'
x-order: 4
protectionGroupRunId:
description: Specifies id of the Protection Group Run.
type:
- string
- 'null'
pattern: ^\d+:\d+$
x-order: 5
runInstanceId:
description: Specifies the instance id of the protection run which create the snapshot.
type:
- integer
- 'null'
format: int64
x-order: 6
runStartTimeUsecs:
description: Specifies the start time of the run in micro seconds.
type:
- integer
- 'null'
format: int64
x-order: 7
sourceGroupId:
description: Specifies the source protection group id in case of replication.
type:
- string
- 'null'
x-order: 8
runType:
description: Specifies the type of protection run created this snapshot.
type:
- string
- 'null'
enum:
- kRegular
- kFull
- kLog
- kSystem
- kHydrateCDP
x-order: 9
environment:
description: Specifies the snapshot environment.
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: 10
snapshotTimestampUsecs:
description: Specifies the timestamp in Unix time epoch in microseconds when the snapshot is taken for the specified Object.
type:
- integer
- 'null'
format: int64
x-order: 11
expiryTimeUsecs:
description: Specifies the expiry time of the snapshot in Unix timestamp epoch in microseconds. If the snapshot has no expiry, this property will not be set.
type:
- integer
- 'null'
format: int64
x-order: 12
externalTargetInfo:
description: Specifies the external target information if this is an archival snapshot.
allOf:
- $ref: '#/components/schemas/ArchivalTargetSummaryInfo'
- {}
x-order: 13
storageDomainId:
description: Specifies the Storage Domain id where the snapshot of object is present.
type:
- integer
- 'null'
format: int64
x-order: 14
hasDataLock:
description: Specifies if this snapshot has datalock.
type:
- boolean
- 'null'
x-order: 15
onLegalHold:
description: Specifies if this snapshot is on legalhold.
type:
- boolean
- 'null'
x-order: 16
objectId:
description: Specifies the object id which the snapshot is taken from.
type:
- integer
- 'null'
format: int64
x-order: 17
objectName:
description: Specifies the object name which the snapshot is taken from.
type:
- string
- 'null'
x-order: 18
sourceId:
description: Specifies the object source id which the snapshot is taken from.
type:
- integer
- 'null'
format: int64
x-order: 19
physicalParams:
description: Specifies the parameters specific to Physical type snapshot.
allOf:
- $ref: '#/components/schemas/PhysicalSnapshotParams'
- {}
x-order: 20
hypervParams:
description: Specifies the parameters specific to HyperV type snapshot.
allOf:
- $ref: '#/components/schemas/HypervSnapshotParams'
- {}
x-order: 21
awsParams:
description: Specifies the parameters specific to AWS type snapshot.
allOf:
- $ref: '#/components/schemas/AwsSnapshotParams'
- {}
x-order: 22
azureParams:
description: Specifies the parameters specific to Azure type snapshot.
allOf:
- $ref: '#/components/schemas/AzureSnapshotParams'
- {}
x-order: 23
netappParams:
description: Specifies the parameters specific to NetApp type snapshot.
allOf:
- $ref: '#/components/schemas/NetappObjectParams'
- {}
x-order: 24
isilonParams:
description: Specifies the parameters specific to Isilon type snapshot.
allOf:
- $ref: '#/components/schemas/IsilonObjectParams'
- {}
x-order: 25
gpfsParams:
description: Specifies the parameters specific to GPFS type snapshot.
allOf:
- $ref: '#/components/schemas/CommonNasObjectParams'
- {}
x-order: 26
flashbladeParams:
description: Specifies the parameters specific to Flashblade type snapshot.
allOf:
- $ref: '#/components/schemas/FlashbladeObjectParams'
- {}
x-order: 27
genericNasParams:
description: Specifies the parameters specific to Generic NAS type snapshot.
allOf:
- $ref: '#/components/schemas/CommonNasObjectParams'
- {}
x-order: 28
elastifileParams:
description: Specifies the parameters specific to NetApp type snapshot.
allOf:
- $ref: '#/components/schemas/CommonNasObjectParams'
- {}
x-order: 29
DeviceTreeNonLeafNode:
description: Specifies the parameters of a non leaf node in device tree.
type: object
properties:
type:
description: Specifies the children nodes combine type.
type:
- string
- 'null'
enum:
- Linear
- Stripe
- Mirror
- Raid5
- Raid6
- Zero
- Thin
- ThinPool
- Snapshot
- Cache
- CachePool
x-order: 0
deviceLength:
description: Specifies the length of device.
type:
- integer
- 'null'
format: int64
x-order: 1
deviceId:
description: Specifies the id of device.
type:
- integer
- 'null'
format: int64
x-order: 2
childrenNodes:
description: Specifies a list of children nodes.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DeviceTreeNode'
x-order: 3
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
ObjectLastRun:
description: Specifies last run info of an object.
allOf:
- $ref: '#/components/schemas/ObjectSummary'
- type: object
properties:
runId:
description: Specifies the last run id.
type: string
x-nullale: true
x-order: 0
protectionGroupName:
description: Specifies the protection group name of last run.
type:
- string
- 'null'
x-order: 1
protectionGroupId:
description: Specifies the protection group id of last run.
type:
- string
- 'null'
x-order: 2
policyName:
description: Specifies the policy name of last run.
type:
- string
- 'null'
x-order: 3
policyId:
description: Specifies the policy id of last run.
type:
- string
- 'null'
x-order: 4
backupRunStatus:
description: Specifies the status of last local back up run.
type:
- string
- 'null'
enum:
- Accepted
- Running
- Canceled
- Canceling
- Failed
- Missed
- Succeeded
- SucceededWithWarning
- OnHold
x-order: 5
archivalRunStatus:
description: Specifies the status of last archival run.
type:
- string
- 'null'
enum:
- Accepted
- Running
- Canceled
- Canceling
- Failed
- Missed
- Succeeded
- SucceededWithWarning
- OnHold
x-order: 6
replicationRunStatus:
description: Specifies the status of last replication run.
type:
- string
- 'null'
enum:
- Accepted
- Running
- Canceled
- Canceling
- Failed
- Missed
- Succeeded
- SucceededWithWarning
- OnHold
x-order: 7
isSlaViolated:
description: Specifies if the sla is violated in last run.
type:
- boolean
- 'null'
x-order: 8
GetObjectSnapshotsResponseBody:
description: Specifies the list of object snapshots.
type: object
title: Object Snapshots.
properties:
snapshots:
description: Specifies the list of snapshots.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectSnapshot'
x-order: 0
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'
ObjectUnLinkingParams:
description: Specifies the parameters required for unlinking objects. This is currently used as a part of vm migration workflow.
type: object
allOf:
- $ref: '#/components/schemas/CommonObjectsActionParams'
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
VmwareObjectEntityParams:
description: Object details for Vmware.
type: object
properties:
type:
description: VMware Object type.
type:
- string
- 'null'
enum:
- kVCenter
- kStandaloneHost
- kvCloudDirector
- kFolder
- kDatacenter
- kComputeResource
- kClusterComputeResource
- kResourcePool
- kDatastore
- kHostSystem
- kVirtualMachine
- kVirtualApp
- kStoragePod
- kNetwork
- kDistributedVirtualPortgroup
- kTagCategory
- kTag
- kOpaqueNetwork
- kOrganization
- kVirtualDatacenter
- kCatalog
- kOrgMetadata
- kStoragePolicy
- kVirtualAppTemplate
x-order: 0
cdpInfo:
description: Specifies the Continuous Data Protection (CDP) details about this object. This is only available if this object if protected by a CDP enabled policy.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/VmwareCdpObject'
isTemplate:
description: Specifies if the object is a VM template.
type:
- boolean
- 'null'
x-order: 2
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'
ContainerDatabaseInfo:
description: Object details about Oracle container database.
type: object
properties:
pluggableDatabaseList:
description: Specifies the list of Pluggable databases within a container database.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PluggableDatabaseInfo'
x-order: 0
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'
PluggableDatabaseInfo:
description: Specifies the information about Pluggable databases.
type: object
properties:
databaseId:
description: Specifies the database Id of the Pluggable DB.
type:
- string
- 'null'
x-order: 0
databaseName:
description: Specifies the name of the Pluggable DB.
type:
- string
- 'null'
x-order: 1
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
SnapshotsSummary:
description: Specifies a summary of the object snapshots.
type: object
properties:
snapshotTargetType:
description: Specifies the target type where the Object's snapshot resides.
type:
- string
- 'null'
enum:
- Local
- Archival
x-order: 0
externalTargetInfo:
description: Specifies the external target information if this is an archival snapshot.
allOf:
- $ref: '#/components/schemas/ArchivalTargetSummaryInfo'
- {}
x-order: 1
snapshotCount:
description: Specifies the number of snapshots of this type and target.
type:
- integer
- 'null'
format: int64
x-order: 2
latestSnapshotTimestampUsecs:
description: Specifies the timestamp in Unix time epoch in microseconds when the latest snapshot is taken.
type:
- integer
- 'null'
format: int64
x-order: 3
PaginationInfo:
description: Specifies information needed to support pagination.
type: object
properties:
cookie:
description: Specifies a cookie which can be passed in by the user in order to retrieve the next page of results.
type:
- string
- 'null'
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'
ConstructMetaInfoResult:
description: Result to store meta-info from an object snapshot and additional information.
type: object
title: ConstructMetaInfoResult
properties:
environment:
description: Specifies the environment type of the Protection group
type:
- string
- 'null'
enum:
- kOracle
x-order: 0
oracleParams:
description: Specifies 3 Maps required to fill pfile text box.
allOf:
- $ref: '#/components/schemas/OracleRestoreMetaInfoResult'
- {}
x-order: 1
ConstructMetaInfoParams:
description: Params to construct meta info
type: object
title: ConstructMetaInfoParams
required:
- environment
properties:
environment:
description: Specifies the environment type of the Protection group
type:
- string
- 'null'
enum:
- kOracle
x-order: 0
oracleParams:
description: Oracle Params to construct meta info for alternate restore or clone.
allOf:
- $ref: '#/components/schemas/ConstructRestoreMetaInfoOracleParams'
- {}
x-order: 1
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
ObjectProtectionStatsSummary:
description: Specifies the count and size of protected and unprotected objects for a given environment.
type: object
title: Object Protection Stats Summary
properties:
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-go-name: Environment
x-order: 0
protectedCount:
description: Specifies the count of the protected leaf objects.
type:
- integer
- 'null'
format: int64
x-go-name: ProtectedCount
x-order: 1
unprotectedCount:
description: Specifies the count of the unprotected leaf objects.
type:
- integer
- 'null'
format: int64
x-go-name: UnprotectedCount
x-order: 2
protectedSizeBytes:
description: Specifies the protected logical size in bytes.
type:
- integer
- 'null'
format: int64
x-go-name: ProtectedSizeBytes
x-order: 3
unprotectedSizeBytes:
description: Specifies the unprotected logical size in bytes.
type:
- integer
- 'null'
format: int64
x-go-name: UnprotectedSizeBytes
x-order: 4
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
AAGInfo:
description: Object details for Mssql.
type: object
properties:
objectId:
description: Specifies the AAG object Id.
type:
- integer
- 'null'
format: int64
x-order: 0
name:
description: Specifies the AAG name.
type:
- string
- 'null'
x-order: 1
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
User:
description: Specifies a user object.
type: object
title: User
properties:
name:
description: Specifies the name of the user.
type:
- string
- 'null'
x-order: 0
sid:
description: Specifies the sid of the user.
type:
- string
- 'null'
x-order: 1
domain:
description: Specifies the domain of the user.
type:
- string
- 'null'
x-order: 2
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
CancelObjectRunsRequest:
description: Request to cancel object runs.
type: object
properties:
objectRuns:
description: Specifies a list of object runs to cancel.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CancelObjectRunsParams'
x-order: 0
MssqlObjectEntityParams:
description: Object details for Mssql.
type: object
properties:
hostInfo:
description: Specifies the host information for the SQL object. Includes details of Host object such as VM or Physical server.
type:
- object
- 'null'
x-order: 0
$ref: '#/components/schemas/HostInformation'
aagInfo:
description: Specifies the Always on Avalibility (AAG) information if associated with the SQL Object.
type:
- object
- 'null'
x-order: 1
$ref: '#/components/schemas/AAGInfo'
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
ConstructRestoreMetaInfoOracleParams:
description: Params to fetch oracle restore meta info
type: object
title: ConstructRestoreMetaInfoOracleParams
required:
- dbName
- baseDir
- homeDir
- isClone
properties:
dbName:
description: Specifies the name of the Oracle database that we restore to.
type:
- string
- 'null'
x-order: 0
baseDir:
description: Specifies the base directory of Oracle at destination.
type:
- string
- 'null'
x-order: 1
homeDir:
description: Specifies the home directory of Oracle at destination.
type:
- string
- 'null'
x-order: 2
dbFileDestination:
description: Specifies the location to put the database files(datafiles, logfiles etc.)
type:
- string
- 'null'
x-order: 3
isClone:
description: Specifies whether operation is clone or not
type:
- boolean
- 'null'
x-order: 4
isGranularRestore:
description: Specifies whether the operation is granular restore or not.
type:
- boolean
- 'null'
x-order: 5
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
ObjectLinkingParams:
description: Specifies the parameters required for linking objects. This is currently used as a part of vm migration workflow.
type: object
allOf:
- $ref: '#/components/schemas/CommonObjectsActionParams'
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
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'
DeviceTreeLeafNode:
description: Specifies the parameters of a leaf node in device tree.
type: object
properties:
diskName:
description: Specifies the disk name.
type:
- string
- 'null'
x-order: 0
partitionNumber:
description: Specifies the paritition number.
type:
- integer
- 'null'
format: int32
x-order: 1
offsetBytes:
description: Specifies the offset in bytes where data for the LVM volume (for which this device tree is being build) starts relative to the start of the partition.
type:
- integer
- 'null'
format: int64
x-order: 2
lengthBytes:
description: Specifies The length of data in bytes for the LVM volume (for which this device tree is being built). It does not include size of the LVM meta data.
type:
- integer
- 'null'
format: int64
x-order: 3
DatabaseEntityInfo:
description: Object details about Oracle database entity info.
type: object
properties:
containerDatabaseInfo:
description: Specifies the information about container database.
type:
- object
- 'null'
x-order: 0
$ref: '#/components/schemas/ContainerDatabaseInfo'
ObjectsLastRun:
description: Last protection run info of objects.
type: object
properties:
objectLastRuns:
description: Specifies a list of last protection runs of objects.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectLastRun'
x-order: 0
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'
HypervSnapshotParams:
description: Specifies parameters of HyperV type snapshots.
type: object
properties:
protectionType:
description: Specifies the protection type of HyperV snapshots.
type:
- string
- 'null'
enum:
- kAuto
- kRCT
- kVSS
x-order: 0
Group:
description: Specifies a user group object.
type: object
title: User Group
properties:
name:
description: Specifies the name of the user group.
type:
- string
- 'null'
x-order: 0
sid:
description: Specifies the sid of the user group.
type:
- string
- 'null'
x-order: 1
domain:
description: Specifies the domain of the user group.
type:
- string
- 'null'
x-order: 2
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
IsilonObjectProtectionResponseParams:
description: Specifies the parameters which are specific to Isilon object protection.
type: object
allOf:
- $ref: '#/components/schemas/CommonNasProtectionParams'
- $ref: '#/components/schemas/IsilonObjectProtectionParams'
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
UpdateObjectSnapshotRequest:
description: Specifies the parameters to update an object snapshot.
type: object
title: Update Object Snapshot Request.
properties:
setLegalHold:
description: Whether to set the snapshot on legal hold. If set to true, the run cannot be deleted during the retention period.
type:
- boolean
- 'null'
x-order: 0
dataLockType:
description: Specifies the snapshot data lock type.
type:
- string
- 'null'
enum:
- Compliance
- Administrative
x-order: 1
expiryTimeSecs:
description: Specifies the expiry time of the snapshot in Unix timestamp epoch in seconds.
type:
- integer
- 'null'
format: int32
x-order: 2
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
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
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'
AwsSnapshotParams:
description: Specifies parameters of AWS type snapshots.
type: object
properties:
protectionType:
description: Specifies the protection type of AWS snapshots.
type:
- string
- 'null'
enum:
- kAgent
- kNative
- kSnapshotManager
- kRDSSnapshotManager
- kAuroraSnapshotManager
x-order: 0
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
LogicalVolumeInfo:
description: Specifies the logical volume info for LVM or LDM volume.
type: object
properties:
volumeGroupUuid:
description: Specifies the volume group uuid.
type:
- string
- 'null'
x-order: 0
volumeGroupName:
description: Specifies the volume group name.
type:
- string
- 'null'
x-order: 1
logicalVolumeUuid:
description: Specifies the logical volume uuid.
type:
- string
- 'null'
x-order: 2
logicalVolumeName:
description: Specifies the logical volume name.
type:
- string
- 'null'
x-order: 3
deviceTree:
description: Specifies the tree structure of the logical volume.
allOf:
- $ref: '#/components/schemas/DeviceTreeNode'
- {}
x-order: 4
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
VolumeInfo:
description: Specifies info of logical volume (filesystem).
type: object
properties:
name:
description: Specifies the volume name.
type:
- string
- 'null'
x-order: 0
isSupported:
description: Specifies if this volume is supported.
type:
- boolean
- 'null'
x-order: 1
volumeType:
description: Specifies the volume type.
type:
- string
- 'null'
enum:
- SimpleVolume
- LVM
- LDM
x-order: 2
filesystemType:
description: Specifies the filesystem type.
type:
- string
- 'null'
x-order: 3
filesystemUuid:
description: Specifies the filesystem uuid.
type:
- string
- 'null'
x-order: 4
volumeGuid:
description: Specifies the volume guid.
type:
- string
- 'null'
x-order: 5
volumeSizeInBytes:
description: Specifies volume size in bytes.
type:
- integer
- 'null'
format: int64
x-order: 6
logicalVolumeInfo:
description: Specifies the logical volume info. This fields is for 'LVM' and 'LDM' volume type only.
allOf:
- $ref: '#/components/schemas/LogicalVolumeInfo'
- {}
x-order: 7
CommonObjectSummary:
description: Specifies an Common summary properties for an object.
type: object
title: Common Object Entity Summary.
allOf:
- $ref: '#/components/schemas/ObjectSummary'
- type: object
properties:
protectionStats:
description: Specifies the count and size of protected and unprotected objects for the size.
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectProtectionStatsSummary'
x-order: 0
permissions:
description: Specifies the list of users, groups and tenants that have permissions for this object.
type: object
x-order: 1
$ref: '#/components/schemas/PermissionInfo'
x-cohesity-discriminator-details:
propertyName: environment
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'
IsilonObjectParams:
description: Specifies the common parameters for Isilon objects.
type: object
properties:
supportedNasMountProtocols:
description: Specifies a list of NAS mount protocols supported by this object.
type:
- array
- 'null'
items:
type: string
enum:
- kNfs
- kSmb
x-order: 0
ActionObjectMapping:
description: Specifies the object paring for performing action on list of objects.
type: object
properties:
sourceObjectId:
description: Specifies the source object id.
type:
- integer
- 'null'
format: int64
x-order: 0
destinationObjectId:
description: Specifies the destination object id.
type:
- integer
- 'null'
format: int64
x-order: 1
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
SCDataStoreInfo:
description: Specifies the information of a data store.
type: object
properties:
id:
description: Specifies the ID of the data store.
type:
- integer
- 'null'
format: int64
name:
description: Specifies the name of the data store.
type:
- string
- 'null'
SCObjectCredsParams:
description: Specifies the credential parameters of an object.
type: object
required:
- objectId
- username
- password
properties:
objectId:
description: Specifies the Cohesity entity ID of the object.
type:
- integer
- 'null'
format: int64
sourceId:
description: Specifies the Cohesity entity ID of the source to which this object belongs to.
type:
- integer
- 'null'
format: int64
objectUniqueIdentifier:
description: Specifies unique identifier for the object(VM) for which credentials need to be checked. For VMware, this will be VMs' MORef.
type:
- string
- 'null'
username:
description: Specifies the name of the user.
type:
- string
- 'null'
password:
description: Specifies the password of the user.
type:
- string
- 'null'
SCCheckObjectCredsResults:
description: Specifies the results of checking objects credentials.
type: object
properties:
siteId:
description: Specifies the ID of the site.
type:
- integer
- 'null'
format: int64
objects:
description: Specifies the results of the objects in the action.
type: array
items:
$ref: '#/components/schemas/SCObjectCredsCheckResult'
SCObjectCredsCheckResult:
description: Specifies the credentials check result of one object.
type: object
properties:
objectId:
description: Specifies the ID of the object.
type:
- integer
- 'null'
format: int64
isCheckDone:
description: Specifies whether the check for the object is done.
type:
- boolean
- 'null'
isCredentialValid:
description: Specifies whether the credential is valid for the object. This will only be returned when isCheckDone is true.
type:
- boolean
- 'null'
errorMessage:
description: Specifies the error message if the credential is invalid. This will only be returned when isCheckDone is true and isCredentialValid is false.
type:
- string
- 'null'
SCFetchResourcePoolInfoParams:
description: Specifies the parameters to fetch resource pool information.
type: object
required:
- siteId
- vCenterId
properties:
siteId:
description: Specifies the ID of the site.
type:
- integer
- 'null'
format: int64
vCenterId:
description: Specifies the ID of the vCenter.
type:
- integer
- 'null'
format: int64
SCResourcePoolInfo:
description: Specifies the information of a resource pool.
type: object
properties:
resourcePoolId:
description: Specifies the ID of the resource pool.
type:
- integer
- 'null'
format: int64
resourcePoolName:
description: Specifies the name of the resource pool.
type:
- string
- 'null'
dataStores:
description: Specifies the list of data stores under the resource pool.
type: array
items:
$ref: '#/components/schemas/SCDataStoreInfo'
networks:
description: Specifies the list of networks under the resource pool.
type: array
items:
$ref: '#/components/schemas/SCNetworkInfo'
SCCreateObjectsOperationParams:
description: Specifies the parameters to perform an operation using objects.
type: object
required:
- operationId
- operationType
properties:
operationId:
description: Specifies the operation id to perform operation using objects. This operation id will be used in later get calls to track the progress of operations.
type: string
operationType:
description: Specifies the operation type.
'CheckObjectCreds' initiates a verification check for object credentials.
'FetchResourcePoolInfo' initiates an operation to fetch information about all resource pools under a vCenter.
'FetchEntityHierarchyWithObjectInfo' initiates an operation to fetch information about entity hierarchy for a vCenter. Once entity hierarchy is fetched, more object related information such as protection groups, RPO information will also be fetched. This is a cached response and may not always reflect the latest state of the entity hierarchy and PG/RPO information.
'RefreshReplicatedSnapshots' initiates an operation to fetch the replicated snapshot details for all the objects belonging to the latest application version.
type: string
enum:
- CheckObjectCreds
- FetchResourcePoolInfo
- FetchEntityHierarchyWithObjectInfo
- RefreshReplicatedSnapshots
checkObjectCredsParams:
description: Specifies the parameters to check objects credentials.
type: object
$ref: '#/components/schemas/SCCheckObjectCredsParams'
fetchResourcePoolInfoParams:
description: Specifies the parameters to fetch information of all resource pools under a vCenter.
type: object
$ref: '#/components/schemas/SCFetchResourcePoolInfoParams'
fetchEntityHierarchyWithObjectInfoParams:
description: Specifies the parameters to fetch information of entity hierarchy under a vCenter and information such as protection groups and RPO for all objects under the same vCenter.
type: object
$ref: '#/components/schemas/SCFetchEntityHierarchyWithObjectInfoParams'
refreshReplicatedSnapshotsParams:
description: Specifies the parameters to initiate a refresh operation on objects included in a DR plan via linked application.
type: object
$ref: '#/components/schemas/SCRefreshReplicatedSnapshotParams'
SCFetchResourcePoolInfoResults:
description: Specifies the results of fetching resource pool information.
type: object
properties:
siteId:
description: Specifies the ID of the site.
type:
- integer
- 'null'
format: int64
vCenterId:
description: Specifies the ID of the vCenter.
type:
- integer
- 'null'
format: int64
resourcePools:
description: Specifies the information of the resource pools under the vCenter.
type: array
items:
$ref: '#/components/schemas/SCResourcePoolInfo'
SCObjectsOperationResults:
description: Specifies the results of operation using objects.
type: object
properties:
operationId:
description: Specifies the operation id to perform operation using objects.
type: string
operationType:
description: Specifies the operation type.
'CheckObjectCreds' initiates a verification check for object credentials.
'FetchResourcePoolInfo' initiates an operation to fetch information about all resource pools under a vCenter.
'FetchEntityHierarchyWithObjectInfo' initiates an operation to fetch information about entity hierarchy for a vCenter. Once entity hierarchy is fetched, more object related information such as protection groups, RPO information will also be fetched. This is a cached response and may not always reflect the latest state of the entity hierarchy and PG/RPO information.
'RefreshReplicatedSnapshots' initiates an operation to fetch the replicated snapshot details for all the objects included in a DR plan via linked application. If the current operation results in success, refreshed snapshots should be accessed by making call to the get replicated snapshots API.
type:
- string
- 'null'
enum:
- CheckObjectCreds
- FetchResourcePoolInfo
- FetchEntityHierarchyWithObjectInfo
- RefreshReplicatedSnapshots
status:
description: Specifies the operation status.
type:
- string
- 'null'
enum:
- Success
- Failure
- InProgress
errorMessage:
description: Specifies the error message if the status is failure.
type:
- string
- 'null'
checkObjectCredsResults:
description: Specifies the results of checking objects credentials.
type: object
$ref: '#/components/schemas/SCCheckObjectCredsResults'
fetchResourcePoolInfoResults:
description: Specifies the results of fetching resource pool information.
type: object
$ref: '#/components/schemas/SCFetchResourcePoolInfoResults'
fetchEntityHierarchyWithObjectInfoResults:
description: Specifies the results of fetching entity hierarchy and object information such as protection group and RPO. At times, all this information may not be available at once. At these instances, 'fetchStatus' field will indicate the current progress of this operation. Please note that the 'status' field at the operation level is used for tracking the progress of the entire operation while 'fetchStatus' field is more fine-grained and used for tracking individual fetching operations within a top level operation.
type: object
$ref: '#/components/schemas/SCFetchEntityHierarchyWithObjectInfoResults'
SCNetworkInfo:
description: Specifies the information of a network.
type: object
properties:
id:
description: Specifies the ID of the network.
type:
- integer
- 'null'
format: int64
name:
description: Specifies the name of the network.
type:
- string
- 'null'
SCFetchObjectsInfoResult:
description: Specifies the information such as protection group and RPO for an object.
type: object
properties:
objectId:
description: Specifies the ID of the object.
type:
- integer
- 'null'
format: int64
objectName:
description: Specifies the name of the object.
type:
- string
- 'null'
pgGroupsAndRpo:
description: Specifies the list of protection groups and respective RPO information for the object.
type: array
items:
$ref: '#/components/schemas/SCPgAndRpoInfo'
SCFetchEntityHierarchyWithObjectInfoParams:
description: Specifies the parameters to fetch information of entity hierarchy under a vCenter and information such as protection groups and RPO for all objects under the same vCenter.
type: object
required:
- siteId
- vCenterId
properties:
siteId:
description: Specifies the ID of the site from which the entity hierarchy needs to be obtained. Prior to a Failover operation, or after a Failback operation, this would be the primary site. After a Failover operation, this would be the DR site.
type:
- integer
- 'null'
format: int64
vCenterId:
description: Specifies the object ID of the vCenter in the site specified by siteId field. Prior to a Failover operation, or after a Failback operation, this would be the primary site. After a Failover operation, this would be the DR site.
type:
- integer
- 'null'
format: int64
destinationSiteId:
description: Specifies the ID of the site to which replication would be configured from the entities in the entity hierarchy. Prior to a Failover operation, or after a Failback operation, this would be the DR site. After a Failover operation, this would be the primary site.
type:
- integer
- 'null'
format: int64
SCRefreshReplicatedSnapshotParams:
description: Specifies the parameters to initiate a refresh operation to to fetch replicated snapshots for all objects included in a DR plan via linked application. Successful refresh operation will also update the internal cache to reflect the latest snapshots.
type: object
required:
- drPlanId
properties:
drPlanId:
description: Specifies the ID of the DR plan. Successful execution of the API will internally update the linked application's cache with latest snapshot details.
type:
- integer
- 'null'
format: int64
SCCheckObjectCredsParams:
description: Specifies the parameters to create a verification check for object credentials.
type: object
required:
- siteId
properties:
siteId:
description: Specifies the ID of the site.
type:
- integer
- 'null'
format: int64
objects:
description: Specifies the list of objects for credential validation.
type: array
items:
$ref: '#/components/schemas/SCObjectCredsParams'
minItems: 1
SCErrorCode:
description: Specifies all the error codes that are returned by API server
type: string
enum:
- kNoError
- kValidationError
- kInternalError
SCObjectsOperation:
description: Specifies an operation using objects.
type: object
properties:
operationId:
description: Specifies the operation id to perform operation using objects. This operation id will be used in later get calls to track the progress of operations.
type: string
operationType:
description: Specifies the operation type.
'CheckObjectCreds' initiates a verification check for object credentials.
'FetchResourcePoolInfo' initiates an operation to fetch information about all resource pools under a vCenter.
'FetchEntityHierarchyWithObjectInfo' initiates an operation to fetch information about entity hierarchy for a vCenter. Once entity hierarchy is fetched, more object related information such as protection groups, RPO information will also be fetched. This is a cached response and may not always reflect the latest state of the entity hierarchy and PG/RPO information.
'RefreshReplicatedSnapshots' initiates an operation to fetch the replicated snapshot details for all the objects included in a DR plan via linked application.
type: string
enum:
- CheckObjectCreds
- FetchResourcePoolInfo
- FetchEntityHierarchyWithObjectInfo
- RefreshReplicatedSnapshots
SCFetchEntityHierarchyWithObjectInfoResults:
description: Specifies the results of fetching entity hierarchy and object information such as protection group and RPO. At times, all this information may not be available at once. At these instances, 'fetchStatus' field will indicate the current progress of this operation. Please note that the 'status' field at the operation level is used for tracking the progress of the entire operation while 'fetchStatus' field is more fine-grained and used for tracking individual fetching operations within a top level operation.
type: object
properties:
siteId:
description: Specifies the ID of the site from which the entity hierarchy has been returned. Prior to a Failover operation, or after a Failback operation, this would be the primary site. After a Failover operation, this would be the DR site.
type:
- integer
- 'null'
format: int64
vCenterId:
description: Specifies the object ID of the vCenter in the site specified by siteId field. Prior to a Failover operation, or after a Failback operation, this would be the primary site. After a Failover operation, this would be the DR site.
type:
- integer
- 'null'
format: int64
destinationSiteId:
description: Specifies the ID of the site to which replication would be configured from the entities in the entity hierarchy. Prior to a Failover operation, or after a Failback operation, this would be the DR site. After a Failover operation, this would be the primary site.
type:
- integer
- 'null'
format: int64
fetchStatus:
description: Specifies the current status for the progress made during sequential fetch operations such as entity hierarchy, protection group and RPO fetch etc. This status indicates the fetch progress and hence every status implicitly indicates that previous fetch tasks were successfully completed.
type:
- string
- 'null'
enum:
- EntityHierarchyFetched
- ProtectionGroupFetched
- RPOFetched
- AllFetched
entityHierarchy:
description: Specifies the json encoded string which represents the entity hierarchy. The caller of the API needs to decode it based on the entity hierarchy object defined in public API data models.
type:
- string
- 'null'
objectsInfo:
description: Specifies the information such as protection group and RPO information for the all the objects belonging the entity hierarchy populated above.
type: array
items:
$ref: '#/components/schemas/SCFetchObjectsInfoResult'
SCPgAndRpoInfo:
description: Specifies the protection group and RPO information for an object.
type: object
properties:
protectionGroupId:
description: Specifies the Protection group identifier associated with the object.
type:
- string
- 'null'
protectionGroupName:
description: Specifies the Protection group name associated with the object.
type:
- string
- 'null'
rpoUnit:
description: Specifies the RPO unit associated with the above protection group.
type:
- string
- 'null'
enum:
- Minutes
- Hours
- Days
rpoFrequency:
description: Specifies the frequency at which RPO needs to be executed along with the unit.
type:
- integer
- 'null'
format: int32
SCError:
description: Specifies the error object with error code and a message.
type: object
properties:
errorCode:
description: Specifies the error code.
$ref: '#/components/schemas/SCErrorCode'
errorMessage:
description: Specifies the error message.
type:
- string
- 'null'
responses:
GetPITRangesProtectedObjectResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPITRangesProtectedObjectResponseBody'
SourceHierarchyObjectSummariesResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SourceHierarchyObjectSummaries'
GetObjectSnapshotInfoResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectSnapshot'
ProtectedObjectResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ProtectedObjectInfo'
ConstructMetaInfoResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConstructMetaInfoResult'
ErrorResponse:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
GetObjectStatsResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectStats'
GetObjectSnapshotVolumeInfoResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectSnapshotVolumeInfo'
NoContentResponse:
description: No Content
GetObjectRunsResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetObjectRunsResponseBody'
CancelObjectRunsResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CancelObjectRunsResults'
UpdateObjectSnapshotResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectSnapshot'
GetObjectSnapshotsResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetObjectSnapshotsResponseBody'
GetProtectedObjectsResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetProtectedObjectsResponse'
GetObjectsLastRunResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectsLastRun'
GetIndexedObjectSnapshotsResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetIndexedObjectSnapshotsResponseBody'
ObjectTreeResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectWithChildren'
GetObjectRunResponse:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectProtectionRunSummary'
SCGetObjectsOperationResultsResponse:
description: Specifies the results of an operation using objects.
content:
application/json:
schema:
$ref: '#/components/schemas/SCObjectsOperationResults'
SCCreateObjectsOperationResponse:
description: Specifies the response of an operation using objects.
content:
application/json:
schema:
$ref: '#/components/schemas/SCObjectsOperation'
SCErrorResponse:
description: Specifies the common error definition.
content:
application/json:
schema:
$ref: '#/components/schemas/SCError'
securitySchemes:
APIKeyHeader:
in: header
name: apiKey
type: apiKey
ApiKeyAuth:
type: apiKey
in: header
name: apiKey
x-refined-from:
- cohesity-cluster-v2-openapi-original.yml
- cohesity-site-continuity-openapi-original.yml