Method: projects.snapshots.list

Lists the existing snapshots.

ALPHA: This feature is part of an alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

HTTP request

GET https://pubsub.googleapis.com/v1/{project}/snapshots

Path parameters

Parameters
project

string

The name of the cloud project that snapshots belong to. Format is projects/{project}.

Query parameters

Parameters
pageSize

number

Maximum number of snapshots to return.

pageToken

string

The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior snapshots.list call, and that the system should return the next page of data.

Request body

The request body must be empty.

Response body

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

Response for the snapshots.list method.

ALPHA: This feature is part of an alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

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

object(Snapshot)

The resulting snapshots.

nextPageToken

string

If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new ListSnapshotsRequest.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Pub/Sub