Skip to main content

Get the details of a recovery entity​

Select

SaaS
Customer Managed

Get the details of a recovery entity

Path Parameters
  • recoveryEntityId integer required

    Recovery entity Id

Responses

OK

Schema
  • id int32

    Id of the recovery entity

  • name string

    Name of the recovery entity

  • entity object
  • id int32
  • name string
  • recoveryGroup object
  • id int32
  • name string
  • workload string

    Possible values: [GENERIC, O365, SALESFORCE, EXCHANGE, SHAREPOINT, ONEDRIVE, TEAMS, DYNAMICS_365, VSA, FILESYSTEM, KUBERNETES, AZURE_AD, CLOUD_LAPTOP, FILE_STORAGE_OPTIMIZATION, DATA_GOVERNANCE, E_DISCOVERY, SQL_SERVER, ORACLEDB, DB2, ACTIVE_DIRECTORY, DATABASE]

  • client object
  • id int32
  • name string
  • backupSet object
  • id int32
  • name string
  • vmGroup object
  • id int32
  • name string
  • virtualMachine object
  • GUID string
  • name string
  • recoveryConfiguration object
  • advancedOptions object
  • azure object

    Advanced options for Azure replication group

  • unconditionalOverwrite boolean

    Default value: false

    This will replace the instance at the destination if the instance with the same name already exists.

  • deployVmOnlyDuringfailover boolean

    Default value: true

    Select this option to deploy a VM only when a failover operation is requested

  • configuration object
  • azure object

    Replication configuration for Azure

  • sourceVM string

    Source VM

  • destinationVM string

    Destination VM

  • resourceGroup string

    Resource group in which the converted virtual machine should be created.

  • storageAccount string

    Azure Standard or Premium general-purpose storage account.

  • vmSize string

    VM size

  • createPublicIP boolean

    Create a public IP.

  • restoreAsManagedVm boolean

    Restore the VM as a managed disk for the destination VMs.

  • overrideReplicationOptions object

    Replication options for Azure

  • availabilityZone string

    VM availability zone

  • securityGroup object

    The id and the name of the security group

  • id string

    Security group id

  • name string

    security group name

  • testFailoverVirtualNetwork object

    Network interface for the destination instances

  • networkId string

    Network unique identifier

  • networkDisplayName string

    Display Name of network

  • subnetId string

    subnet id of network

  • networkName string

    Name of the network

  • networkAddressDetails object

    Azure nic info for restore

  • networkId string

    Azure network ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/virtualNetworks/{Network Name}.

  • subnetId string

    Azure subnet ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/virtualNetworks/{Network Name}/subnets/{Subnet Name}.

  • privateIpAddress ipv4

    Azure private IP address.

  • publicIpAddress ipv4

    Azure publice IP address.

  • publicIpAddressId string

    Azure public IP address ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/publicIPAddresses/{Public IP Address Name}.

  • virtualNetwork object

    Network interface for the destination instances

  • networkId string

    Network unique identifier

  • networkDisplayName string

    Display Name of network

  • subnetId string

    subnet id of network

  • networkName string

    Name of the network

  • networkAddressDetails object

    Azure nic info for restore

  • networkId string

    Azure network ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/virtualNetworks/{Network Name}.

  • subnetId string

    Azure subnet ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/virtualNetworks/{Network Name}/subnets/{Subnet Name}.

  • privateIpAddress ipv4

    Azure private IP address.

  • publicIpAddress ipv4

    Azure publice IP address.

  • publicIpAddressId string

    Azure public IP address ID. Format: /subscriptions/{Subscription ID}/resourceGroups/{Resource Group Name}/providers/Microsoft.Network/publicIPAddresses/{Public IP Address Name}.

  • diskType string

    Type of the disk

  • sourceVMGuid string

    GUID of the source VM

  • region string

    region of the VM

  • testFailoverVmSize string

    Vm size to be used during the test failover operation

  • dbConfig object
  • server object
  • id int32
  • name string
  • instance object
  • id int32
  • name string
  • databases object[]
  • id int64

    ID of the source database

  • sourceName string

    Name of the source database

  • destinationName string

    Name of the destination database

  • fileMappings object[]
  • source object
  • logicalName string

    Logical name of the file

  • physicalPath string

    Physical path of the file

  • destination object
  • logicalName string

    Logical name of the file

  • physicalPath string

    Physical path of the file

  • imageDetails object
  • vmCreds 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

  • vmTemplate object
  • GUID string
  • name string
  • mediaAgent object
  • id int32
  • name string
  • copyPrecedence int32

    Copy precedence for the copy used for the restore

  • hardwareConfiguration object
  • dataDiskConfiguration object[]
  • name string

    Name of the disk

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • volumeConfiguration object[]
  • name string

    Name of the volume

  • totalSize int64

    Size for volume in bytes

  • enabled boolean

    Determine if volume is enabled or not

  • disks object[]
  • name string

    Name of the disk

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • systemDiskConfiguration object
  • name string

    Name of the disk

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • credentials 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

  • instance object
  • id int32
  • name string
  • preRecoveryActions 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

  • 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

  • target object
  • id int32
  • name string
  • recoveryPointDetails object

    Contains the information regarding the recovery entity level recoveryPoint selection

  • entityRecoveryPoint int32

    Timestamp for entity restore in case of disaster, default value is 0 as latest recovery point

  • entityRecoveryPointCategory string

    Possible values: [LATEST, POINT_IN_TIME, AUTOMATIC]

    Default value: LATEST

    Type of recovery point category that can be selected. Default is Latest

  • inheritedFrom string

    Possible values: [RECOVERY_GROUP, RECOVERY_ENTITY]

    Default value: RECOVERY_GROUP

    Describes from where the recovery point is inherited from. If not provided, recovery point will be used as if it is set at recovery group level

  • recoveryPoint int32

    Timestamp for entity restore in case of disaster, default value is 0 as latest recovery point

  • executionOrder object
  • priority int32

    Decides the priority of group execution

  • order int32

    Decides the priority of entites within a group

  • group int32

    Group ID to group similar entities together

  • connectionDetails object
  • guestCreds 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

  • csCreds 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

  • topologyDetails object
  • serverGroups object[]
  • id int32
  • name string
  • networkGateway object[]
  • hostname string

    Gateway machine hostname

  • port int32

    Possible values: >= 1 and <= 65535

  • vmHostName string

    VM host name

  • vmClientName string

    VM client name

  • domainCreds 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

  • blockSysrepForRecovery boolean
  • recoveryStatus string

    Possible values: [NO_STATUS, NOT_READY, READY, RECOVERED, FAILED, RECOVERED_WITH_ERRORS, IN_PROGRESS]

    Status of recovery entity

  • validationStatus string

    Possible values: [NO_STATUS, IN_PROGRESS, SUCCESS, FAILED]

    Validation status of recovery entity

  • validationResults object[]
  • output string

    Output of the script executed

  • name string

    Name of the script executed

  • validationStatus string

    Possible values: [NO_STATUS, IN_PROGRESS, SUCCESS, FAILED]

    Validation status of recovery entity

  • failureReason string

    Script validation failure reason

  • recoveryFailureReason string

    Reason for last recovery job failure

  • validationFailureReason string

    Reason for last validation failure

  • recoveryStatusNotReadyReason string

    Recovery status not ready reason

  • recoveryStatusNotReadyCategory string

    Possible values: [NONE = 0, INVALID_VM_NAME = 1, INVALID_COPY = 2]

    Recovery status not ready category

  • lastRecoveryJobId int32

    Last recovery job Id of the entity

  • osType string

    Possible values: [WINDOWS, UNIX]

    OS types

  • copyAvailableTime int32

    Timestamp of the latest backup job start time present in the copy that would be used for recovery. Value would be -1 if no valid copy is present for recovery.

  • installedWorkloads string[]

    Possible values: [GENERIC, O365, SALESFORCE, EXCHANGE, SHAREPOINT, ONEDRIVE, TEAMS, DYNAMICS_365, VSA, FILESYSTEM, KUBERNETES, AZURE_AD, CLOUD_LAPTOP, FILE_STORAGE_OPTIMIZATION, DATA_GOVERNANCE, E_DISCOVERY, SQL_SERVER, ORACLEDB, DB2, ACTIVE_DIRECTORY, DATABASE]

Loading...