Method: projects.locations.instances.snapshots.list

Lists all snapshots in a project for either a specified location or for all locations.

HTTP request

GET https://file.googleapis.com/v1beta1/{parent=projects/*/locations/*/instances/*}/snapshots

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The instance for which to retrieve snapshot information, in the format projects/{projectId}/locations/{location}/instances/{instanceId}.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return.
pageToken

string

The nextPageToken value to use if there are additional results to retrieve for this list request.
orderBy

string

Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter

string

List filter.
returnPartialSuccess

boolean

Optional. If true, allow partial responses for multi-regional Aggregated List requests.

Request body

The request body must be empty.

Response body

ListSnapshotsResponse is the result of ListSnapshotsRequest.

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

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

object (Snapshot)

A list of snapshots in the project for the specified instance.
nextPageToken

string

The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
unreachable[]

string

Unordered list. 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 Authentication Overview.