Method: projects.locations.backends.list

Lists backends in a given project and location.

HTTP request

GET https://firebaseapphosting.googleapis.com/v1/{parent=projects/*/locations/*}/backends

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. A parent name of the form projects/{project}/locations/{locationId}.

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 backends

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

JSON representation 
{
  "backends": [
    {
      object (Backend)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
backends[]

object (Backend)

The list of backends
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.backends.list

For more information, see the IAM documentation.

See also Firebase App Hosting's IAM Permissions and Predefined IAM Roles.