Lists the names of the snapshots on this topic. Snapshots are used insubscriptions.seekoperations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
HTTP request
Path parameters
Parameters
topic
string
Required. The name of the topic that snapshots are attached to. Format isprojects/{project}/topics/{topic}.
Query parameters
Parameters
pageSize
integer
Optional. Maximum number of snapshot names to return.
pageToken
string
Optional. The value returned by the lastListTopicSnapshotsResponse; indicates that this is a continuation of a priorsnapshots.listcall, and that the system should return the next page of data.
Request body
The request body must be empty.
Response body
Response for thesnapshots.listmethod.
If successful, the response body contains data with the following structure:
JSON representation
{"snapshots":[string],"nextPageToken":string}
Fields
snapshots[]
string
Optional. The names of the snapshots that match the request.
nextPageToken
string
Optional. If not empty, indicates that there may be more snapshots that match the request; this value should be passed in a newListTopicSnapshotsRequestto get more snapshots.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-22 UTC."],[],[],null,["# Method: projects.topics.snapshots.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListTopicSnapshotsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the names of the snapshots on this topic. Snapshots are used in [subscriptions.seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.\n\n### HTTP request\n\nChoose a location: \nglobal \n\n\u003cbr /\u003e\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse for the `snapshots.list` method.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/pubsub`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
