The identity and technical contract details declared by the specification.
SCInitiateHealthCheckParams
object
Specifies the parameters required to initiate a health check.
2 properties
1 required
SCDRPlanHealthCheckParams
object
Specifies the parameters associated with DR plan health check.
1 property
1 required
SCGetStatsResponse
object
Specifies the various stats about DR Plans, sites and applications. Based on the passed statTypes, appropriate stats data will be returned in the response.
10 properties
SCReadyPlanStats
object
Specifies the stats for all the DR plans that are ready for either failover or failback.
2 properties
SCSLAStatsResponse
object
Specifies the SLA stats for active DR plans.
2 properties
SCActivityStatsResponse
object
Specifies the activity stats for the specific time interval.
5 properties
SCSiteConnectivityStatsResponse
object
Specifies the activity stats for the specific time interval.
4 properties
SCConnectedSites
object
Specifies the connectivity stats for a site where each source site is connected to one or more sites by DR plans.
1 property
SCDRPlanConnectionStats
object
Specifies the DR plan related details mainly used to represent the connection details between a pair of sites.
9 properties
SCDisconnectedSite
object
Specifies the details of a disconnected site.
1 property
SCConnectedSitePair
object
Specifies the connectivity stats for a site that is connected to at least one other site via DR plan.
4 properties
SCGetStatsParams
object
Specifies the parameters to get stats. Based on the passed statTypes, appropriate stats data will be returned in the response. If statTypes is not specified th…
3 properties
SCActivityStatsParams
object
Specifies the parameters to fetch the activity stats.
1 property
SCSiteConnectivityStatsParams
object
Specifies the parameters to fetch the site connectivity stats.
1 property
SCActionsResponse
object
Specifies the list of actions.
1 property
SCAction
object
Specifies the details of an ongoing or past action performed on a DR plan.
13 properties
SCUserActionConfig
object
Specifies the user configuration which was used during the submission of the action.
2 properties
SCObjectSnapshotUserConfig
object
Specifies the object and snapshot details from the user provided configuration at the time of action submission.
3 properties
SCActionAttempt
object
Specifies the attempt details for an action. A new attempt is created under following two conditions. 1. When an top level action (Failover, Failback, Test Fai…
8 properties
SCAttemptStep
object
Specifies the step level details such as message, status, progress percentage for the respective DR action.
6 properties
SCAttemptStepObject
object
Specifies the object level details involved in the individual step of an attempt.
2 properties
SCDrPlanAction
object
Specifies the action configuration to be executed on a DR plan.
2 properties
SCPerformActionOnDrPlanParams
object
Specifies the parameters required to perform a specific action on a DR plan.
6 properties
1 required
SCTeardownActionParams
object
Specifies the action parameters to teardown a DR plan action.
1 property
1 required
SCTestFailoverActionParams
object
Specifies the action parameters to trigger test failover on a DR plan.
SCTestFailoverActionVMwareParams
object
Specifies the VMware specific parameters to perform the test failover action.
2 properties
1 required
SCFailbackActionParams
object
Specifies the action parameters to trigger a failback on a DR plan.
SCTestFailbackActionParams
object
Specifies the action parameters to trigger a test failback on a DR plan.
SCTestFailbackActionVMwareParams
object
Specifies the action parameters to trigger a test failback on a DR plan.
2 properties
1 required
SCFailoverActionParams
object
Specifies the action parameters to trigger failover on a DR plan.
SCFailoverActionVMwareParams
object
Specifies the action parameters to trigger failover for VMware environment.
3 properties
1 required
SCFailbackActionVMwareParams
object
Specifies the action parameters to trigger failback for VMware environment.
3 properties
1 required
SCDRPlanActionCommonParams
object
Specifies the action parameters to trigger failover or failback on a DR plan.
1 property
SCObjectSnapshotOverride
object
Specifies the list of object Ids along with the snapshot timestamps typically used for actual or test failover/failback.
3 properties
1 required
SCDRPlansResponse
object
Specifies the list of DR plans.
2 properties
SCDRPlan
object
Specifies the information about a DR plan.
10 properties
SCHealthCheck
object
Specifies the information about the health check.
4 properties
DrPlanErrorDetails
object
Specifies the error details in case DR plan is in a failed state.
2 properties
SCDRPlanCreateOrUpdateParams
object
Specifies the parameters required for creation of DR plan.
6 properties
4 required
SCDRSiteConfig
object
Specifies the configuration for DR site.
2 properties
2 required
SCvCenterResourceProfileParams
object
Specifies the resource profile settings for vCenter source.
5 properties
2 required
SCvCenterDefaultResourceSet
object
Specifies the parameters required to configure default resource set.
2 properties
1 required
SCvCenterCustomResourceSet
object
Specifies the parameters required to configure a custom resource set.
SCvCenterComputeConfig
object
Specifies the compute configuration for a vCenter resource set.
5 properties
5 required
SCDataCenterComputeConfig
object
Specifies the compute settings for the data center located under a specific vCenter object hierarchy on Cohesity.
3 properties
1 required
SCClusterComputeConfig
object
Specifies the compute settings for the cluster object located under a specific vCenter object hierarchy on Cohesity.
3 properties
1 required
SCResourcePoolComputeConfig
object
Specifies the compute settings for the resource pool object located under a specific vCenter object hierarchy on Cohesity.
3 properties
1 required
SCDatastoreComputeConfig
object
Specifies the compute settings for the data store object located under a specific vCenter object hierarchy on Cohesity.
3 properties
1 required
SCNetworkPortGroupComputeConfig
object
Specifies the compute settings for the network port group object located under a specific vCenter object hierarchy on Cohesity.
3 properties
1 required
SCIpConfig
object
Specifies the customer IP configuration parameters.
3 properties
1 required
SCDhcpIpConfig
Specifies the DHCP IP configurations.
SCCommonDNSSettings
object
Specifies the common DNS IP settings.
2 properties
SCStaticIpConfig
object
Specifies the Static IP configurations.
4 properties
1 required
SCOriginalStaticIpConfig
Specifies the original static IP configuration.
SCNetworkMappingIpConfig
Specifies the network mapping configuration.
SCManualStaticIpConfig
object
Specifies the manual IP configuration.
1 property
SCManualObjectLevelIpConfig
Specifies the object level manual IP configuration.
SCPrimarySiteConfig
object
Specifies the configuration for primary site.
2 properties
2 required
SCSourceConfig
object
Specifies the source details for DR plan configuration.
2 properties
1 required
SCDRSourceVMwareParams
object
Specifies the source details for adding VMware objects.
2 properties
1 required
SCDRSourceVCenterParams
object
Specifies the vCenter parameters to configure a source.
2 properties
1 required
SCRPOConfig
object
Specifies the Recovery Point Objective (RPO) configuration for a DR Plan.
2 properties
1 required
SCApplicationVersionsResponse
object
Specifies the list of application versions.
3 properties
SCApplicationsResponse
object
Specifies the list of applications.
3 properties
SCApplicationsSummary
object
Specifies the summary information of existing applications.
3 properties
SCApplication
object
Specifies the information about the application.
3 properties
SCApplicationVersion
object
Specifies the application details for a given version.
4 properties
SCAppVersionMapping
object
Specifies the map for linking data objects from previous version to current version. This map will help identifying the recovered objects on DR cluster after s…
6 properties
SCAppObjectLinkage
object
Specifies the map for linking data objects from previous version to current version.
2 properties
SCAppCreateOrUpdateParams
object
Specifies the parameters required to create or update application.
SCCommonAppParams
object
Specifies the common parameters required to create or update application.
1 property
1 required
SCAppSpec
object
Specifies the application configuration.
2 properties
2 required
SCAppSourceConfig
object
Specifies the source details for managing data objects such as VMs, Views, etc.
2 properties
1 required
SCAppSourceVMwareParams
object
Specifies the source details for adding VMware objects.
2 properties
1 required
SCAppSourceVCenterParams
object
Specifies the vCenter parameters required to be included as DR target.
2 properties
1 required
SCAppComponentsConfig
object
Specifies the configuration for app components such as objects (VMs, Views, DBs, etc), scripts and time delays in ordered list.
4 properties
1 required
SCAppComponentObjectConfig
object
Specifies configuration required for adding an object component.
3 properties
2 required
SCAppComponentVMParams
object
Specifies the configuration parameters for virtual machine object.
5 properties
SCAppComponentTimeDelayConfig
object
Specifies the time delay config.
2 properties
2 required
SCAppComponentScriptConfig
object
Specifies the parameters required for adding a script.
3 properties
2 required
SCCommonSite
object
Specifies the common site parameters.
4 properties
2 required
SCOnPremSite
object
Specifies the details of an on prem site.
2 properties
2 required
SCSiteLocationDetails
object
Specifies details related to the location of a site.
6 properties
SCSite
object
Specifies the site details.
SCSitesResponse
object
Specifies the list of sites.
2 properties
SCError
object
Specifies the error object with error code and a message.
2 properties
SCErrorCode
string
Specifies all the error codes that are returned by API server
SCCreateObjectsOperationParams
object
Specifies the parameters to perform an operation using objects.
6 properties
2 required
SCRefreshReplicatedSnapshotParams
object
Specifies the parameters to initiate a refresh operation to to fetch replicated snapshots for all objects included in a DR plan via linked application. Success…
1 property
1 required
SCCheckObjectCredsParams
object
Specifies the parameters to create a verification check for object credentials.
2 properties
1 required
SCObjectCredsParams
object
Specifies the credential parameters of an object.
5 properties
3 required
SCFetchResourcePoolInfoParams
object
Specifies the parameters to fetch resource pool information.
2 properties
2 required
SCFetchEntityHierarchyWithObjectInfoParams
object
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 s…
3 properties
2 required
SCObjectsOperation
object
Specifies an operation using objects.
2 properties
SCObjectsOperationResults
object
Specifies the results of operation using objects.
7 properties
SCCheckObjectCredsResults
object
Specifies the results of checking objects credentials.
2 properties
SCObjectCredsCheckResult
object
Specifies the credentials check result of one object.
4 properties
SCFetchResourcePoolInfoResults
object
Specifies the results of fetching resource pool information.
3 properties
SCResourcePoolInfo
object
Specifies the information of a resource pool.
4 properties
SCDataStoreInfo
object
Specifies the information of a data store.
2 properties
SCNetworkInfo
object
Specifies the information of a network.
2 properties
SCFetchEntityHierarchyWithObjectInfoResults
object
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…
6 properties
SCFetchObjectsInfoResult
object
Specifies the information such as protection group and RPO for an object.
3 properties
SCPgAndRpoInfo
object
Specifies the protection group and RPO information for an object.
4 properties
SCPaginationInfo
object
Specifies information needed to support pagination.
1 property
SCDRPlansSummary
object
Specifies the summary of the DR Plans.
9 properties
SCGetSnapshotsByAppIdResponse
object
Specifies the response for fetching snapshots for all the objects belonging to an application.
2 properties
SCObjectSnapshot
object
Specifies the snapshot details for an object. The details include object details, snapshot details and point in time recovery timestamps. If object is protecte…
4 properties
SCTimeRange
object
Specifies the time range for the objects protected typically protected via CDP.
2 properties
SCSnapshotDetails
object
Specifies the specific details of the snapshot.
2 properties
SCObjectDetails
object
Specifies the object level details.
4 properties
SCVMDetails
object
Specifies the details specific to the virtualMachine object type.
1 property
SCOperationOnActionParams
object
Specifies the parameters for an performing an operation on a DR plan action.
1 property
1 required
SCBackupDetails
object
Specifies the details about the backup information.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cohesity publishes across the network.