Cloud Logging API

Writes log entries and manages your Cloud Logging configuration. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the documentation at https://cloud.google.com/logging/docs.

Service: logging.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://logging.googleapis.com

REST Resource: v2

Methods
getCmekSettings GET /v2/{name=*/*}/cmekSettings
Gets the Logs Router CMEK settings for the given resource.
updateCmekSettings PATCH /v2/{name=*/*}/cmekSettings
Updates the Logs Router CMEK settings for the given resource.

REST Resource: v2.billingAccounts.buckets

Methods
get GET /v2/{name=billingAccounts/*/buckets/*}
Gets a bucket.

REST Resource: v2.billingAccounts.buckets.views

Methods
get GET /v2/{name=billingAccounts/*/buckets/*/views/*}
Gets a view.

REST Resource: v2.billingAccounts.exclusions

Methods
create POST /v2/{parent=billingAccounts/*}/exclusions
Creates a new exclusion in a specified parent resource.
delete DELETE /v2/{name=billingAccounts/*/exclusions/*}
Deletes an exclusion.
get GET /v2/{name=billingAccounts/*/exclusions/*}
Gets the description of an exclusion.
list GET /v2/{parent=billingAccounts/*}/exclusions
Lists all the exclusions in a parent resource.
patch PATCH /v2/{name=billingAccounts/*/exclusions/*}
Changes one or more properties of an existing exclusion.

REST Resource: v2.billingAccounts.locations.buckets

Methods
create POST /v2/{parent=billingAccounts/*/locations/*}/buckets
Creates a bucket that can be used to store log entries.
delete DELETE /v2/{name=billingAccounts/*/locations/*/buckets/*}
Deletes a bucket.
list GET /v2/{parent=billingAccounts/*/locations/*}/buckets
Lists buckets.
patch PATCH /v2/{name=billingAccounts/*/locations/*/buckets/*}
Updates a bucket.
undelete POST /v2/{name=billingAccounts/*/locations/*/buckets/*}:undelete
Undeletes a bucket.

REST Resource: v2.billingAccounts.locations.buckets.views

Methods
create POST /v2/{parent=billingAccounts/*/locations/*/buckets/*}/views
Creates a view over logs in a bucket.
delete DELETE /v2/{name=billingAccounts/*/locations/*/buckets/*/views/*}
Deletes a view from a bucket.
list GET /v2/{parent=billingAccounts/*/locations/*/buckets/*}/views
Lists views on a bucket.
patch PATCH /v2/{name=billingAccounts/*/locations/*/buckets/*/views/*}
Updates a view.

REST Resource: v2.billingAccounts.logs

Methods
delete DELETE /v2/{logName=billingAccounts/*/logs/*}
Deletes all the log entries in a log for the _Default Log Bucket.
list GET /v2/{parent=billingAccounts/*}/logs
Lists the logs in projects, organizations, folders, or billing accounts.

REST Resource: v2.billingAccounts.sinks

Methods
create POST /v2/{parent=billingAccounts/*}/sinks
Creates a sink that exports specified log entries to a destination.
delete DELETE /v2/{sinkName=billingAccounts/*/sinks/*}
Deletes a sink.
get GET /v2/{sinkName=billingAccounts/*/sinks/*}
Gets a sink.
list GET /v2/{parent=billingAccounts/*}/sinks
Lists sinks.
patch PATCH /v2/{sinkName=billingAccounts/*/sinks/*}
Updates a sink.
update PUT /v2/{sinkName=billingAccounts/*/sinks/*}
Updates a sink.

REST Resource: v2.entries

Methods
list POST /v2/entries:list
Lists log entries.
tail POST /v2/entries:tail
Streaming read of log entries as they are ingested.
write POST /v2/entries:write
Writes log entries to Logging.

REST Resource: v2.exclusions

Methods
create POST /v2/{parent=*/*}/exclusions
Creates a new exclusion in a specified parent resource.
delete DELETE /v2/{name=*/*/exclusions/*}
Deletes an exclusion.
get GET /v2/{name=*/*/exclusions/*}
Gets the description of an exclusion.
list GET /v2/{parent=*/*}/exclusions
Lists all the exclusions in a parent resource.
patch PATCH /v2/{name=*/*/exclusions/*}
Changes one or more properties of an existing exclusion.

REST Resource: v2.folders.exclusions

Methods
create POST /v2/{parent=folders/*}/exclusions
Creates a new exclusion in a specified parent resource.
delete DELETE /v2/{name=folders/*/exclusions/*}
Deletes an exclusion.
get GET /v2/{name=folders/*/exclusions/*}
Gets the description of an exclusion.
list GET /v2/{parent=folders/*}/exclusions
Lists all the exclusions in a parent resource.
patch PATCH /v2/{name=folders/*/exclusions/*}
Changes one or more properties of an existing exclusion.

REST Resource: v2.folders.locations.buckets

Methods
create POST /v2/{parent=folders/*/locations/*}/buckets
Creates a bucket that can be used to store log entries.
delete DELETE /v2/{name=folders/*/locations/*/buckets/*}
Deletes a bucket.
get GET /v2/{name=folders/*/locations/*/buckets/*}
Gets a bucket.
list GET /v2/{parent=folders/*/locations/*}/buckets
Lists buckets.
patch PATCH /v2/{name=folders/*/locations/*/buckets/*}
Updates a bucket.
undelete POST /v2/{name=folders/*/locations/*/buckets/*}:undelete
Undeletes a bucket.

REST Resource: v2.folders.locations.buckets.views

Methods
create POST /v2/{parent=folders/*/locations/*/buckets/*}/views
Creates a view over logs in a bucket.
delete DELETE /v2/{name=folders/*/locations/*/buckets/*/views/*}
Deletes a view from a bucket.
get GET /v2/{name=folders/*/locations/*/buckets/*/views/*}
Gets a view.
list GET /v2/{parent=folders/*/locations/*/buckets/*}/views
Lists views on a bucket.
patch PATCH /v2/{name=folders/*/locations/*/buckets/*/views/*}
Updates a view.

REST Resource: v2.folders.logs

Methods
delete DELETE /v2/{logName=folders/*/logs/*}
Deletes all the log entries in a log for the _Default Log Bucket.
list GET /v2/{parent=folders/*}/logs
Lists the logs in projects, organizations, folders, or billing accounts.

REST Resource: v2.folders.sinks

Methods
create POST /v2/{parent=folders/*}/sinks
Creates a sink that exports specified log entries to a destination.
delete DELETE /v2/{sinkName=folders/*/sinks/*}
Deletes a sink.
get GET /v2/{sinkName=folders/*/sinks/*}
Gets a sink.
list GET /v2/{parent=folders/*}/sinks
Lists sinks.
patch PATCH /v2/{sinkName=folders/*/sinks/*}
Updates a sink.
update PUT /v2/{sinkName=folders/*/sinks/*}
Updates a sink.

REST Resource: v2.locations.buckets

Methods
create POST /v2/{parent=*/*/locations/*}/buckets
Creates a bucket that can be used to store log entries.
delete DELETE /v2/{name=*/*/locations/*/buckets/*}
Deletes a bucket.
get GET /v2/{name=*/*/locations/*/buckets/*}
Gets a bucket.
list GET /v2/{parent=*/*/locations/*}/buckets
Lists buckets.
patch PATCH /v2/{name=*/*/locations/*/buckets/*}
Updates a bucket.
undelete POST /v2/{name=*/*/locations/*/buckets/*}:undelete
Undeletes a bucket.

REST Resource: v2.locations.buckets.views

Methods
create POST /v2/{parent=*/*/locations/*/buckets/*}/views
Creates a view over logs in a bucket.
delete DELETE /v2/{name=*/*/locations/*/buckets/*/views/*}
Deletes a view from a bucket.
get GET /v2/{name=*/*/locations/*/buckets/*/views/*}
Gets a view.
list GET /v2/{parent=*/*/locations/*/buckets/*}/views
Lists views on a bucket.
patch PATCH /v2/{name=*/*/locations/*/buckets/*/views/*}
Updates a view.

REST Resource: v2.logs

Methods
delete DELETE /v2/{logName=*/*/logs/*}
Deletes all the log entries in a log for the _Default Log Bucket.
list GET /v2/{parent=*/*}/logs
Lists the logs in projects, organizations, folders, or billing accounts.

