Restorable Gremlin Databases - List

Service:: Cosmos DB Resource Provider

API Version:: 2026-03-15

Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission

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

URI Parameters

Name	In	Required	Type	Description
instanceId	path	True	string	The instanceId GUID of a restorable database account.
location	path	True	string	Cosmos DB region, with spaces between words and each word capitalized.
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	RestorableGremlinDatabasesListResult	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

CosmosDBRestorableGremlinDatabaseList

Sample request

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinDatabases?api-version=2026-03-15

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_restorable_gremlin_database_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.restorable_gremlin_databases.list(
        location="WestUS",
        instance_id="d9b26648-2f53-4541-b3d8-3044f4f9810d",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2026-03-15/CosmosDBRestorableGremlinDatabaseList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
 *
 * @summary show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
 * x-ms-original-file: 2026-03-15/CosmosDBRestorableGremlinDatabaseList.json
 */
async function cosmosDBRestorableGremlinDatabaseList() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "2296c272-5d55-40d9-bc05-4d56dc2d7588";
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.restorableGremlinDatabases.list(
    "WestUS",
    "d9b26648-2f53-4541-b3d8-3044f4f9810d",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableGremlinDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "PD5DALigDgw=",
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "PD5DALigDgw=",
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the service.
ErrorResponse	Error Response.
OperationType	Enum to indicate the operation type of the event.
RestorableGremlinDatabaseGetResult	An Azure Cosmos DB Gremlin database event
RestorableGremlinDatabasePropertiesResource	The resource of an Azure Cosmos DB Gremlin database event
RestorableGremlinDatabasesListResult	The List operation response, that contains the Gremlin database events and their properties.

CloudError

Object

An error response from the service.

Name	Type	Description
error	ErrorResponse	Error Response.

ErrorResponse

Object

Error Response.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

OperationType

Enumeration

Enum to indicate the operation type of the event.

Value	Description
Create
Replace
Delete
Recreate
SystemOperation

RestorableGremlinDatabaseGetResult

Object

An Azure Cosmos DB Gremlin database event

Name	Type	Description
id	string	The unique resource Identifier of the ARM resource.
name	string	The name of the ARM resource.
properties.resource	RestorableGremlinDatabasePropertiesResource	The resource of an Azure Cosmos DB Gremlin database event
type	string	The type of Azure resource.

RestorableGremlinDatabasePropertiesResource

Object

The resource of an Azure Cosmos DB Gremlin database event

Name	Type	Description
_rid	string	A system generated property. A unique identifier.
canUndelete	string	A state of this database to identify if this database is restorable in same account.
canUndeleteReason	string	The reason why this database can not be restored in same account.
eventTimestamp	string	The time when this database event happened.
operationType	OperationType	The operation type of this database event.
ownerId	string	The name of this Gremlin database.
ownerResourceId	string	The resource ID of this Gremlin database.

RestorableGremlinDatabasesListResult

Object

The List operation response, that contains the Gremlin database events and their properties.

Name	Type	Description
nextLink	string
value	RestorableGremlinDatabaseGetResult[]	List of Gremlin database events and their properties.