API Gateway audit logging
This document describes audit logging for API Gateway. 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:
- Types of audit logs
- Audit log entry structure
- Storing and routing audit logs
- Cloud Logging pricing summary
- Enable Data Access audit logs
Service name
API Gateway audit logs use the service name apigateway.googleapis.com
.
Filter for this service:
protoPayload.serviceName="apigateway.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,
API Gateway 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.
Permission type | Methods |
---|---|
ADMIN_READ |
GetIamPolicy google.cloud.apigateway.v1.ApiGatewayService.GetApi google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig google.cloud.apigateway.v1.ApiGatewayService.GetGateway google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs google.cloud.apigateway.v1.ApiGatewayService.ListApis google.cloud.apigateway.v1.ApiGatewayService.ListGateways google.cloud.apigateway.v1beta.ApiGatewayService.GetApi google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway google.longrunning.Operations.GetOperation google.longrunning.Operations.ListOperations |
ADMIN_WRITE |
SetIamPolicy google.cloud.apigateway.v1.ApiGatewayService.CreateApi google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig google.cloud.apigateway.v1.ApiGatewayService.CreateGateway google.cloud.apigateway.v1.ApiGatewayService.DeleteApi google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway google.cloud.apigateway.v1.ApiGatewayService.UpdateApi google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway google.longrunning.Operations.CancelOperation google.longrunning.Operations.DeleteOperation |
API interface audit logs
For information about how and which permissions are evaluated for each method, see the Identity and Access Management documentation for API Gateway.
google.cloud.apigateway.v1.ApiGatewayService
The following audit logs are associated with methods belonging to
google.cloud.apigateway.v1.ApiGatewayService
.
CreateApi
- Method:
google.cloud.apigateway.v1.ApiGatewayService.CreateApi
- Audit log type: Admin activity
- Permissions:
apigateway.apis.create - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateApi"
CreateApiConfig
- Method:
google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig
- Audit log type: Admin activity
- Permissions:
apigateway.apiconfigs.create - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig"
CreateGateway
- Method:
google.cloud.apigateway.v1.ApiGatewayService.CreateGateway
- Audit log type: Admin activity
- Permissions:
apigateway.gateways.create - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateGateway"
DeleteApi
- Method:
google.cloud.apigateway.v1.ApiGatewayService.DeleteApi
- Audit log type: Admin activity
- Permissions:
apigateway.apis.delete - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteApi"
DeleteApiConfig
- Method:
google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig
- Audit log type: Admin activity
- Permissions:
apigateway.apiconfigs.delete - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig"
DeleteGateway
- Method:
google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway
- Audit log type: Admin activity
- Permissions:
apigateway.gateways.delete - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway"
GetApi
- Method:
google.cloud.apigateway.v1.ApiGatewayService.GetApi
- Audit log type: Data access
- Permissions:
apigateway.apis.get - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetApi"
GetApiConfig
- Method:
google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig
- Audit log type: Data access
- Permissions:
apigateway.apiconfigs.get - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig"
GetGateway
- Method:
google.cloud.apigateway.v1.ApiGatewayService.GetGateway
- Audit log type: Data access
- Permissions:
apigateway.gateways.get - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetGateway"
ListApiConfigs
- Method:
google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs
- Audit log type: Data access
- Permissions:
apigateway.apiconfigs.list - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs"
ListApis
- Method:
google.cloud.apigateway.v1.ApiGatewayService.ListApis
- Audit log type: Data access
- Permissions:
apigateway.apis.list - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListApis"
ListGateways
- Method:
google.cloud.apigateway.v1.ApiGatewayService.ListGateways
- Audit log type: Data access
- Permissions:
apigateway.gateways.list - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListGateways"
UpdateApi
- Method:
google.cloud.apigateway.v1.ApiGatewayService.UpdateApi
- Audit log type: Admin activity
- Permissions:
apigateway.apis.update - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateApi"
UpdateApiConfig
- Method:
google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig
- Audit log type: Admin activity
- Permissions:
apigateway.apiconfigs.update - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig"
UpdateGateway
- Method:
google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway
- Audit log type: Admin activity
- Permissions:
apigateway.gateways.update - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway"
google.cloud.apigateway.v1beta.ApiGatewayService
The following audit logs are associated with methods belonging to
google.cloud.apigateway.v1beta.ApiGatewayService
.
CreateApi
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi
- Audit log type: Admin activity
- Permissions:
apigateway.apis.create - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi"
CreateApiConfig
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig
- Audit log type: Admin activity
- Permissions:
apigateway.apiconfigs.create - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig"
CreateGateway
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway
- Audit log type: Admin activity
- Permissions:
apigateway.gateways.create - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway"
DeleteApi
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi
- Audit log type: Admin activity
- Permissions:
apigateway.apis.delete - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi"
DeleteApiConfig
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig
- Audit log type: Admin activity
- Permissions:
apigateway.apiconfigs.delete - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig"
DeleteGateway
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway
- Audit log type: Admin activity
- Permissions:
apigateway.gateways.delete - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway"
GetApi
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.GetApi
- Audit log type: Data access
- Permissions:
apigateway.apis.get - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetApi"
GetApiConfig
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig
- Audit log type: Data access
- Permissions:
apigateway.apiconfigs.get - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig"
GetGateway
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway
- Audit log type: Data access
- Permissions:
apigateway.gateways.get - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway"
UpdateApi
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi
- Audit log type: Admin activity
- Permissions:
apigateway.apis.update - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi"
UpdateApiConfig
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig
- Audit log type: Admin activity
- Permissions:
apigateway.apiconfigs.update - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig"
UpdateGateway
- Method:
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway
- Audit log type: Admin activity
- Permissions:
apigateway.gateways.update - ADMIN_WRITE
- Method is a long-running or streaming operation:
Long-running operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway"
google.iam.v1.IAMPolicy
The following audit logs are associated with methods belonging to
google.iam.v1.IAMPolicy
.
GetIamPolicy
- Method:
GetIamPolicy
- Audit log type: Data access
- Permissions:
apigateway.gateways.getIamPolicy - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="GetIamPolicy"
SetIamPolicy
- Method:
SetIamPolicy
- Audit log type: Admin activity
- Permissions:
apigateway.apiconfigs.setIamPolicy - ADMIN_WRITE
apigateway.apis.setIamPolicy - ADMIN_WRITE
apigateway.gateways.setIamPolicy - ADMIN_WRITE
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="SetIamPolicy"
google.longrunning.Operations
The following audit logs are associated with methods belonging to
google.longrunning.Operations
.
CancelOperation
- Method:
google.longrunning.Operations.CancelOperation
- Audit log type: Admin activity
- Permissions:
apigateway.operations.cancel - ADMIN_WRITE
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.longrunning.Operations.CancelOperation"
DeleteOperation
- Method:
google.longrunning.Operations.DeleteOperation
- Audit log type: Admin activity
- Permissions:
apigateway.operations.delete - ADMIN_WRITE
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.longrunning.Operations.DeleteOperation"
GetOperation
- Method:
google.longrunning.Operations.GetOperation
- Audit log type: Data access
- Permissions:
apigateway.operations.get - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.longrunning.Operations.GetOperation"
ListOperations
- Method:
google.longrunning.Operations.ListOperations
- Audit log type: Data access
- Permissions:
apigateway.operations.list - ADMIN_READ
- Method is a long-running or streaming operation:
No.
- Filter for this method:
protoPayload.methodName="google.longrunning.Operations.ListOperations"