REST Resource: v2.monitoredResourceDescriptors

Methods
list GET /v2/monitoredResourceDescriptors
Lists the descriptors for monitored resource types used by Logging.

REST Resource: v2.organizations

Methods
getCmekSettings GET /v2/{name=organizations/*}/cmekSettings
Gets the Logs Router CMEK settings for the given resource.
updateCmekSettings PATCH /v2/{name=organizations/*}/cmekSettings
Updates the Logs Router CMEK settings for the given resource.

REST Resource: v2.organizations.exclusions

Methods
create POST /v2/{parent=organizations/*}/exclusions
Creates a new exclusion in a specified parent resource.
delete DELETE /v2/{name=organizations/*/exclusions/*}
Deletes an exclusion.
get GET /v2/{name=organizations/*/exclusions/*}
Gets the description of an exclusion.
list GET /v2/{parent=organizations/*}/exclusions
Lists all the exclusions in a parent resource.
patch PATCH /v2/{name=organizations/*/exclusions/*}
Changes one or more properties of an existing exclusion.

REST Resource: v2.organizations.locations.buckets

Methods
create POST /v2/{parent=organizations/*/locations/*}/buckets
Creates a bucket that can be used to store log entries.
delete DELETE /v2/{name=organizations/*/locations/*/buckets/*}
Deletes a bucket.
get GET /v2/{name=organizations/*/locations/*/buckets/*}
Gets a bucket.
list GET /v2/{parent=organizations/*/locations/*}/buckets
Lists buckets.
patch PATCH /v2/{name=organizations/*/locations/*/buckets/*}
Updates a bucket.
undelete POST /v2/{name=organizations/*/locations/*/buckets/*}:undelete
Undeletes a bucket.

REST Resource: v2.organizations.locations.buckets.views

Methods
create POST /v2/{parent=organizations/*/locations/*/buckets/*}/views
Creates a view over logs in a bucket.
delete DELETE /v2/{name=organizations/*/locations/*/buckets/*/views/*}
Deletes a view from a bucket.
get GET /v2/{name=organizations/*/locations/*/buckets/*/views/*}
Gets a view.
list GET /v2/{parent=organizations/*/locations/*/buckets/*}/views
Lists views on a bucket.
patch PATCH /v2/{name=organizations/*/locations/*/buckets/*/views/*}
Updates a view.

REST Resource: v2.organizations.logs

Methods
delete DELETE /v2/{logName=organizations/*/logs/*}
Deletes all the log entries in a log for the _Default Log Bucket.
list GET /v2/{parent=organizations/*}/logs
Lists the logs in projects, organizations, folders, or billing accounts.

REST Resource: v2.organizations.sinks

Methods
create POST /v2/{parent=organizations/*}/sinks
Creates a sink that exports specified log entries to a destination.
delete DELETE /v2/{sinkName=organizations/*/sinks/*}
Deletes a sink.
get GET /v2/{sinkName=organizations/*/sinks/*}
Gets a sink.
list GET /v2/{parent=organizations/*}/sinks
Lists sinks.
patch PATCH /v2/{sinkName=organizations/*/sinks/*}
Updates a sink.
update PUT /v2/{sinkName=organizations/*/sinks/*}
Updates a sink.

REST Resource: v2.projects.exclusions

Methods
create POST /v2/{parent=projects/*}/exclusions
Creates a new exclusion in a specified parent resource.
delete DELETE /v2/{name=projects/*/exclusions/*}
Deletes an exclusion.
get GET /v2/{name=projects/*/exclusions/*}
Gets the description of an exclusion.
list GET /v2/{parent=projects/*}/exclusions
Lists all the exclusions in a parent resource.
patch PATCH /v2/{name=projects/*/exclusions/*}
Changes one or more properties of an existing exclusion.

REST Resource: v2.projects.locations.buckets

Methods
create POST /v2/{parent=projects/*/locations/*}/buckets
Creates a bucket that can be used to store log entries.
delete DELETE /v2/{name=projects/*/locations/*/buckets/*}
Deletes a bucket.
get GET /v2/{name=projects/*/locations/*/buckets/*}
Gets a bucket.
list GET /v2/{parent=projects/*/locations/*}/buckets
Lists buckets.
patch PATCH /v2/{name=projects/*/locations/*/buckets/*}
Updates a bucket.
undelete POST /v2/{name=projects/*/locations/*/buckets/*}:undelete
Undeletes a bucket.

REST Resource: v2.projects.locations.buckets.views

Methods
create POST /v2/{parent=projects/*/locations/*/buckets/*}/views
Creates a view over logs in a bucket.
delete DELETE /v2/{name=projects/*/locations/*/buckets/*/views/*}
Deletes a view from a bucket.
get GET /v2/{name=projects/*/locations/*/buckets/*/views/*}
Gets a view.
list GET /v2/{parent=projects/*/locations/*/buckets/*}/views
Lists views on a bucket.
patch PATCH /v2/{name=projects/*/locations/*/buckets/*/views/*}
Updates a view.

REST Resource: v2.projects.logs

Methods
delete DELETE /v2/{logName=projects/*/logs/*}
Deletes all the log entries in a log for the _Default Log Bucket.
list GET /v2/{parent=projects/*}/logs
Lists the logs in projects, organizations, folders, or billing accounts.

REST Resource: v2.projects.metrics

Methods
create POST /v2/{parent=projects/*}/metrics
Creates a logs-based metric.
delete DELETE /v2/{metricName=projects/*/metrics/*}
Deletes a logs-based metric.
get GET /v2/{metricName=projects/*/metrics/*}
Gets a logs-based metric.
list GET /v2/{parent=projects/*}/metrics
Lists logs-based metrics.
update PUT /v2/{metricName=projects/*/metrics/*}
Creates or updates a logs-based metric.

REST Resource: v2.projects.sinks

Methods
create POST /v2/{parent=projects/*}/sinks
Creates a sink that exports specified log entries to a destination.
delete DELETE /v2/{sinkName=projects/*/sinks/*}
Deletes a sink.
get GET /v2/{sinkName=projects/*/sinks/*}
Gets a sink.
list GET /v2/{parent=projects/*}/sinks
Lists sinks.
patch PATCH /v2/{sinkName=projects/*/sinks/*}
Updates a sink.
update PUT /v2/{sinkName=projects/*/sinks/*}
Updates a sink.

REST Resource: v2.sinks

Methods
create POST /v2/{parent=*/*}/sinks
Creates a sink that exports specified log entries to a destination.
delete DELETE /v2/{sinkName=*/*/sinks/*}
Deletes a sink.
get GET /v2/{sinkName=*/*/sinks/*}
Gets a sink.
list GET /v2/{parent=*/*}/sinks
Lists sinks.
update PUT /v2/{sinkName=*/*/sinks/*}
Updates a sink.