Method: sites.channels.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the channels for the specified site.
All sites have a default live channel.
HTTP request
GET https://firebasehosting.googleapis.com/v1beta1/{parent=sites/*}/channels
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The site for which to list channels, in the format:
sites/SITE_ID
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of channels to return. The service may return a lower number if fewer channels exist than this maximum number.
If unspecified, defaults to 10. The maximum value is 100; values above 100 will be coerced to 100.
|
pageToken |
string
A token from a previous call to channels.list that tells the server where to resume listing.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"channels": [
{
object (Channel)
}
],
"nextPageToken": string
} |
| Fields |
channels[] |
object (Channel)
The list of channels.
|
nextPageToken |
string
The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to channels.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: sites.channels.list\n\nLists the channels for the specified site.\n\nAll sites have a default `live` channel.\n\n### HTTP request\n\n`GET https://firebasehosting.googleapis.com/v1beta1/{parent=sites/*}/channels`\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 site for which to list channels, in the format: `sites/`\u003cvar translate=\"no\"\u003eSITE_ID\u003c/var\u003e |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of channels to return. The service may return a lower number if fewer channels exist than this maximum number. If unspecified, defaults to 10. The maximum value is 100; values above 100 will be coerced to 100. |\n| `pageToken` | `string` A token from a previous call to `channels.list` that tells the server where to resume listing. |\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| ``` { \"channels\": [ { object (/docs/reference/hosting/rest/v1beta1/sites.channels#Channel) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `channels[]` | `object (`[Channel](/docs/reference/hosting/rest/v1beta1/sites.channels#Channel)`)` The list of channels. |\n| `nextPageToken` | `string` The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to `channels.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/)."]]
