Stay organized with collections
Save and categorize content based on your preferences.
This document describes audit logging for Apigee API Management. Google Cloud services
generate audit logs that record administrative and access activities within your Google Cloud resources.
For more information about Cloud Audit Logs, see the following:
Apigee API Management audit logs use the service name apim.googleapis.com.
Filter for this service:
protoPayload.serviceName="apim.googleapis.com"
Methods by permission type
Each IAM permission has a type property, whose value is an enum
that can be one of four values: ADMIN_READ, ADMIN_WRITE,
DATA_READ, or DATA_WRITE. When you call a method,
Apigee API Management generates an audit log whose category is dependent on the
type property of the permission required to perform the method.
Methods that require an IAM permission with the type property value
of DATA_READ, DATA_WRITE, or ADMIN_READ generate
Data Access audit logs.
Methods that require an IAM permission with the type property value
of ADMIN_WRITE generate
Admin Activity 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 to
google.cloud.apim.v1alpha.ApiDiscoveryObservation.
[[["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-26 UTC."],[[["\u003cp\u003eApigee API Management audit logs track administrative and data access activities within Google Cloud, using \u003ccode\u003eapim.googleapis.com\u003c/code\u003e as the service name.\u003c/p\u003e\n"],["\u003cp\u003eAudit logs are categorized as either Admin Activity or Data Access logs, based on the IAM permission type (\u003ccode\u003eADMIN_WRITE\u003c/code\u003e or \u003ccode\u003eDATA_READ\u003c/code\u003e, \u003ccode\u003eDATA_WRITE\u003c/code\u003e, \u003ccode\u003eADMIN_READ\u003c/code\u003e) required for each method.\u003c/p\u003e\n"],["\u003cp\u003eMethods requiring \u003ccode\u003eADMIN_WRITE\u003c/code\u003e permissions generate Admin Activity audit logs, whereas methods requiring \u003ccode\u003eDATA_READ\u003c/code\u003e, \u003ccode\u003eDATA_WRITE\u003c/code\u003e, or \u003ccode\u003eADMIN_READ\u003c/code\u003e generate Data Access logs.\u003c/p\u003e\n"],["\u003cp\u003eSpecific methods within \u003ccode\u003egoogle.cloud.apim.v1alpha.ApiDiscoveryObservation\u003c/code\u003e generate audit logs, including \u003ccode\u003eBatchEditTagsApiObservations\u003c/code\u003e, \u003ccode\u003eCreateObservationJob\u003c/code\u003e, \u003ccode\u003eGetObservationSource\u003c/code\u003e and more.\u003c/p\u003e\n"],["\u003cp\u003eSome methods, such as \u003ccode\u003egoogle.cloud.location.Locations.GetLocation\u003c/code\u003e and various \u003ccode\u003egoogle.longrunning.Operations\u003c/code\u003e methods, do not generate audit logs due to factors like high volume, low auditing value, or existing coverage by other logs.\u003c/p\u003e\n"]]],[],null,["# Apigee API Management audit logging\n\nThis document describes audit logging for Apigee API Management. Google Cloud services\ngenerate audit logs that record administrative and access activities within your Google Cloud resources.\nFor more information about Cloud Audit Logs, see the following:\n\n- [Types of audit logs](/logging/docs/audit#types)\n- [Audit log entry structure](/logging/docs/audit#audit_log_entry_structure)\n- [Storing and routing audit logs](/logging/docs/audit#storing_and_routing_audit_logs)\n- [Cloud Logging pricing summary](/stackdriver/pricing#logs-pricing-summary)\n- [Enable Data Access audit logs](/logging/docs/audit/configure-data-access)\n\n\u003cbr /\u003e\n\nService name\n------------\n\nApigee API Management audit logs use the service name `apim.googleapis.com`.\nFilter for this service: \n\n```gdscript\n protoPayload.serviceName=\"apim.googleapis.com\"\n \n```\n\n\u003cbr /\u003e\n\nMethods by permission type\n--------------------------\n\nEach IAM permission has a `type` property, whose value is an enum\nthat can be one of four values: `ADMIN_READ`, `ADMIN_WRITE`,\n`DATA_READ`, or `DATA_WRITE`. When you call a method,\nApigee API Management generates an audit log whose category is dependent on the\n`type` property of the permission required to perform the method.\n\nMethods that require an IAM permission with the `type` property value\nof `DATA_READ`, `DATA_WRITE`, or `ADMIN_READ` generate\n[Data Access](/logging/docs/audit#data-access) audit logs.\n\nMethods that require an IAM permission with the `type` property value\nof `ADMIN_WRITE` generate\n[Admin Activity](/logging/docs/audit#admin-activity) audit logs.\n\nAPI interface audit logs\n------------------------\n\nFor information about how and which permissions are evaluated for each method,\nsee the Identity and Access Management documentation for Apigee API Management.\n\n### `google.cloud.apim.v1alpha.ApiDiscoveryObservation`\n\nThe following audit logs are associated with methods belonging to\n`google.cloud.apim.v1alpha.ApiDiscoveryObservation`.\n\n#### `BatchEditTagsApiObservations`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations` \n- **Audit log type** : [Admin activity](/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `apim.apiObservations.batchEditTags - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations\"\n ` \n\n#### `CreateObservationJob`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob` \n- **Audit log type** : [Admin activity](/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `apim.observationJobs.create - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : [**Long-running operation**](/logging/docs/audit/understanding-audit-logs#lro) \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob\"\n ` \n\n#### `CreateObservationSource`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource` \n- **Audit log type** : [Admin activity](/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `apim.observationSources.create - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource\"\n ` \n\n#### `DeleteObservationJob`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob` \n- **Audit log type** : [Admin activity](/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `apim.observationJobs.delete - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : [**Long-running operation**](/logging/docs/audit/understanding-audit-logs#lro) \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob\"\n ` \n\n#### `DeleteObservationSource`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource` \n- **Audit log type** : [Admin activity](/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `apim.observationSources.delete - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : [**Long-running operation**](/logging/docs/audit/understanding-audit-logs#lro) \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource\"\n ` \n\n#### `DisableObservationJob`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob` \n- **Audit log type** : [Admin activity](/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `apim.observationJobs.disable - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : [**Long-running operation**](/logging/docs/audit/understanding-audit-logs#lro) \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob\"\n ` \n\n#### `EnableObservationJob`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob` \n- **Audit log type** : [Admin activity](/logging/docs/audit#admin-activity) \n- **Permissions** :\n - `apim.observationJobs.enable - ADMIN_WRITE`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob\"\n ` \n\n#### `GetObservationSource`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationSource` \n- **Audit log type** : [Data access](/logging/docs/audit#data-access) \n- **Permissions** :\n - `apim.observationSources.get - ADMIN_READ`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationSource\"\n ` \n\n#### `ListObservationJobs`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs` \n- **Audit log type** : [Data access](/logging/docs/audit#data-access) \n- **Permissions** :\n - `apim.observationJobs.list - ADMIN_READ`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs\"\n ` \n\n#### `ListObservationSources`\n\n- **Method** : `google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources` \n- **Audit log type** : [Data access](/logging/docs/audit#data-access) \n- **Permissions** :\n - `apim.observationSources.list - ADMIN_READ`\n- **Method is a long-running or streaming operation** : No. \n- **Filter for this method** : `\n protoPayload.methodName=\"google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources\"\n ` \n\nMethods that don't produce audit logs\n-------------------------------------\n\nA method might not produce audit logs for one or more of the following\nreasons:\n\n- It is a high volume method involving significant log generation and storage costs.\n- It has low auditing value.\n- Another audit or platform log already provides method coverage.\n\n\u003cbr /\u003e\n\nThe following methods don't produce audit logs:\n\n- `google.cloud.location.Locations.GetLocation`\n- `google.cloud.location.Locations.ListLocations`\n- `google.longrunning.Operations.CancelOperation`\n- `google.longrunning.Operations.DeleteOperation`\n- `google.longrunning.Operations.GetOperation`\n- `google.longrunning.Operations.ListOperations`\n- `google.longrunning.Operations.WaitOperation`"]]
