Skip to main content

Get details for recovery group​

Select

SaaS
Customer Managed

Get details for recovery group

Path Parameters
  • recoveryGroupId integer required

    Recovery group Id

Query Parameters
  • getEntityDetails boolean

    Get the entity details with recovery group details

Responses

OK

Schema
  • recoveryGroup object

    Model to provide basic detail of recovery group

  • id int32

    Id of the recovery group

  • name string

    Name of the recovery group

  • target object
  • id int32
  • name string
  • vendor string

    Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI, KUBERNETES_EKS, MORPHEUS]

  • entityCount int32

    Number of entities associated with recovery group

  • postRecoveryActions object[]
  • path string

    The path of the script to be executed. Can be local path on VM or UNC path accessible by access node

  • type string

    Possible values: [UNC, LOCAL]

    The type of path being used for DR operation script

  • scriptCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guestCredentials object
  • savedCredentials object
  • id int32
  • name string
  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • guid string

    Unique script identifier string

  • scriptContent string

    Content of the script to be executed

  • scriptName string

    Name of the script

  • reset boolean

    On set to true, resets the script to empty

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • delayBetweenPriorityMachines int32

    The delay between machines in different priorities in minutes

  • continueOnFailure boolean

    Default value: false

    Set to true to continue to the next priority machines on failure

  • powerOffDestinationVMPostRecoveryAndValidation boolean

    Default value: false

    Set to false if destination Vm is powered on post recovery and validation

  • action RecoveryAction

    Possible values: [CREATE, UPDATE, DELETE]

    Recovery Action

  • recoveryPointDetails object

    Contains the information regarding the recovery group level recoveryPoint selection

  • recoveryPoint int32

    Timestamp for group restore in case of disaster

  • recoveryPointCategory string

    Possible values: [LATEST, POINT_IN_TIME, AUTOMATIC]

    Default value: LATEST

    Type of recovery point category

  • recoveryPoint int32

    Timestamp for group restore in case of disaster

  • recoveryExpirationOptions object
  • enableExpirationOption boolean

    Default value: true

    If true, cleans up recovered VMs after the set daysToExpire value

  • daysToExpire int32

    Default value: 7

    Number of days after which recovered VMs are automatically cleaned up

  • isRescuedCommServe boolean

    Whether the CommServe is rescued or not

  • expirationTime int32

    Timestamp when the clean up of all recovered VMs happens on the rescued CommServe. It happens 4 hours before the CommServe expiration time

  • threatScan object
  • enableThreatScan boolean

    Default value: false

    A boolean that indicates whether threat scan is required

  • enableWindowsDefenderScan boolean

    Default value: false

    A boolean that specifies whether a windows defender scan is required

  • totalThreats int32

    Total number of threats found for the group

  • threatInfo object

    The type and number of threats found

  • count int32

    The number of threats found per threat type

  • threatType string

    The name of the threat

  • entities object[]
GET /recoverygroup/:recoverygroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
recoveryGroupId — path required
getEntityDetails — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/RecoveryGroup/:recoveryGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'