Apigee API Management audit logging

This document describes audit logging for Apigee API Management. Google Cloud servicesgenerate audit logs that record administrative and access activities within your Google Cloud resources.For more information about Cloud Audit Logs, see the following:

Service name

Apigee API Management audit logs use the service nameapim.googleapis.com.Filter for this service:

protoPayload.serviceName="apim.googleapis.com"

Methods by permission type

Each IAM permission has atype property, whose value is an enumthat can be one of four values:ADMIN_READ,ADMIN_WRITE,DATA_READ, orDATA_WRITE. When you call a method,Apigee API Management generates an audit log whose category is dependent on thetype property of the permission required to perform the method.Methods that require an IAM permission with thetype property valueofDATA_READ,DATA_WRITE, orADMIN_READ generateData Access audit logs.Methods that require an IAM permission with thetype property valueofADMIN_WRITE generateAdmin Activity audit logs.

API methods in the following list that are marked with (LRO) are long-running operations (LROs).These methods usually generate two audit log entries: one when the operation starts andanother when it ends. For more information seeAudit logs for long-running operations.
Permission typeMethods
ADMIN_READgoogle.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationSource
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources
ADMIN_WRITEgoogle.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations
google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob (LRO)
google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource (LRO)
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob (LRO)
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource (LRO)
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob (LRO)
google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob (LRO)

API interface audit logs

For information about how and which permissions are evaluated for each method,see the Identity and Access Management documentation for Apigee API Management.

google.cloud.apim.v1alpha.ApiDiscoveryObservation

The following audit logs are associated with methods belonging togoogle.cloud.apim.v1alpha.ApiDiscoveryObservation.

BatchEditTagsApiObservations

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations
  • Audit log type:Admin activity
  • Permissions:
    • apim.apiObservations.batchEditTags - ADMIN_WRITE
  • Method is a long-running or streaming operation:No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations"

CreateObservationJob

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob
  • Audit log type:Admin activity
  • Permissions:
    • apim.observationJobs.create - ADMIN_WRITE
  • Method is a long-running or streaming operation:Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob"

CreateObservationSource

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource
  • Audit log type:Admin activity
  • Permissions:
    • apim.observationSources.create - ADMIN_WRITE
  • Method is a long-running or streaming operation:Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource"

DeleteObservationJob

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob
  • Audit log type:Admin activity
  • Permissions:
    • apim.observationJobs.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation:Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob"

DeleteObservationSource

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource
  • Audit log type:Admin activity
  • Permissions:
    • apim.observationSources.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation:Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource"

DisableObservationJob

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob
  • Audit log type:Admin activity
  • Permissions:
    • apim.observationJobs.disable - ADMIN_WRITE
  • Method is a long-running or streaming operation:Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob"

EnableObservationJob

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob
  • Audit log type:Admin activity
  • Permissions:
    • apim.observationJobs.enable - ADMIN_WRITE
  • Method is a long-running or streaming operation:Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob"

GetObservationSource

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationSource
  • Audit log type:Data access
  • Permissions:
    • apim.observationSources.get - ADMIN_READ
  • Method is a long-running or streaming operation:No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationSource"

ListObservationJobs

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs
  • Audit log type:Data access
  • Permissions:
    • apim.observationJobs.list - ADMIN_READ
  • Method is a long-running or streaming operation:No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs"

ListObservationSources

  • Method:google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources
  • Audit log type:Data access
  • Permissions:
    • apim.observationSources.list - ADMIN_READ
  • Method is a long-running or streaming operation:No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources"

Methods that don't produce audit logs

A method might not produce audit logs for one or more of the followingreasons:

  • It is a high volume method involving significant log generation and storage costs.
  • It has low auditing value.
  • Another audit or platform log already provides method coverage.

The following methods don't produce audit logs:

  • google.cloud.location.Locations.GetLocation
  • google.cloud.location.Locations.ListLocations
  • google.longrunning.Operations.CancelOperation
  • google.longrunning.Operations.DeleteOperation
  • google.longrunning.Operations.GetOperation
  • google.longrunning.Operations.ListOperations
  • google.longrunning.Operations.WaitOperation

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.