Method: projects.sites.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists each Hosting Site associated with the specified parent Firebase project.
HTTP request
GET https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*}/sites
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The Firebase project for which to list sites, in the format:
projects/PROJECT_IDENTIFIER
Refer to the Site name field for details about PROJECT_IDENTIFIER values.
Authorization requires the following IAM permission on the specified resource parent:
firebasehosting.sites.list
|
Query parameters
| Parameters |
pageToken |
string
Optional. A token from a previous call to sites.list that tells the server where to resume listing.
|
pageSize |
integer
Optional. The maximum number of sites to return. The service may return a lower number if fewer sites exist than this maximum number.
If unspecified, defaults to 40.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"sites": [
{
object (Site)
}
],
"nextPageToken": string
} |
| Fields |
sites[] |
object (Site)
A list of Site objects associated with the specified Firebase project.
|
nextPageToken |
string
The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to sites.list. Page tokens are short-lived and should not be stored.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/firebase.hosting.readonly
https://www.googleapis.com/auth/firebase.hosting
https://www.googleapis.com/auth/firebase.readonly
https://www.googleapis.com/auth/firebase
https://www.googleapis.com/auth/cloud-platform.read-only
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication 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 2023-09-11 UTC.
[null,null,["Last updated 2023-09-11 UTC."],[],[],null,["# Method: projects.sites.list\n\nLists each Hosting [Site](/docs/reference/hosting/rest/v1beta1/projects.sites#Site) associated with the specified parent Firebase project.\n\n### HTTP request\n\n`GET https://firebasehosting.googleapis.com/v1beta1/{parent=projects/*}/sites`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The Firebase project for which to list sites, in the format: `projects/`\u003cvar translate=\"no\"\u003ePROJECT_IDENTIFIER\u003c/var\u003e Refer to the `Site` [`name`](../projects#Site.FIELDS.name) field for details about \u003cvar translate=\"no\"\u003ePROJECT_IDENTIFIER\u003c/var\u003e values. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `firebasehosting.sites.list` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageToken` | `string` Optional. A token from a previous call to `sites.list` that tells the server where to resume listing. |\n| `pageSize` | `integer` Optional. The maximum number of sites to return. The service may return a lower number if fewer sites exist than this maximum number. If unspecified, defaults to 40. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"sites\": [ { object (/docs/reference/hosting/rest/v1beta1/projects.sites#Site) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sites[]` | `object (`[Site](/docs/reference/hosting/rest/v1beta1/projects.sites#Site)`)` A list of [Site](/docs/reference/hosting/rest/v1beta1/projects.sites#Site) objects associated with the specified Firebase project. |\n| `nextPageToken` | `string` The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to `sites.list`. Page tokens are short-lived and should not be stored. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/firebase.hosting.readonly`\n- `\n https://www.googleapis.com/auth/firebase.hosting`\n- `\n https://www.googleapis.com/auth/firebase.readonly`\n- `\n https://www.googleapis.com/auth/firebase`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
