Restorable Database Accounts - List

Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/restorableDatabaseAccounts?api-version=2026-03-15

URI Parameters

Name In Required Type Description
subscriptionId
path True

string (uuid)

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

api-version
query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

RestorableDatabaseAccountsListResult

The request has succeeded.

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

CosmosDBRestorableDatabaseAccountNoLocationList

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.DocumentDB/restorableDatabaseAccounts?api-version=2026-03-15

Sample response

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d",
      "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d",
      "location": "West US",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts",
      "properties": {
        "accountName": "ddb1",
        "creationTime": "2020-04-11T21:56:15Z",
        "deletionTime": "2021-03-12T22:05:09Z",
        "oldestRestorableTime": "2021-03-12T22:05:09Z",
        "apiType": "Sql",
        "restorableLocations": [
          {
            "locationName": "South Central US",
            "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5",
            "creationTime": "2020-10-30T21:13:10Z",
            "deletionTime": "2020-10-30T21:13:35Z"
          },
          {
            "locationName": "West US",
            "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c",
            "creationTime": "2020-10-30T21:13:10Z"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4",
      "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4",
      "location": "East US",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts",
      "properties": {
        "accountName": "ddb2",
        "creationTime": "2020-05-01T08:05:18Z",
        "oldestRestorableTime": "2020-05-01T08:05:18Z",
        "apiType": "Sql",
        "restorableLocations": [
          {
            "locationName": "South Central US",
            "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5",
            "creationTime": "2020-10-30T21:13:10Z",
            "deletionTime": "2020-10-30T21:13:35Z"
          },
          {
            "locationName": "West US",
            "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c",
            "creationTime": "2020-10-30T21:13:10Z"
          }
        ]
      }
    }
  ]
}

Definitions

Name Description
ApiType

Enum to indicate the API type of the restorable database account.

CloudError

An error response from the service.

createdByType

The type of identity that created the resource.

ErrorResponse

Error Response.

RestorableDatabaseAccountGetResult

A Azure Cosmos DB restorable database account.

RestorableDatabaseAccountsListResult

The List operation response, that contains the restorable database accounts and their properties.

RestorableLocationResource

Properties of the regional restorable account.

systemData

Metadata pertaining to creation and last modification of the resource.

ApiType

Enum to indicate the API type of the restorable database account.

Value Description
MongoDB
Gremlin
Cassandra
Table
Sql
GremlinV2

CloudError

An error response from the service.

Name Type Description
error

ErrorResponse

Error Response.

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorResponse

Error Response.

Name Type Description
code

string

Error code.

message

string

Error message indicating why the operation failed.

RestorableDatabaseAccountGetResult

A Azure Cosmos DB restorable database account.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

The location of the resource group to which the resource belongs.

name

string

The name of the resource

properties.accountName

string

The name of the global database account

properties.apiType

ApiType

The API type of the restorable database account.

properties.creationTime

string (date-time)

The creation time of the restorable database account (ISO-8601 format).

properties.deletionTime

string (date-time)

The time at which the restorable database account has been deleted (ISO-8601 format).

properties.oldestRestorableTime

string (date-time)

The least recent time at which the database account can be restored to (ISO-8601 format).

properties.restorableLocations

RestorableLocationResource[]

List of regions where the of the database account can be restored from.

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

RestorableDatabaseAccountsListResult

The List operation response, that contains the restorable database accounts and their properties.

Name Type Description
nextLink

string

value

RestorableDatabaseAccountGetResult[]

List of restorable database accounts and their properties.

RestorableLocationResource

Properties of the regional restorable account.

Name Type Description
creationTime

string (date-time)

The creation time of the regional restorable database account (ISO-8601 format).

deletionTime

string (date-time)

The time at which the regional restorable database account has been deleted (ISO-8601 format).

locationName

string

The location of the regional restorable account.

regionalDatabaseAccountInstanceId

string

The instance id of the regional restorable account.

systemData

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.