Method: projects.secrets.list

Lists Secrets.

HTTP request

GET https://secretmanager.googleapis.com/v1/{parent=projects/*}/secrets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the project associated with the Secrets, in the format projects/*.

Authorization requires the following IAM permission on the specified resource parent:

  • secretmanager.secrets.list

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

pageToken

string

Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.

Request body

The request body must be empty.

Response body

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

Response message for SecretManagerService.ListSecrets.

JSON representation
{
  "secrets": [
    {
      object (Secret)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
secrets[]

object (Secret)

The list of Secrets sorted in reverse by createTime (newest first).

nextPageToken

string

A token to retrieve the next page of results. Pass this value in ListSecretsRequest.page_token to retrieve the next page.

totalSize

integer

The total number of Secrets.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.