Method: projects.releases.list

List the Release values for a project. This list may optionally be filtered by Release name, Ruleset name, TestSuite name, or any combination thereof.

HTTP request

GET https://firebaserules.googleapis.com/v1/{name=projects/*}/releases

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name for the project.

Format: projects/{project_id}

Query parameters

Parameters
filter

string

Release filter. The list method supports filters with restrictions on the Release.name, and Release.ruleset_name.

Example 1: A filter of 'name=prod*' might return Releases with names within 'projects/foo' prefixed with 'prod':

Name -> Ruleset Name:

  • projects/foo/releases/prod -> projects/foo/rulesets/uuid1234
  • projects/foo/releases/prod/v1 -> projects/foo/rulesets/uuid1234
  • projects/foo/releases/prod/v2 -> projects/foo/rulesets/uuid8888

Example 2: A filter of name=prod* rulesetName=uuid1234 would return only Release instances for 'projects/foo' with names prefixed with 'prod' referring to the same Ruleset name of 'uuid1234':

Name -> Ruleset Name:

  • projects/foo/releases/prod -> projects/foo/rulesets/1234
  • projects/foo/releases/prod/v1 -> projects/foo/rulesets/1234

In the examples, the filter parameters refer to the search filters are relative to the project. Fully qualified prefixed may also be used.
pageSize

integer

Page size to load. Maximum of 100. Defaults to 10. Note: pageSize is just a hint and the service may choose to load fewer than pageSize results due to the size of the output. To traverse all of the releases, the caller should iterate until the pageToken on the response is empty.
pageToken

string

Next page token for the next batch of Release instances.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The response for FirebaseRulesService.ListReleases.

JSON representation 
{
  "releases": [
    {
      object (Release)
    }
  ],
  "nextPageToken": string
}
Fields
releases[]

object (Release)

List of Release instances.
nextPageToken

string

The pagination token to retrieve the next page of results. If the value is empty, no further results remain.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

For more information, see the Authentication Overview.