Method: projects.locations.instances.list

Stay organized with collections Save and categorize content based on your preferences.

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

The location should have the following format:

  • projects/{projectId}/locations/{locationId}

If locationId is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The resource name of the instance location using the form: projects/{projectId}/locations/{locationId} where locationId refers to a GCP region.

Query parameters



The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the pageSize value, the response may include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.



The nextPageToken value returned from a previous instances.list request, if any.

Request body

The request body must be empty.

Response body

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

Response for instances.list.

JSON representation
  "instances": [
      object (Instance)
  "nextPageToken": string,
  "unreachable": [

object (Instance)

A list of Redis instances in the project in the specified location, or across all locations.

If the locationId in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the name field set to a value of the form projects/{projectId}/locations/{locationId}/instances/- and the status field set to ERROR and statusMessage field set to "location not available for instances.list".



Token to retrieve the next page of results, or empty if there are no more results in the list.



Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.