API Gateway audit logging
This document describes audit logging for API Gateway. Google Cloud services write audit logs that record administrative activities and accesses within your Google Cloud resources. For an overview of audit logs with information about the different types of audit logs, see Cloud Audit Logs overview.
This page was last generated on 2024-05-09 14:44:52 UTC.
Service name
API Gateway audit logs use the service name apigateway.googleapis.com
.
Methods by permission type
Methods that check DATA_READ
, DATA_WRITE
, and ADMIN_READ
permission types are Data Access audit logs.
Methods that check ADMIN_WRITE
permission types are 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 |
Audit logs per API interface
For information about which permissions are evaluated and how for each method, see the Identity and Access Management documentation for API Gateway.
google.cloud.apigateway.v1.ApiGatewayService
Details about audit logs associated with methods belonging to google.cloud.apigateway.v1.ApiGatewayService
.
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 Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateApi"
google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig
- Method: google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig
- Audit log Type: Admin Activity
- Permissions:
apigateway.apiconfigs.create - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateApiConfig"
google.cloud.apigateway.v1.ApiGatewayService.CreateGateway
- Method: google.cloud.apigateway.v1.ApiGatewayService.CreateGateway
- Audit log Type: Admin Activity
- Permissions:
apigateway.gateways.create - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.CreateGateway"
google.cloud.apigateway.v1.ApiGatewayService.DeleteApi
- Method: google.cloud.apigateway.v1.ApiGatewayService.DeleteApi
- Audit log Type: Admin Activity
- Permissions:
apigateway.apis.delete - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteApi"
google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig
- Method: google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig
- Audit log Type: Admin Activity
- Permissions:
apigateway.apiconfigs.delete - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteApiConfig"
google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway
- Method: google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway
- Audit log Type: Admin Activity
- Permissions:
apigateway.gateways.delete - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.DeleteGateway"
google.cloud.apigateway.v1.ApiGatewayService.GetApi
- Method: google.cloud.apigateway.v1.ApiGatewayService.GetApi
- Audit log Type: Data Access
- Permissions:
apigateway.apis.get - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetApi"
google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig
- Method: google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig
- Audit log Type: Data Access
- Permissions:
apigateway.apiconfigs.get - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetApiConfig"
google.cloud.apigateway.v1.ApiGatewayService.GetGateway
- Method: google.cloud.apigateway.v1.ApiGatewayService.GetGateway
- Audit log Type: Data Access
- Permissions:
apigateway.gateways.get - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.GetGateway"
google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs
- Method: google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs
- Audit log Type: Data Access
- Permissions:
apigateway.apiconfigs.list - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListApiConfigs"
google.cloud.apigateway.v1.ApiGatewayService.ListApis
- Method: google.cloud.apigateway.v1.ApiGatewayService.ListApis
- Audit log Type: Data Access
- Permissions:
apigateway.apis.list - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListApis"
google.cloud.apigateway.v1.ApiGatewayService.ListGateways
- Method: google.cloud.apigateway.v1.ApiGatewayService.ListGateways
- Audit log Type: Data Access
- Permissions:
apigateway.gateways.list - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.ListGateways"
google.cloud.apigateway.v1.ApiGatewayService.UpdateApi
- Method: google.cloud.apigateway.v1.ApiGatewayService.UpdateApi
- Audit log Type: Admin Activity
- Permissions:
apigateway.apis.update - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateApi"
google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig
- Method: google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig
- Audit log Type: Admin Activity
- Permissions:
apigateway.apiconfigs.update - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateApiConfig"
google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway
- Method: google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway
- Audit log Type: Admin Activity
- Permissions:
apigateway.gateways.update - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1.ApiGatewayService.UpdateGateway"
google.cloud.apigateway.v1beta.ApiGatewayService
Details about audit logs associated with methods belonging to google.cloud.apigateway.v1beta.ApiGatewayService
.
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 Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateApi"
google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig
- Audit log Type: Admin Activity
- Permissions:
apigateway.apiconfigs.create - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateApiConfig"
google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway
- Audit log Type: Admin Activity
- Permissions:
apigateway.gateways.create - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.CreateGateway"
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi
- Audit log Type: Admin Activity
- Permissions:
apigateway.apis.delete - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApi"
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig
- Audit log Type: Admin Activity
- Permissions:
apigateway.apiconfigs.delete - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteApiConfig"
google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway
- Audit log Type: Admin Activity
- Permissions:
apigateway.gateways.delete - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.DeleteGateway"
google.cloud.apigateway.v1beta.ApiGatewayService.GetApi
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.GetApi
- Audit log Type: Data Access
- Permissions:
apigateway.apis.get - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetApi"
google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig
- Audit log Type: Data Access
- Permissions:
apigateway.apiconfigs.get - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetApiConfig"
google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway
- Audit log Type: Data Access
- Permissions:
apigateway.gateways.get - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.GetGateway"
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi
- Audit log Type: Admin Activity
- Permissions:
apigateway.apis.update - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApi"
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig
- Audit log Type: Admin Activity
- Permissions:
apigateway.apiconfigs.update - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateApiConfig"
google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway
- Method: google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway
- Audit log Type: Admin Activity
- Permissions:
apigateway.gateways.update - ADMIN_WRITE
- Method is a Long Running Operation or Streaming:
Long Running Operation
- Filter for this method:
protoPayload.methodName="google.cloud.apigateway.v1beta.ApiGatewayService.UpdateGateway"
google.iam.v1.IAMPolicy
Details about audit logs associated with methods belonging to google.iam.v1.IAMPolicy
.
GetIamPolicy
- Method: GetIamPolicy
- Audit log Type: Data Access
- Permissions:
apigateway.apiconfigs.getIamPolicy - ADMIN_READ
apigateway.apis.getIamPolicy - ADMIN_READ
apigateway.gateways.getIamPolicy - ADMIN_READ
- Method is a Long Running Operation or Streaming: 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 Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="SetIamPolicy"
google.longrunning.Operations
Details about audit logs associated with methods belonging to google.longrunning.Operations
.
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 Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.longrunning.Operations.CancelOperation"
google.longrunning.Operations.DeleteOperation
- Method: google.longrunning.Operations.DeleteOperation
- Audit log Type: Admin Activity
- Permissions:
apigateway.operations.delete - ADMIN_WRITE
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.longrunning.Operations.DeleteOperation"
google.longrunning.Operations.GetOperation
- Method: google.longrunning.Operations.GetOperation
- Audit log Type: Data Access
- Permissions:
apigateway.operations.get - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.longrunning.Operations.GetOperation"
google.longrunning.Operations.ListOperations
- Method: google.longrunning.Operations.ListOperations
- Audit log Type: Data Access
- Permissions:
apigateway.operations.list - ADMIN_READ
- Method is a Long Running Operation or Streaming: No.
- Filter for this method:
protoPayload.methodName="google.longrunning.Operations.ListOperations"