Method: projects.sinks.list

Lists sinks.

HTTP request


GET https://logging.googleapis.com/v2/{parent=projects/*}/sinks

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource whose sinks are to be listed:

"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"

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

  • logging.sinks.list

Query parameters

Parameters
pageToken

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
pageSize

integer

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
filter

string

Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings:

  • ''
  • 'in_scope("ALL")',
  • 'in_scope("ANCESTOR")',
  • 'in_scope("DEFAULT")'.

Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.

When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListSinksResponse.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/logging.read
  • https://www.googleapis.com/auth/logging.admin
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.