Share via

Restorable Time Ranges - Find

Service:
Data Protection
API Version:
2025-09-01 
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges?api-version=2025-09-01

URI Parameters

Name In Required Type Description
backupInstanceName
 path True

string

The name of the BackupInstanceResource
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
vaultName
 path True

string

minLength: 2
maxLength: 50
pattern: ^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$

The name of the backup vault.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Required Type Description
sourceDataStoreType True

RestoreSourceDataStoreType

Gets or sets the type of the source data store.
endTime

string

End time for the List Restore Ranges request. ISO 8601 format.
startTime

string

Start time for the List Restore Ranges request. ISO 8601 format.

Responses

Name Type Description
200 OK

AzureBackupFindRestorableTimeRangesResponseResource

Azure operation completed successfully.
Other Status Codes

CloudError

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Find Restorable Time Ranges

Sample request

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/Blob-Backup/providers/Microsoft.DataProtection/backupVaults/ZBlobBackupVaultBVTD3/backupInstances/zblobbackuptestsa58/findRestorableTimeRanges?api-version=2025-09-01

{
  "endTime": "2021-02-24T00:35:17.6829685Z",
  "sourceDataStoreType": "OperationalStore",
  "startTime": "2020-10-17T23:28:17.6829685Z"
}

Sample response

Status code:
200 
{
  "type": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges",
  "id": "zblobbackuptestsa58",
  "properties": {
    "objectType": "AzureBackupFindRestorableTimeRangesResponse",
    "restorableTimeRanges": [
      {
        "endTime": "2021-02-24T00:35:17.0000000Z",
        "objectType": "RestorableTimeRange",
        "startTime": "2021-02-23T18:33:51.6349708Z"
      }
    ]
  }
}

Definitions

Name Description
AzureBackupFindRestorableTimeRangesRequest

List Restore Ranges Request
AzureBackupFindRestorableTimeRangesResponse

List Restore Ranges Response
AzureBackupFindRestorableTimeRangesResponseResource

List Restore Ranges Response
CloudError

An error response from Azure Backup.
createdByType

The type of identity that created the resource.
Error

The resource management error response.
ErrorAdditionalInfo

The resource management error additional info.
RestorableTimeRange
RestoreSourceDataStoreType

Gets or sets the type of the source data store.
systemData

Metadata pertaining to creation and last modification of the resource.

AzureBackupFindRestorableTimeRangesRequest

Object

List Restore Ranges Request

Name Type Description
endTime

string

End time for the List Restore Ranges request. ISO 8601 format.
sourceDataStoreType

RestoreSourceDataStoreType

Gets or sets the type of the source data store.
startTime

string

Start time for the List Restore Ranges request. ISO 8601 format.

AzureBackupFindRestorableTimeRangesResponse

Object

List Restore Ranges Response

Name Type Description
objectType

string

restorableTimeRanges

RestorableTimeRange[]

Returns the Restore Ranges available on the Backup Instance.

AzureBackupFindRestorableTimeRangesResponseResource

Object

List Restore Ranges Response

Name Type Description
id

string

Resource Id represents the complete path to the resource.
name

string

Resource name associated with the resource.
properties

AzureBackupFindRestorableTimeRangesResponse

AzureBackupFindRestorableTimeRangesResponseResource properties
systemData

systemData

Metadata pertaining to creation and last modification of the resource.
type

string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

CloudError

Object

An error response from Azure Backup.

Name Type Description
error

Error

The resource management error response.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

Error

Object

The resource management error response.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

Error[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

RestorableTimeRange

Object
Name Type Description
endTime

string

End time for the available restore range
objectType

string

startTime

string

Start time for the available restore range

RestoreSourceDataStoreType

Enumeration

Gets or sets the type of the source data store.

Value Description
OperationalStore
VaultStore
ArchiveStore

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.