API Gateway

gcpAPI gatewaygoogle-api-gateway

Regional managed gateway fronting Cloud Run, functions and App Engine backends.

Provider
gcp
Category
Edge
Properties · 3 set by this component
propertytypevaluesrequiredkind defaultthis component
apiKeys · component propertyboolean—notrueinherited
authenumnone | api-key | jwt | oauth2 | mtlsnononeinherited
concurrencyLimitboolean—nofalseinherited
configFormat · component propertyenumopenapi | grpcnoopenapiinherited
idempotencyKeys · advancedboolean—nofalseinherited
instancesinteger—no—inherited
keyTtlHours · advancedinteger—no—inherited
managedboolean—nofalse▸ true
protocolenumhttp | grpc | websocket | fix | ouchnohttpinherited
rateLimitingboolean—nofalse▸ false
regional · component propertyboolean—notrueinherited
tlsboolean—notrue▸ true
Rules that apply · 1

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

sync-chain-too-deep

Every consecutive synchronous hop from this entry point spends part of the stated p95 latency budget, and the chain's failures multiply. More than three hops is a budget nobody is tracking.

  • — all of these hold:
  • — the design requirement `latency.p95Ms` has a value
  • — the longest chain of synchronous calls starting at the node is more than 3 hops long
Use it in a design
nodes:
  - { id: "api-gateway", component: "google-api-gateway" }
Other API gateway products · 40
API Gatewayalibaba-api-gatewayalibabacloudapi-gatewayAmazon API Gatewayaws-api-gatewayawsapi-gatewayAWS AppSync GraphQL APIaws-appsyncawsapi-gatewayAzure API Managementazure-api-managementazureapi-gatewayAI Gatewaycloudflare-ai-gatewaycloudflareapi-gatewayCloudflare API Shieldcloudflare-api-shieldcloudflareapi-gatewayMCP Server Portalcloudflare-mcp-portalcloudflareapi-gatewayCloudflare Privacy Gatewaycloudflare-privacy-gatewaycloudflareapi-gatewayGeneric API gatewayapi-gatewayapi-gatewayApache APISIXapisixapi-gatewayApollo GraphOSapollo-graphosapi-gatewayEasegresseasegressapi-gatewayEmissary-ingressemissaryapi-gatewayEnvoy Gatewayenvoy-gatewayapi-gatewayGloo Gatewayglooapi-gatewayHasurahasuraapi-gatewayHelicone AI Gatewayhelicone-gatewayapi-gatewayHigresshigressapi-gatewayKong Gatewaykongapi-gatewayKong AI Gatewaykong-ai-gatewayapi-gatewayKong Konnectkong-konnectapi-gatewayKrakenDkrakendapi-gatewayLiteLLM Proxylitellmapi-gatewayMartian Gatewaymartianapi-gatewayNot Diamondnot-diamondapi-gatewayPortkey AI Gatewayportkeyapi-gatewayRequestyrequestyapi-gatewaySpring Cloud Gatewayspring-cloud-gatewayapi-gatewayTyk Gatewaytykapi-gatewayUnifyunify-aiapi-gatewayVercel AI Gatewayvercel-ai-gatewayapi-gatewayWSO2 API Managerwso2-api-managerapi-gatewayZuulzuulapi-gatewayApigeeapigeegcpapi-gatewayAgent Gatewaygoogle-agent-gatewaygcpapi-gatewayApigee hybridgoogle-apigee-hybridgcpapi-gatewayCloud Endpointsgoogle-cloud-endpointsgcpapi-gatewayFirebase Data Connectgoogle-firebase-data-connectgcpapi-gatewayIBM API Connectibm-api-connectibmapi-gatewayOCI API Gatewayoci-api-gatewayociapi-gateway
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# Google Cloud API Gateway: managed gateway in front of Cloud Run, Cloud Run functions, App Engine and
# other backends. Per "About API Gateway" an API config is an OpenAPI or gRPC description, API keys and
# Google ID tokens are the supported authentication mechanisms, and per the quickstart a gateway is
# deployed to a region and served on a Google-managed hostname.
schemaVersion: "1"
type: "component"
id: "google-api-gateway"
kind: "api-gateway"
provider: "gcp"
docs: "https://cloud.google.com/api-gateway/docs/about-api-gateway"
defaults:
  managed: true
  tls: true
  rateLimiting: false
properties:
  regional:
    type: "boolean"
    default: true
  apiKeys:
    type: "boolean"
    default: true
  configFormat:
    type: "enum"
    values: ["openapi", "grpc"]
    default: "openapi"

The same page as markdown, for an agent: /catalogue/components/google-api-gateway.md