Method: projects.databases.list
Stay organized with collections
Save and categorize content based on your preferences.
List all the databases in the project.
HTTP request
GET https://firestore.googleapis.com/v1/{parent=projects/*}/databases
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. A parent name of the form projects/{projectId}
|
Query parameters
| Parameters |
showDeleted |
boolean
If true, also returns deleted resources.
|
Request body
The request body must be empty.
Response body
The list of databases for a project.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"databases": [
{
object (Database)
}
],
"unreachable": [
string
]
} |
| Fields |
databases[] |
object (Database)
The databases in the project.
|
unreachable[] |
string
In the event that data about individual databases cannot be listed they will be recorded here. An example entry might be: projects/some_project/locations/some_location This can happen if the Cloud Region that the Database resides in is currently unavailable. In this case we can't fetch all the details about the database. You may be able to get a more detailed error message (or possibly fetch the resource) by sending a 'Get' request for the resource or a 'List' request for the specific location.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-20 UTC.
[null,null,["Last updated 2025-06-20 UTC."],[],[],null,["# Method: projects.databases.list\n\nList all the databases in the project.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1/{parent=projects/*}/databases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------|\n| `parent` | `string` Required. A parent name of the form `projects/{projectId}` |\n\n### Query parameters\n\n| Parameters ||\n|---------------|----------------------------------------------------|\n| `showDeleted` | `boolean` If true, also returns deleted resources. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe list of databases for a project.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"databases\": [ { object (/docs/firestore/reference/rest/v1/projects.databases#Database) } ], \"unreachable\": [ string ] } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `databases[]` | `object (`[Database](/docs/firestore/reference/rest/v1/projects.databases#Database)`)` The databases in the project. |\n| `unreachable[]` | `string` In the event that data about individual databases cannot be listed they will be recorded here. An example entry might be: projects/some_project/locations/some_location This can happen if the Cloud Region that the Database resides in is currently unavailable. In this case we can't fetch all the details about the database. You may be able to get a more detailed error message (or possibly fetch the resource) by sending a 'Get' request for the resource or a 'List' request for the specific location. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
