Method: projects.apps.releases.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists releases. By default, sorts by createTime in descending order.
HTTP request
GET https://firebaseappdistribution.googleapis.com/v1/{parent=projects/*/apps/*}/releases
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the app resource, which is the parent of the release resources. Format: projects/{projectNumber}/apps/{appId}
Authorization requires the following IAM permission on the Firebase project that owns the specified resource parent:
firebaseappdistro.releases.list
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of releases to return. The service may return fewer than this value. The valid range is [1-100]; If unspecified (0), at most 25 releases are returned. Values above 100 are coerced to 100.
|
pageToken |
string
A page token, received from a previous releases.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to releases.list must match the call that provided the page token.
|
orderBy |
string
The fields used to order releases. Supported fields:
To specify descending order for a field, append a "desc" suffix, for example, createTime desc. If this parameter is not set, releases are ordered by createTime in descending order.
|
filter |
string
The expression to filter releases listed in the response. To learn more about filtering, refer to Google's AIP-160 standard. Supported fields:
releaseNotes.text supports = (can contain a wildcard character (*) at the beginning or end of the string)createTime supports <, <=, > and >=, and expects an RFC-3339 formatted string Examples:
createTime <= "2021-09-08T00:00:00+04:00"releaseNotes.text="fixes" AND createTime >= "2021-09-08T00:00:00.0Z"releaseNotes.text="*v1.0.0-rc*"
|
Request body
The request body must be empty.
Response body
The response message for releases.list.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"releases": [
{
object (Release)
}
],
"nextPageToken": string
} |
| Fields |
releases[] |
object (Release)
The releases
|
nextPageToken |
string
A short-lived token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires the following OAuth scope:
https://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 2024-12-30 UTC.
[null,null,["Last updated 2024-12-30 UTC."],[],[],null,["# Method: projects.apps.releases.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListReleasesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists releases. By default, sorts by `createTime` in descending order.\n\n### HTTP request\n\n`GET https://firebaseappdistribution.googleapis.com/v1/{parent=projects/*/apps/*}/releases`\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 name of the app resource, which is the parent of the release resources. Format: `projects/{projectNumber}/apps/{appId}` Authorization requires the following [IAM](https://firebase.google.com/docs/projects/iam/overview/) permission on the Firebase project that owns the specified resource `parent`: - `firebaseappdistro.releases.list` |\n\n### Query parameters\n\n| Parameters ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `page``Size` | `integer` The maximum number of releases to return. The service may return fewer than this value. The valid range is \\[1-100\\]; If unspecified (0), at most 25 releases are returned. Values above 100 are coerced to 100. |\n| `page``Token` | `string` A page token, received from a previous `releases.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `releases.list` must match the call that provided the page token. |\n| `order``By` | `string` The fields used to order releases. Supported fields: - `createTime` To specify descending order for a field, append a \"desc\" suffix, for example, `createTime desc`. If this parameter is not set, releases are ordered by `createTime` in descending order. |\n| `filter` | `string` The expression to filter releases listed in the response. To learn more about filtering, refer to [Google's AIP-160 standard](http://aip.dev/160). Supported fields: - `releaseNotes.text` supports `=` (can contain a wildcard character (`*`) at the beginning or end of the string) - `createTime` supports `\u003c`, `\u003c=`, `\u003e` and `\u003e=`, and expects an RFC-3339 formatted string Examples: - `createTime \u003c= \"2021-09-08T00:00:00+04:00\"` - `releaseNotes.text=\"fixes\" AND createTime \u003e= \"2021-09-08T00:00:00.0Z\"` - `releaseNotes.text=\"*v1.0.0-rc*\"` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for `releases.list`.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"releases\": [ { object (/docs/reference/app-distribution/rest/v1/projects.apps.releases#Release) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `releases[]` | `object (`[Release](/docs/reference/app-distribution/rest/v1/projects.apps.releases#Release)`)` The releases |\n| `next``Page``Token` | `string` A short-lived token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\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)."]]
