Method: projects.locations.backends.rollouts.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists rollouts for a backend.
HTTP request
GET https://firebaseapphosting.googleapis.com/v1/{parent=projects/*/locations/*/backends/*}/rollouts
The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog
Path parameters
| Parameters |
parent |
string
Required. The parent backend in the format: projects/{project}/locations/{locationId}/backends/{backendId}.
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of results to return. If not set, the service selects a default.
|
pageToken |
string
Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.
|
filter |
string
Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's AIP 160 standard.
|
orderBy |
string
Optional. Hint for how to order the results. Supported fields are name and createTime. To specify descending order, append a desc suffix.
|
showDeleted |
boolean
Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.
|
Request body
The request body must be empty.
Response body
Message for response to list rollouts.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"rollouts": [
{
object (Rollout)
}
],
"nextPageToken": string,
"unreachable": [
string
]
} |
| Fields |
rollouts[] |
object (Rollout)
The list of rollouts.
|
nextPageToken |
string
A token identifying the next page of results the server should return.
|
unreachable[] |
string
Locations that could not be reached.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
IAM Permissions
Requires the following IAM permission on the parent resource:
firebaseapphosting.rollouts.list
For more information, see the IAM documentation.
See also Firebase App Hosting's IAM Permissions and Predefined IAM Roles.
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-04-04 UTC.
[null,null,["Last updated 2025-04-04 UTC."],[],[],null,["# Method: projects.locations.backends.rollouts.list\n\nLists rollouts for a backend.\n\n### HTTP request\n\n`GET https://firebaseapphosting.googleapis.com/v1/{parent=projects/*/locations/*/backends/*}/rollouts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the [service error catalog](/docs/reference/apphosting/rest/v1/errors)\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`. |\n\n### Query parameters\n\n| Parameters ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of results to return. If not set, the service selects a default. |\n| `pageToken` | `string` Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. |\n| `filter` | `string` Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). |\n| `orderBy` | `string` Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. |\n| `showDeleted` | `boolean` Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nMessage for response to list rollouts.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"rollouts\": [ { object (/docs/reference/apphosting/rest/v1/projects.locations.backends.rollouts#Rollout) } ], \"nextPageToken\": string, \"unreachable\": [ string ] } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `rollouts[]` | `object (`[Rollout](/docs/reference/apphosting/rest/v1/projects.locations.backends.rollouts#Rollout)`)` The list of rollouts. |\n| `nextPageToken` | `string` A token identifying the next page of results the server should return. |\n| `unreachable[]` | `string` Locations that could not be reached. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\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).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `firebaseapphosting.rollouts.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs).\n\nSee also Firebase App Hosting's [IAM Permissions](https://firebase.google.com/docs/projects/iam/permissions#app-hosting) and [Predefined IAM Roles](https://firebase.google.com/docs/projects/iam/roles-predefined-product)."]]
