API gateway

edgeapi-gateway

Managed entry point that routes, authenticates and throttles inbound calls.

Category: Edge
Properties: 9
Components: 41
Rules: 1

Properties · 9 defined by this kind

A node of this kind resolves each property from its own props, then the component's defaults, then the default below.

property	type	values	required	default
auth	enum	none \| api-key \| jwt \| oauth2 \| mtls	no	none
concurrencyLimit	boolean	—	no	false
idempotencyKeys · advanced	boolean	—	no	false
instances	integer	—	no	—
keyTtlHours · advanced	integer	—	no	—
managed	boolean	—	no	false
protocol	enum	http \| grpc \| websocket \| fix \| ouch	no	http
rateLimiting	boolean	—	no	false
tls	boolean	—	no	true

Rules for this kind · 1

Synchronous call chain too deepwarning

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

Components · 41

vendor-neutral

Generic API gatewayapi-gatewaygenericthe kind itself

alibabacloud

API Gatewayalibaba-api-gateway4 defaults

aws

Amazon API Gatewayaws-api-gateway3 defaults AWS AppSync GraphQL APIaws-appsync5 defaults

azure

Azure API Managementazure-api-management3 defaults

cloudflare

AI Gatewaycloudflare-ai-gateway5 defaults Cloudflare API Shieldcloudflare-api-shield4 defaults MCP Server Portalcloudflare-mcp-portal5 defaults Cloudflare Privacy Gatewaycloudflare-privacy-gateway3 defaults

gcp

Apigeeapigee3 defaults Agent Gatewaygoogle-agent-gateway4 defaults API Gatewaygoogle-api-gateway3 defaults Apigee hybridgoogle-apigee-hybrid3 defaults Cloud Endpointsgoogle-cloud-endpoints2 defaults Firebase Data Connectgoogle-firebase-data-connect4 defaults

ibm

IBM API Connectibm-api-connect3 defaults

oci

OCI API Gatewayoci-api-gateway4 defaults

Source

1# yaml-language-server: $schema=../schema/kind.schema.json
2# Abstract kind: Managed entry point that routes, authenticates and throttles inbound calls.
3schemaVersion: "1"
4type: "kind"
5id: "api-gateway"
6category: "edge"
7properties:
8  auth:
9    type: "enum"
10    values: ["none", "api-key", "jwt", "oauth2", "mtls"]
11    default: "none"
12  rateLimiting:
13    type: "boolean"
14    default: false
15  tls:
16    type: "boolean"
17    default: true
18  idempotencyKeys:
19    type: "boolean"
20    default: false
21    advanced: true
22  keyTtlHours:
23    type: "integer"
24    advanced: true
25  protocol:
26    type: "enum"
27    values: ["http", "grpc", "websocket", "fix", "ouch"]
28    default: "http"
29  concurrencyLimit:
30    type: "boolean"
31    default: false
32  instances:
33    type: "integer"
34  managed:
35    type: "boolean"
36    default: false

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