zuplo 7.12.6 → 7.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (580) hide show
  1. package/docs/ai-gateway/apps.mdx +3 -0
  2. package/docs/ai-gateway/azure-ai.mdx +3 -0
  3. package/docs/ai-gateway/bedrock-mantle.mdx +3 -0
  4. package/docs/ai-gateway/bedrock-runtime.mdx +3 -0
  5. package/docs/ai-gateway/budget-alerts.mdx +3 -0
  6. package/docs/ai-gateway/cookbooks/custom-fallback.mdx +3 -0
  7. package/docs/ai-gateway/cookbooks/dynamic-model-routing.mdx +3 -0
  8. package/docs/ai-gateway/cookbooks/sdk-path-shim.mdx +3 -0
  9. package/docs/ai-gateway/custom-policies.mdx +3 -0
  10. package/docs/ai-gateway/custom-pricing.mdx +3 -0
  11. package/docs/ai-gateway/custom-providers.mdx +3 -0
  12. package/docs/ai-gateway/fallback.mdx +3 -0
  13. package/docs/ai-gateway/integrations/ai-sdk.mdx +3 -0
  14. package/docs/ai-gateway/integrations/claude-code.mdx +3 -0
  15. package/docs/ai-gateway/integrations/claude-desktop.mdx +3 -0
  16. package/docs/ai-gateway/integrations/codex.mdx +3 -0
  17. package/docs/ai-gateway/integrations/github-copilot.mdx +3 -0
  18. package/docs/ai-gateway/integrations/goose.mdx +3 -0
  19. package/docs/ai-gateway/integrations/langchain.mdx +3 -0
  20. package/docs/ai-gateway/integrations/openai.mdx +3 -0
  21. package/docs/ai-gateway/jev.mdx +3 -0
  22. package/docs/ai-gateway/managing-apps.mdx +3 -0
  23. package/docs/ai-gateway/managing-pools.mdx +3 -0
  24. package/docs/ai-gateway/managing-providers.mdx +3 -0
  25. package/docs/ai-gateway/openrouter.mdx +3 -0
  26. package/docs/ai-gateway/overview.mdx +3 -0
  27. package/docs/ai-gateway/policies/overview.mdx +3 -0
  28. package/docs/ai-gateway/policy-chains.mdx +3 -0
  29. package/docs/ai-gateway/policy-templates.mdx +3 -0
  30. package/docs/ai-gateway/pools.mdx +3 -0
  31. package/docs/ai-gateway/providers.mdx +3 -0
  32. package/docs/ai-gateway/source-control.mdx +3 -0
  33. package/docs/ai-gateway/universal-api.mdx +3 -0
  34. package/docs/ai-gateway/usage-limits.mdx +3 -0
  35. package/docs/ai-gateway/user-apps.mdx +3 -0
  36. package/docs/ai-gateway/vertex-ai.mdx +3 -0
  37. package/docs/analytics/access-and-entitlements.md +3 -0
  38. package/docs/analytics/overview.md +9 -0
  39. package/docs/analytics/reference/metrics-glossary.md +3 -0
  40. package/docs/analytics/reference/url-parameters.md +3 -0
  41. package/docs/analytics/shared-controls.md +3 -0
  42. package/docs/analytics/tabs/agents.md +3 -0
  43. package/docs/analytics/tabs/consumers.md +3 -0
  44. package/docs/analytics/tabs/graphql.md +3 -0
  45. package/docs/analytics/tabs/mcp.md +3 -0
  46. package/docs/analytics/tabs/origins.md +3 -0
  47. package/docs/analytics/tabs/requests.md +12 -0
  48. package/docs/api-management/overview.md +12 -0
  49. package/docs/articles/accounts/audit-logs.mdx +3 -0
  50. package/docs/articles/accounts/billing.mdx +3 -0
  51. package/docs/articles/accounts/default-api-key.mdx +3 -0
  52. package/docs/articles/accounts/delete-account.mdx +3 -0
  53. package/docs/articles/accounts/enterprise-sso.mdx +3 -0
  54. package/docs/articles/accounts/managing-account-members.mdx +3 -0
  55. package/docs/articles/accounts/managing-project-members.mdx +3 -0
  56. package/docs/articles/accounts/members-and-roles.mdx +3 -0
  57. package/docs/articles/accounts/renew-sso-credentials.mdx +3 -0
  58. package/docs/articles/accounts/roles-and-permissions.mdx +3 -0
  59. package/docs/articles/accounts/switching-between-accounts.mdx +3 -0
  60. package/docs/articles/accounts/zuplo-api-keys.mdx +3 -0
  61. package/docs/articles/add-api-to-backstage.mdx +3 -0
  62. package/docs/articles/advanced-path-matching.mdx +3 -0
  63. package/docs/articles/api-key-administration.mdx +3 -0
  64. package/docs/articles/api-key-api.mdx +3 -0
  65. package/docs/articles/api-key-authentication.mdx +3 -0
  66. package/docs/articles/api-key-best-practices.mdx +3 -0
  67. package/docs/articles/api-key-buckets.mdx +3 -0
  68. package/docs/articles/api-key-consumer-bucket-portal-ui.mdx +3 -0
  69. package/docs/articles/api-key-end-users.mdx +3 -0
  70. package/docs/articles/api-key-leak-detection.mdx +3 -0
  71. package/docs/articles/api-key-management.mdx +3 -0
  72. package/docs/articles/api-key-metadata.mdx +3 -0
  73. package/docs/articles/api-key-react-component.mdx +3 -0
  74. package/docs/articles/api-key-self-serve-integration.mdx +3 -0
  75. package/docs/articles/api-key-service-limits.mdx +3 -0
  76. package/docs/articles/archiving-requests-to-storage.mdx +11 -0
  77. package/docs/articles/audit-logging.mdx +3 -0
  78. package/docs/articles/audit-logs.mdx +3 -0
  79. package/docs/articles/branch-based-deployments.mdx +13 -0
  80. package/docs/articles/bypass-policy-for-testing.mdx +3 -0
  81. package/docs/articles/certificate-pinning.mdx +12 -0
  82. package/docs/articles/check-ip-address.mdx +17 -9
  83. package/docs/articles/ci-cd-azure/basic-deployment.mdx +8 -0
  84. package/docs/articles/ci-cd-azure/deploy-and-test.mdx +8 -0
  85. package/docs/articles/ci-cd-azure/local-testing.mdx +8 -0
  86. package/docs/articles/ci-cd-azure/multi-stage-deployment.mdx +8 -0
  87. package/docs/articles/ci-cd-azure/pr-preview-environments.mdx +8 -0
  88. package/docs/articles/ci-cd-azure/tag-based-releases.mdx +8 -0
  89. package/docs/articles/ci-cd-bitbucket/basic-deployment.mdx +8 -0
  90. package/docs/articles/ci-cd-bitbucket/deploy-and-test.mdx +8 -0
  91. package/docs/articles/ci-cd-bitbucket/local-testing.mdx +8 -0
  92. package/docs/articles/ci-cd-bitbucket/multi-stage-deployment.mdx +8 -0
  93. package/docs/articles/ci-cd-bitbucket/pr-preview-environments.mdx +8 -0
  94. package/docs/articles/ci-cd-bitbucket/tag-based-releases.mdx +8 -0
  95. package/docs/articles/ci-cd-circleci/basic-deployment.mdx +8 -0
  96. package/docs/articles/ci-cd-circleci/deploy-and-test.mdx +8 -0
  97. package/docs/articles/ci-cd-circleci/local-testing.mdx +8 -0
  98. package/docs/articles/ci-cd-circleci/multi-stage-deployment.mdx +8 -0
  99. package/docs/articles/ci-cd-circleci/pr-preview-environments.mdx +8 -0
  100. package/docs/articles/ci-cd-circleci/tag-based-releases.mdx +8 -0
  101. package/docs/articles/ci-cd-github/basic-deployment.mdx +8 -0
  102. package/docs/articles/ci-cd-github/cleanup-on-branch-delete.mdx +8 -0
  103. package/docs/articles/ci-cd-github/deploy-and-test.mdx +8 -0
  104. package/docs/articles/ci-cd-github/local-testing.mdx +8 -0
  105. package/docs/articles/ci-cd-github/multi-stage-deployment.mdx +8 -0
  106. package/docs/articles/ci-cd-github/pr-preview-environments.mdx +8 -0
  107. package/docs/articles/ci-cd-github/tag-based-releases.mdx +8 -0
  108. package/docs/articles/ci-cd-gitlab/basic-deployment.mdx +8 -0
  109. package/docs/articles/ci-cd-gitlab/deploy-and-test.mdx +8 -0
  110. package/docs/articles/ci-cd-gitlab/local-testing.mdx +8 -0
  111. package/docs/articles/ci-cd-gitlab/mr-preview-environments.mdx +8 -0
  112. package/docs/articles/ci-cd-gitlab/multi-stage-deployment.mdx +8 -0
  113. package/docs/articles/ci-cd-gitlab/tag-based-releases.mdx +8 -0
  114. package/docs/articles/composite-policy-reference.mdx +3 -0
  115. package/docs/articles/configuring-auth0-for-mcp-auth.mdx +3 -0
  116. package/docs/articles/configuring-okta-for-mcp-auth.mdx +3 -0
  117. package/docs/articles/connect-to-aws-alb-with-mtls.mdx +10 -0
  118. package/docs/articles/convert-urls-to-openapi.mdx +3 -0
  119. package/docs/articles/cors.mdx +3 -0
  120. package/docs/articles/custom-audit-logs.mdx +3 -0
  121. package/docs/articles/custom-ci-cd-azure.mdx +8 -0
  122. package/docs/articles/custom-ci-cd-bitbucket.mdx +8 -0
  123. package/docs/articles/custom-ci-cd-circleci.mdx +8 -0
  124. package/docs/articles/custom-ci-cd-github.mdx +8 -0
  125. package/docs/articles/custom-ci-cd-gitlab.mdx +8 -0
  126. package/docs/articles/custom-ci-cd.mdx +8 -0
  127. package/docs/articles/custom-code-patterns.md +3 -0
  128. package/docs/articles/custom-domains.mdx +22 -3
  129. package/docs/articles/custom-logging-example.mdx +3 -0
  130. package/docs/articles/ddos-protection.mdx +3 -0
  131. package/docs/articles/development-options.mdx +7 -0
  132. package/docs/articles/environment-variables.mdx +8 -0
  133. package/docs/articles/environments.mdx +18 -8
  134. package/docs/articles/fastly-zuplo-host-setup.mdx +3 -0
  135. package/docs/articles/feature-flags.mdx +3 -0
  136. package/docs/articles/github-deployment-testing.mdx +3 -0
  137. package/docs/articles/gke-with-upstream-auth-policy.mdx +3 -0
  138. package/docs/articles/graphql-caching.mdx +3 -0
  139. package/docs/articles/graphql-security.mdx +3 -0
  140. package/docs/articles/graphql-support.mdx +3 -0
  141. package/docs/articles/graphql.mdx +3 -0
  142. package/docs/articles/handling-form-data.mdx +3 -0
  143. package/docs/articles/health-checks.mdx +3 -0
  144. package/docs/articles/hosting-options.mdx +3 -0
  145. package/docs/articles/lazy-load-configuration-into-cache.mdx +3 -0
  146. package/docs/articles/limits.mdx +7 -0
  147. package/docs/articles/local-development-debugging.mdx +3 -0
  148. package/docs/articles/local-development-env-variables.mdx +3 -0
  149. package/docs/articles/local-development-installing-packages.mdx +3 -0
  150. package/docs/articles/local-development-routes-designer.mdx +3 -0
  151. package/docs/articles/local-development-services.mdx +3 -0
  152. package/docs/articles/local-development-troubleshooting.mdx +7 -0
  153. package/docs/articles/local-development.mdx +3 -0
  154. package/docs/articles/log-plugin-aws-cloudwatch.mdx +14 -0
  155. package/docs/articles/log-plugin-datadog.mdx +3 -0
  156. package/docs/articles/log-plugin-dynatrace.mdx +14 -0
  157. package/docs/articles/log-plugin-gcp.mdx +14 -0
  158. package/docs/articles/log-plugin-loki.mdx +14 -0
  159. package/docs/articles/log-plugin-new-relic.mdx +3 -0
  160. package/docs/articles/log-plugin-splunk.mdx +3 -0
  161. package/docs/articles/log-plugin-sumo.mdx +14 -0
  162. package/docs/articles/log-plugin-vmware-log-insight.mdx +3 -0
  163. package/docs/articles/log-request-response-data.mdx +3 -0
  164. package/docs/articles/logging.mdx +14 -0
  165. package/docs/articles/manual-mcp-oauth-testing.mdx +3 -0
  166. package/docs/articles/metrics-plugins.mdx +10 -0
  167. package/docs/articles/migrate-from-apigee.md +10 -0
  168. package/docs/articles/migrate-from-aws-api-gateway.md +3 -0
  169. package/docs/articles/migrate-from-azure-apim.md +10 -0
  170. package/docs/articles/migrate-from-kong.md +10 -0
  171. package/docs/articles/migration-overview.md +10 -0
  172. package/docs/articles/monetization/api-access.mdx +3 -0
  173. package/docs/articles/monetization/billing-models.md +3 -0
  174. package/docs/articles/monetization/developer-portal.md +8 -0
  175. package/docs/articles/monetization/dynamic-metering.md +3 -0
  176. package/docs/articles/monetization/features.mdx +3 -0
  177. package/docs/articles/monetization/going-to-production.mdx +3 -0
  178. package/docs/articles/monetization/index.mdx +3 -0
  179. package/docs/articles/monetization/meters.mdx +3 -0
  180. package/docs/articles/monetization/monetization-policy.md +3 -0
  181. package/docs/articles/monetization/plan-examples.mdx +3 -0
  182. package/docs/articles/monetization/plans.mdx +3 -0
  183. package/docs/articles/monetization/pricing-models.mdx +3 -0
  184. package/docs/articles/monetization/private-plans.md +3 -0
  185. package/docs/articles/monetization/programmatic-monetization.md +3 -0
  186. package/docs/articles/monetization/quickstart.md +8 -0
  187. package/docs/articles/monetization/rate-cards.mdx +3 -0
  188. package/docs/articles/monetization/stripe-integration.md +19 -6
  189. package/docs/articles/monetization/subscription-data.md +3 -0
  190. package/docs/articles/monetization/subscription-lifecycle.md +3 -0
  191. package/docs/articles/monetization/tax-collection.md +3 -0
  192. package/docs/articles/monetization/troubleshooting.md +3 -0
  193. package/docs/articles/monetization-custom.mdx +3 -0
  194. package/docs/articles/monetization-integrations.mdx +3 -0
  195. package/docs/articles/monitoring-your-gateway.mdx +3 -0
  196. package/docs/articles/monorepo-deployment.mdx +3 -0
  197. package/docs/articles/multiple-auth-policies.mdx +3 -0
  198. package/docs/articles/non-standard-ports.mdx +3 -0
  199. package/docs/articles/oauth-authentication.mdx +3 -0
  200. package/docs/articles/openapi-server-urls.mdx +12 -0
  201. package/docs/articles/openapi-string-format-validation-warnings.mdx +3 -0
  202. package/docs/articles/openapi.mdx +3 -0
  203. package/docs/articles/opentelemetry.mdx +3 -0
  204. package/docs/articles/performance-testing.mdx +9 -0
  205. package/docs/articles/plugin-akamai-api-security.mdx +3 -0
  206. package/docs/articles/plugin-azure-blob.mdx +3 -0
  207. package/docs/articles/plugin-azure-event-hubs.mdx +3 -0
  208. package/docs/articles/plugin-hydrolix-traffic-peak.mdx +12 -0
  209. package/docs/articles/policies.mdx +3 -0
  210. package/docs/articles/rename-or-move-project.mdx +3 -0
  211. package/docs/articles/rick-and-morty-api-developer-portal-example.mdx +3 -0
  212. package/docs/articles/routing.mdx +3 -0
  213. package/docs/articles/s3-signed-url-uploads.mdx +8 -0
  214. package/docs/articles/secure-tunnel.mdx +16 -5
  215. package/docs/articles/securing-backend-mtls.mdx +9 -0
  216. package/docs/articles/securing-the-gateway-with-client-mtls.mdx +3 -0
  217. package/docs/articles/securing-your-backend.mdx +7 -0
  218. package/docs/articles/security.mdx +11 -0
  219. package/docs/articles/sharing-code-across-projects.mdx +3 -0
  220. package/docs/articles/source-control-setup-azure.mdx +3 -0
  221. package/docs/articles/source-control-setup-bitbucket.mdx +3 -0
  222. package/docs/articles/source-control-setup-github.mdx +26 -2
  223. package/docs/articles/source-control-setup-gitlab.mdx +3 -0
  224. package/docs/articles/source-control.mdx +12 -0
  225. package/docs/articles/streaming-responses-sse.mdx +3 -0
  226. package/docs/articles/support.mdx +3 -0
  227. package/docs/articles/terraform.mdx +3 -0
  228. package/docs/articles/testing-getting-started.mdx +3 -0
  229. package/docs/articles/testing-graphql.mdx +3 -0
  230. package/docs/articles/testing-preview-environments.mdx +3 -0
  231. package/docs/articles/testing-recipes.mdx +3 -0
  232. package/docs/articles/testing.mdx +3 -0
  233. package/docs/articles/troubleshooting-deployments-and-git-sync.mdx +9 -4
  234. package/docs/articles/troubleshooting-slow-responses.mdx +10 -0
  235. package/docs/articles/troubleshooting.md +14 -0
  236. package/docs/articles/tsconfig.mdx +3 -0
  237. package/docs/articles/tunnel-advanced.mdx +48 -104
  238. package/docs/articles/tunnel-services.mdx +14 -2
  239. package/docs/articles/tunnel-setup.mdx +12 -0
  240. package/docs/articles/tunnel-troubleshooting.mdx +12 -0
  241. package/docs/articles/update-zup-in-github-action.mdx +3 -0
  242. package/docs/articles/upstream-iam-auth.mdx +3 -0
  243. package/docs/articles/use-openapi-extension-data.mdx +3 -0
  244. package/docs/articles/users/multifactor-authentication.mdx +3 -0
  245. package/docs/articles/users/profile.mdx +3 -0
  246. package/docs/articles/version-support-policy.mdx +3 -0
  247. package/docs/articles/versioning-on-zuplo.mdx +3 -0
  248. package/docs/articles/waf-ddos-akamai.md +3 -0
  249. package/docs/articles/waf-ddos-aws-waf-shield.mdx +3 -0
  250. package/docs/articles/waf-ddos-fastly.mdx +3 -0
  251. package/docs/articles/waf-ddos.mdx +8 -0
  252. package/docs/articles/when-to-use-api-keys.md +3 -0
  253. package/docs/articles/workload-identity-inbound.mdx +3 -0
  254. package/docs/build-with-ai.mdx +3 -0
  255. package/docs/caching/cdn-caching.mdx +3 -0
  256. package/docs/caching/custom-caching-policy.mdx +3 -0
  257. package/docs/caching/dynamic-cache-rules.mdx +3 -0
  258. package/docs/caching/gateway-caching.mdx +3 -0
  259. package/docs/caching/overview.mdx +3 -0
  260. package/docs/caching/partial-response-caching.mdx +3 -0
  261. package/docs/cli/authentication.mdx +3 -0
  262. package/docs/cli/bucket-list.mdx +3 -0
  263. package/docs/cli/ca-certificate-create.mdx +3 -0
  264. package/docs/cli/ca-certificate-delete.mdx +3 -0
  265. package/docs/cli/ca-certificate-describe.mdx +3 -0
  266. package/docs/cli/ca-certificate-list.mdx +3 -0
  267. package/docs/cli/ca-certificate-update.mdx +3 -0
  268. package/docs/cli/connectivity.mdx +3 -0
  269. package/docs/cli/create-zuplo-api.mdx +3 -0
  270. package/docs/cli/custom-domain-create.mdx +6 -0
  271. package/docs/cli/custom-domain-delete.mdx +6 -0
  272. package/docs/cli/custom-domain-list.mdx +6 -0
  273. package/docs/cli/custom-domain-update.mdx +6 -0
  274. package/docs/cli/delete.mdx +5 -0
  275. package/docs/cli/deploy.mdx +5 -0
  276. package/docs/cli/dev.mdx +5 -0
  277. package/docs/cli/docs.mdx +3 -0
  278. package/docs/cli/editor.mdx +3 -0
  279. package/docs/cli/global-options.mdx +3 -0
  280. package/docs/cli/info.mdx +3 -0
  281. package/docs/cli/init.mdx +3 -0
  282. package/docs/cli/link.mdx +3 -0
  283. package/docs/cli/lint.mdx +3 -0
  284. package/docs/cli/list.mdx +5 -0
  285. package/docs/cli/logout.mdx +3 -0
  286. package/docs/cli/mtls-certificate-create.mdx +3 -0
  287. package/docs/cli/mtls-certificate-delete.mdx +3 -0
  288. package/docs/cli/mtls-certificate-describe.mdx +3 -0
  289. package/docs/cli/mtls-certificate-disable.mdx +3 -0
  290. package/docs/cli/mtls-certificate-list.mdx +3 -0
  291. package/docs/cli/mtls-certificate-update.mdx +3 -0
  292. package/docs/cli/openapi-convert.mdx +3 -0
  293. package/docs/cli/openapi-merge.mdx +3 -0
  294. package/docs/cli/openapi-overlay.mdx +3 -0
  295. package/docs/cli/overview.mdx +18 -15
  296. package/docs/cli/project-create.mdx +3 -0
  297. package/docs/cli/project-info.mdx +3 -0
  298. package/docs/cli/project-list.mdx +3 -0
  299. package/docs/cli/source-migrate.mdx +3 -0
  300. package/docs/cli/source-upgrade.mdx +3 -0
  301. package/docs/cli/test.mdx +3 -0
  302. package/docs/cli/tunnel-create.mdx +3 -0
  303. package/docs/cli/tunnel-delete.mdx +3 -0
  304. package/docs/cli/tunnel-describe.mdx +3 -0
  305. package/docs/cli/tunnel-list.mdx +3 -0
  306. package/docs/cli/tunnel-rotate-token.mdx +3 -0
  307. package/docs/cli/tunnel-services-describe.mdx +3 -0
  308. package/docs/cli/tunnel-services-update.mdx +3 -0
  309. package/docs/cli/variable-create.mdx +3 -0
  310. package/docs/cli/variable-update.mdx +3 -0
  311. package/docs/cli/whoami.mdx +3 -0
  312. package/docs/concepts/ai-gateway.mdx +3 -0
  313. package/docs/concepts/api-errors.md +3 -0
  314. package/docs/concepts/api-keys.md +3 -0
  315. package/docs/concepts/authentication.mdx +3 -0
  316. package/docs/concepts/how-zuplo-works.mdx +3 -0
  317. package/docs/concepts/mcp.mdx +3 -0
  318. package/docs/concepts/project-structure.mdx +3 -0
  319. package/docs/concepts/request-lifecycle.mdx +3 -0
  320. package/docs/concepts/source-control-and-deployment.mdx +14 -0
  321. package/docs/concepts/upstream-credentials.mdx +3 -0
  322. package/docs/concepts/where-zuplo-runs.mdx +124 -0
  323. package/docs/dedicated/akamai/ai-powered-applications.mdx +3 -0
  324. package/docs/dedicated/akamai/architecture.mdx +4 -1
  325. package/docs/dedicated/akamai/caching.mdx +3 -0
  326. package/docs/dedicated/akamai/cdn.mdx +3 -0
  327. package/docs/dedicated/architecture.mdx +10 -6
  328. package/docs/dedicated/aws/architecture.mdx +3 -0
  329. package/docs/dedicated/aws/private-networking.mdx +3 -0
  330. package/docs/dedicated/azure/architecture.mdx +3 -0
  331. package/docs/dedicated/azure/private-networking.mdx +3 -0
  332. package/docs/dedicated/configuration/host-header-override.mdx +3 -0
  333. package/docs/dedicated/configuration/overview.mdx +3 -0
  334. package/docs/dedicated/custom-domains.mdx +3 -0
  335. package/docs/dedicated/federated-gateways.mdx +4 -0
  336. package/docs/dedicated/gcp/architecture.mdx +3 -0
  337. package/docs/dedicated/gcp/private-networking.mdx +3 -0
  338. package/docs/dedicated/networking.mdx +3 -0
  339. package/docs/dedicated/overview.mdx +3 -0
  340. package/docs/dedicated/source-control.mdx +3 -0
  341. package/docs/dev-portal/auth-provider-api-identities.md +3 -0
  342. package/docs/dev-portal/branding.mdx +3 -0
  343. package/docs/dev-portal/dev-portal-create-consumer-on-auth.mdx +3 -0
  344. package/docs/dev-portal/documenting-mcp-servers.mdx +3 -0
  345. package/docs/dev-portal/migration.mdx +9 -0
  346. package/docs/dev-portal/node-modules.mdx +3 -0
  347. package/docs/dev-portal/overview.mdx +10 -0
  348. package/docs/dev-portal/server-side-rendering.mdx +4 -0
  349. package/docs/dev-portal/updating.mdx +3 -0
  350. package/docs/dev-portal/zudoku/components/alert.mdx +3 -0
  351. package/docs/dev-portal/zudoku/components/badge.mdx +3 -0
  352. package/docs/dev-portal/zudoku/components/browser-window.mdx +3 -0
  353. package/docs/dev-portal/zudoku/components/button.mdx +3 -0
  354. package/docs/dev-portal/zudoku/components/callout.mdx +3 -0
  355. package/docs/dev-portal/zudoku/components/card.mdx +3 -0
  356. package/docs/dev-portal/zudoku/components/checkbox.mdx +3 -0
  357. package/docs/dev-portal/zudoku/components/client-only.mdx +3 -0
  358. package/docs/dev-portal/zudoku/components/code-tabs.mdx +3 -0
  359. package/docs/dev-portal/zudoku/components/dialog.mdx +3 -0
  360. package/docs/dev-portal/zudoku/components/head.mdx +3 -0
  361. package/docs/dev-portal/zudoku/components/icons.mdx +3 -0
  362. package/docs/dev-portal/zudoku/components/input.mdx +3 -0
  363. package/docs/dev-portal/zudoku/components/label.mdx +3 -0
  364. package/docs/dev-portal/zudoku/components/landing-page.mdx +3 -0
  365. package/docs/dev-portal/zudoku/components/link.mdx +3 -0
  366. package/docs/dev-portal/zudoku/components/markdown.mdx +3 -0
  367. package/docs/dev-portal/zudoku/components/mermaid.mdx +3 -0
  368. package/docs/dev-portal/zudoku/components/playground.mdx +3 -0
  369. package/docs/dev-portal/zudoku/components/secret.mdx +3 -0
  370. package/docs/dev-portal/zudoku/components/select.mdx +3 -0
  371. package/docs/dev-portal/zudoku/components/shadcn.mdx +3 -0
  372. package/docs/dev-portal/zudoku/components/sidecar-box.mdx +3 -0
  373. package/docs/dev-portal/zudoku/components/slider.mdx +3 -0
  374. package/docs/dev-portal/zudoku/components/slot.mdx +3 -0
  375. package/docs/dev-portal/zudoku/components/stepper.mdx +3 -0
  376. package/docs/dev-portal/zudoku/components/switch.mdx +3 -0
  377. package/docs/dev-portal/zudoku/components/syntax-highlight.mdx +3 -0
  378. package/docs/dev-portal/zudoku/components/textarea.mdx +3 -0
  379. package/docs/dev-portal/zudoku/components/tooltip.mdx +3 -0
  380. package/docs/dev-portal/zudoku/components/typography.mdx +3 -0
  381. package/docs/dev-portal/zudoku/configuration/ai-assistants.md +3 -0
  382. package/docs/dev-portal/zudoku/configuration/api-catalog.md +3 -0
  383. package/docs/dev-portal/zudoku/configuration/api-reference.md +3 -0
  384. package/docs/dev-portal/zudoku/configuration/authentication-auth0.md +3 -0
  385. package/docs/dev-portal/zudoku/configuration/authentication-azure-ad.md +3 -0
  386. package/docs/dev-portal/zudoku/configuration/authentication-clerk.md +3 -0
  387. package/docs/dev-portal/zudoku/configuration/authentication-firebase.md +3 -0
  388. package/docs/dev-portal/zudoku/configuration/authentication-openid.md +3 -0
  389. package/docs/dev-portal/zudoku/configuration/authentication-pingfederate.md +3 -0
  390. package/docs/dev-portal/zudoku/configuration/authentication-supabase.md +3 -0
  391. package/docs/dev-portal/zudoku/configuration/authentication.md +3 -0
  392. package/docs/dev-portal/zudoku/configuration/build-configuration.mdx +3 -0
  393. package/docs/dev-portal/zudoku/configuration/docs.md +3 -0
  394. package/docs/dev-portal/zudoku/configuration/footer.mdx +3 -0
  395. package/docs/dev-portal/zudoku/configuration/llms.md +3 -0
  396. package/docs/dev-portal/zudoku/configuration/navigation.mdx +3 -0
  397. package/docs/dev-portal/zudoku/configuration/oauth-security-schemes.md +3 -0
  398. package/docs/dev-portal/zudoku/configuration/overview.md +3 -0
  399. package/docs/dev-portal/zudoku/configuration/protected-routes.md +3 -0
  400. package/docs/dev-portal/zudoku/configuration/search.md +3 -0
  401. package/docs/dev-portal/zudoku/configuration/sentry.mdx +3 -0
  402. package/docs/dev-portal/zudoku/configuration/site.md +3 -0
  403. package/docs/dev-portal/zudoku/configuration/slots.mdx +3 -0
  404. package/docs/dev-portal/zudoku/configuration/vite-config.md +3 -0
  405. package/docs/dev-portal/zudoku/custom-plugins.md +3 -0
  406. package/docs/dev-portal/zudoku/customization/colors-theme.mdx +3 -0
  407. package/docs/dev-portal/zudoku/customization/fonts.md +3 -0
  408. package/docs/dev-portal/zudoku/extending/events.md +3 -0
  409. package/docs/dev-portal/zudoku/extending/hooks.md +3 -0
  410. package/docs/dev-portal/zudoku/guides/custom-pages.md +3 -0
  411. package/docs/dev-portal/zudoku/guides/environment-variables.md +3 -0
  412. package/docs/dev-portal/zudoku/guides/mermaid.mdx +3 -0
  413. package/docs/dev-portal/zudoku/guides/navigation-migration.md +3 -0
  414. package/docs/dev-portal/zudoku/guides/navigation-rules.mdx +3 -0
  415. package/docs/dev-portal/zudoku/guides/processors.mdx +3 -0
  416. package/docs/dev-portal/zudoku/guides/redirects.md +3 -0
  417. package/docs/dev-portal/zudoku/guides/server-side-content-protection.md +3 -0
  418. package/docs/dev-portal/zudoku/guides/static-files.md +3 -0
  419. package/docs/dev-portal/zudoku/guides/transforming-examples.md +3 -0
  420. package/docs/dev-portal/zudoku/guides/using-multiple-apis.md +3 -0
  421. package/docs/dev-portal/zudoku/markdown/admonitions.md +3 -0
  422. package/docs/dev-portal/zudoku/markdown/code-blocks.md +3 -0
  423. package/docs/dev-portal/zudoku/markdown/frontmatter.md +3 -0
  424. package/docs/dev-portal/zudoku/markdown/mdx.md +3 -0
  425. package/docs/dev-portal/zudoku/markdown/overview.md +3 -0
  426. package/docs/dev-portal/zudoku/openapi-extensions/x-code-samples.md +3 -0
  427. package/docs/dev-portal/zudoku/openapi-extensions/x-display-name.md +3 -0
  428. package/docs/dev-portal/zudoku/openapi-extensions/x-internal.md +3 -0
  429. package/docs/dev-portal/zudoku/openapi-extensions/x-mcp-server.md +3 -0
  430. package/docs/dev-portal/zudoku/openapi-extensions/x-mcp.md +3 -0
  431. package/docs/dev-portal/zudoku/openapi-extensions/x-tag-groups.md +3 -0
  432. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-collapsed.md +3 -0
  433. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-collapsible.md +3 -0
  434. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-playground-enabled.md +3 -0
  435. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-request-box-enabled.md +3 -0
  436. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-seo.md +3 -0
  437. package/docs/dev-portal/zudoku/openapi-extensions/x-zudoku-type.md +3 -0
  438. package/docs/dev-portal/zudoku/plugins.md +3 -0
  439. package/docs/dev-portal/zudoku/writing.mdx +3 -0
  440. package/docs/errors/bad-request.mdx +3 -0
  441. package/docs/errors/build-error.mdx +3 -0
  442. package/docs/errors/fatal-project-error.mdx +3 -0
  443. package/docs/errors/gateway-timeout.mdx +3 -0
  444. package/docs/errors/main-mod-error.mdx +3 -0
  445. package/docs/errors/no-project-set.mdx +3 -0
  446. package/docs/errors/not-found.mdx +3 -0
  447. package/docs/errors/rate-limit-exceeded.mdx +3 -0
  448. package/docs/errors/schema-validation-failed.mdx +3 -0
  449. package/docs/errors/system-configuration-error.mdx +3 -0
  450. package/docs/errors/unauthorized.mdx +3 -0
  451. package/docs/errors/unknown-error.mdx +3 -0
  452. package/docs/errors.mdx +6 -0
  453. package/docs/getting-started/gateway/deploy-to-the-edge/index.mdx +3 -3
  454. package/docs/guides/canary-routing-for-employees.mdx +3 -0
  455. package/docs/guides/geolocation-backend-routing.mdx +12 -0
  456. package/docs/guides/modify-openapi-paths.mdx +3 -0
  457. package/docs/guides/openapi-overlays.mdx +3 -0
  458. package/docs/guides/overview.mdx +3 -0
  459. package/docs/guides/proxying-between-zuplo-gateways.mdx +10 -0
  460. package/docs/guides/transform-route-params-url-rewrite.mdx +3 -0
  461. package/docs/guides/user-based-backend-routing.mdx +3 -0
  462. package/docs/handlers/aws-lambda.mdx +3 -0
  463. package/docs/handlers/custom-handler.mdx +3 -0
  464. package/docs/handlers/legacy-dev-portal-handler.mdx +3 -0
  465. package/docs/handlers/mcp-server.mdx +3 -0
  466. package/docs/handlers/openapi.mdx +3 -0
  467. package/docs/handlers/redirect.mdx +3 -0
  468. package/docs/handlers/system-handlers.mdx +3 -0
  469. package/docs/handlers/url-forward.mdx +3 -0
  470. package/docs/handlers/url-rewrite.mdx +3 -0
  471. package/docs/handlers/websocket-handler.mdx +3 -0
  472. package/docs/handlers/websocket-pipeline-handler.mdx +3 -0
  473. package/docs/managed-edge/overview.md +3 -0
  474. package/docs/mcp-gateway/auth/configuring-auth0.mdx +3 -0
  475. package/docs/mcp-gateway/auth/configuring-clerk.mdx +3 -0
  476. package/docs/mcp-gateway/auth/configuring-cognito.mdx +3 -0
  477. package/docs/mcp-gateway/auth/configuring-entra.mdx +3 -0
  478. package/docs/mcp-gateway/auth/configuring-generic-oidc.mdx +3 -0
  479. package/docs/mcp-gateway/auth/configuring-google.mdx +3 -0
  480. package/docs/mcp-gateway/auth/configuring-keycloak.mdx +3 -0
  481. package/docs/mcp-gateway/auth/configuring-logto.mdx +3 -0
  482. package/docs/mcp-gateway/auth/configuring-okta.mdx +3 -0
  483. package/docs/mcp-gateway/auth/configuring-onelogin.mdx +3 -0
  484. package/docs/mcp-gateway/auth/configuring-ping.mdx +3 -0
  485. package/docs/mcp-gateway/auth/configuring-workos.mdx +3 -0
  486. package/docs/mcp-gateway/auth/manual-oauth-testing.mdx +3 -0
  487. package/docs/mcp-gateway/auth/overview.mdx +3 -0
  488. package/docs/mcp-gateway/auth/upstream-oauth.mdx +3 -0
  489. package/docs/mcp-gateway/capability-filtering.mdx +3 -0
  490. package/docs/mcp-gateway/code-config/compatibility-dates.mdx +3 -0
  491. package/docs/mcp-gateway/code-config/local-development.mdx +3 -0
  492. package/docs/mcp-gateway/code-config/mcp-proxy-handler.mdx +3 -0
  493. package/docs/mcp-gateway/code-config/multi-upstream.mdx +3 -0
  494. package/docs/mcp-gateway/code-config/overview.mdx +3 -0
  495. package/docs/mcp-gateway/connect-clients/chatgpt.mdx +3 -0
  496. package/docs/mcp-gateway/connect-clients/claude-code.mdx +3 -0
  497. package/docs/mcp-gateway/connect-clients/claude-desktop.mdx +3 -0
  498. package/docs/mcp-gateway/connect-clients/cursor.mdx +3 -0
  499. package/docs/mcp-gateway/connect-clients/other-clients.mdx +3 -0
  500. package/docs/mcp-gateway/connect-clients/overview.mdx +3 -0
  501. package/docs/mcp-gateway/connect-clients/vs-code.mdx +3 -0
  502. package/docs/mcp-gateway/cross-app-access/overview.mdx +3 -0
  503. package/docs/mcp-gateway/cross-app-access/policy-reference.mdx +3 -0
  504. package/docs/mcp-gateway/cross-app-access/quickstart.mdx +3 -0
  505. package/docs/mcp-gateway/how-it-works.mdx +3 -0
  506. package/docs/mcp-gateway/how-to/connect-upstream-api-key.mdx +3 -0
  507. package/docs/mcp-gateway/how-to/connect-upstream-oauth.mdx +3 -0
  508. package/docs/mcp-gateway/how-to/curate-tools-local.mdx +3 -0
  509. package/docs/mcp-gateway/how-to/curate-tools.mdx +3 -0
  510. package/docs/mcp-gateway/observability/analytics.mdx +3 -0
  511. package/docs/mcp-gateway/observability/logging.mdx +3 -0
  512. package/docs/mcp-gateway/overview.mdx +3 -0
  513. package/docs/mcp-gateway/policies/overview.mdx +3 -0
  514. package/docs/mcp-gateway/reference.mdx +3 -0
  515. package/docs/mcp-gateway/server-registry.mdx +3 -0
  516. package/docs/mcp-gateway/test-clients.mdx +3 -0
  517. package/docs/mcp-gateway/troubleshooting.mdx +3 -0
  518. package/docs/mcp-server/configuration-migration-guide.mdx +3 -0
  519. package/docs/mcp-server/custom-tools.mdx +3 -0
  520. package/docs/mcp-server/graphql.mdx +3 -0
  521. package/docs/mcp-server/openai-apps-sdk.mdx +3 -0
  522. package/docs/mcp-server/overview.mdx +3 -0
  523. package/docs/mcp-server/prompts.mdx +3 -0
  524. package/docs/mcp-server/resources.mdx +3 -0
  525. package/docs/mcp-server/testing.mdx +3 -0
  526. package/docs/mcp-server/tools.mdx +3 -0
  527. package/docs/mcp-server/troubleshooting.mdx +3 -0
  528. package/docs/policies/_index.md +1 -1
  529. package/docs/policies/ai-gateway-metering-inbound/doc.md +6 -7
  530. package/docs/policies/ai-gateway-metering-inbound/intro.md +2 -3
  531. package/docs/policies/ai-gateway-metering-inbound/schema.json +7 -6
  532. package/docs/programmable-api/background-dispatcher.mdx +3 -0
  533. package/docs/programmable-api/background-loader.mdx +3 -0
  534. package/docs/programmable-api/cache.mdx +3 -0
  535. package/docs/programmable-api/compatibility-dates.mdx +3 -0
  536. package/docs/programmable-api/console-logging.mdx +3 -0
  537. package/docs/programmable-api/context-data.mdx +3 -0
  538. package/docs/programmable-api/custom-cors-policy.mdx +3 -0
  539. package/docs/programmable-api/environment.mdx +10 -0
  540. package/docs/programmable-api/hooks.mdx +3 -0
  541. package/docs/programmable-api/http-problems.mdx +3 -0
  542. package/docs/programmable-api/jwt-service-plugin.mdx +3 -0
  543. package/docs/programmable-api/logger.mdx +3 -0
  544. package/docs/programmable-api/mcp-gateway-plugin.mdx +3 -0
  545. package/docs/programmable-api/mcp-sdk.mdx +3 -0
  546. package/docs/programmable-api/memory-zone-read-through-cache.mdx +3 -0
  547. package/docs/programmable-api/node-modules.mdx +3 -0
  548. package/docs/programmable-api/not-found-handler.mdx +3 -0
  549. package/docs/programmable-api/oauth-protected-resource-plugin.mdx +3 -0
  550. package/docs/programmable-api/overview.mdx +3 -0
  551. package/docs/programmable-api/problem-response-formatter.mdx +3 -0
  552. package/docs/programmable-api/request-user.mdx +3 -0
  553. package/docs/programmable-api/reusing-code.mdx +3 -0
  554. package/docs/programmable-api/route-raw.mdx +3 -0
  555. package/docs/programmable-api/runtime-behaviors.mdx +3 -0
  556. package/docs/programmable-api/runtime-errors.mdx +3 -0
  557. package/docs/programmable-api/runtime-extensions.mdx +10 -0
  558. package/docs/programmable-api/safely-clone-a-request-or-response.mdx +3 -0
  559. package/docs/programmable-api/streaming-zone-cache.mdx +3 -0
  560. package/docs/programmable-api/web-crypto-apis.mdx +3 -0
  561. package/docs/programmable-api/web-standard-apis.mdx +3 -0
  562. package/docs/programmable-api/zone-cache.mdx +3 -0
  563. package/docs/programmable-api/zp-body-removed.mdx +3 -0
  564. package/docs/programmable-api/zuplo-context.mdx +12 -0
  565. package/docs/programmable-api/zuplo-id-token.mdx +3 -0
  566. package/docs/programmable-api/zuplo-json.mdx +6 -0
  567. package/docs/programmable-api/zuplo-request.mdx +3 -0
  568. package/docs/rate-limiting/combining-policies.mdx +3 -0
  569. package/docs/rate-limiting/dynamic-rate-limiting.mdx +3 -0
  570. package/docs/rate-limiting/getting-started.mdx +3 -0
  571. package/docs/rate-limiting/how-it-works.md +3 -0
  572. package/docs/rate-limiting/monitoring-and-troubleshooting.mdx +3 -0
  573. package/docs/rate-limiting/per-user-rate-limits-using-db.mdx +3 -0
  574. package/docs/sample-apis.mdx +3 -0
  575. package/docs/self-hosted/install.md +3 -0
  576. package/docs/self-hosted/overview.md +3 -0
  577. package/docs/self-hosted/requirements.md +3 -0
  578. package/docs/self-hosted/troubleshooting.md +3 -0
  579. package/docs/self-hosted/upgrade.md +3 -0
  580. package/package.json +5 -5
@@ -0,0 +1,124 @@
1
+ ---
2
+ title: Where Zuplo Runs
3
+ description:
4
+ Zuplo runs at the edge, on a dedicated instance in the cloud of your choice,
5
+ or on your own Kubernetes cluster, and connects to backends on any cloud or on
6
+ premises.
7
+ applies_to:
8
+ product: gateway
9
+ hosting: all
10
+ ---
11
+
12
+ Zuplo runs the same gateway in three places: at the edge, on a dedicated
13
+ instance in the cloud you choose, or on your own infrastructure. Wherever the
14
+ gateway runs, it can route to backends on AWS, Google Cloud, Azure, other
15
+ providers, or your own data center. This page explains the hosting options and
16
+ how Zuplo fits into a single-cloud, multi-cloud, or hybrid environment.
17
+
18
+ ## Hosting options
19
+
20
+ | Option | Where the gateway runs | Choose it when you want |
21
+ | ---------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
22
+ | [Managed Edge](../managed-edge/overview.md) | Serverless, across 300+ data centers worldwide | Global low latency and automatic scaling with no infrastructure to manage |
23
+ | [Managed Dedicated](../dedicated/overview.mdx) | An isolated instance that Zuplo operates on the cloud provider and regions you choose | A specific cloud or region, private networking, or dedicated compliance requirements |
24
+ | [Self-Hosted](../self-hosted/overview.md) | Your Kubernetes cluster, in any cloud or private data center, installed with a Helm chart | Full control of the infrastructure that serves your API traffic |
25
+
26
+ Managed Edge is the default for every Zuplo project. For a closer look at each
27
+ option, see [Hosting Options](../articles/hosting-options.mdx).
28
+
29
+ ### Managed Edge
30
+
31
+ Your gateway runs in hundreds of data centers worldwide, close to your clients.
32
+ Each request reaches the nearest location, runs through your policies, and goes
33
+ straight to your backend, wherever that backend runs. If one location has an
34
+ issue, traffic routes to the next nearest location automatically.
35
+
36
+ ### Managed Dedicated
37
+
38
+ Zuplo runs a dedicated, isolated instance of the gateway for you on the cloud
39
+ provider of your choice:
40
+
41
+ - [Akamai Connected Cloud](../dedicated/akamai/architecture.mdx)
42
+ - [AWS](../dedicated/aws/architecture.mdx)
43
+ - [Azure](../dedicated/azure/architecture.mdx)
44
+ - [Google Cloud](../dedicated/gcp/architecture.mdx)
45
+ - Equinix, TerraSwitch, and other providers on request
46
+
47
+ You pick the regions, so you can keep traffic in a specific country or next to
48
+ your backends. You can also deploy instances in multiple regions for high
49
+ availability and disaster recovery.
50
+
51
+ ### Self-Hosted
52
+
53
+ You install Zuplo on your own Kubernetes cluster with a single Helm chart. The
54
+ cluster can run in any cloud or in a private data center. API traffic to your
55
+ gateways stays on your infrastructure, while Zuplo provides the portal and a
56
+ small set of supporting services.
57
+
58
+ ## One project, any hosting option
59
+
60
+ All three hosting options use the same runtime, project format, policies, and
61
+ deployment workflow. Your routes, policies, custom code, and environment
62
+ variables live in your Git repository, not in a cloud-specific configuration.
63
+
64
+ This gives you two advantages:
65
+
66
+ - **No cloud lock-in.** Zuplo isn't tied to one cloud provider's gateway, so
67
+ your API layer stays the same when your backends change clouds.
68
+ - **Room to grow.** A team can start on Managed Edge and move to Managed
69
+ Dedicated or Self-Hosted later, for example when a compliance requirement
70
+ appears, without rewriting the gateway.
71
+
72
+ ## Connecting to backends on any cloud
73
+
74
+ The gateway location and the backend location are independent. A single Zuplo
75
+ project can send one route to AWS Lambda, another to Google Cloud Run, and
76
+ another to a service in your own data center, while clients see one API with one
77
+ set of authentication, rate limits, and analytics.
78
+
79
+ <Diagram height="h-96">
80
+ <DiagramNode id="clients">Clients</DiagramNode>
81
+ <DiagramNode id="zuplo" variant="zuplo">
82
+ Zuplo Gateway
83
+ </DiagramNode>
84
+ <DiagramNode id="aws" variant="orange">
85
+ AWS
86
+ </DiagramNode>
87
+ <DiagramNode id="gcp" variant="blue">
88
+ Google Cloud
89
+ </DiagramNode>
90
+ <DiagramNode id="azure" variant="blue">
91
+ Azure
92
+ </DiagramNode>
93
+ <DiagramNode id="onprem" variant="green">
94
+ On-premises data center
95
+ </DiagramNode>
96
+ <DiagramEdge from="clients" to="zuplo" />
97
+ <DiagramEdge from="zuplo" to="aws" />
98
+ <DiagramEdge from="zuplo" to="gcp" />
99
+ <DiagramEdge from="zuplo" to="azure" />
100
+ <DiagramEdge from="zuplo" to="onprem" />
101
+ </Diagram>
102
+
103
+ Pick the connection method that matches where each backend runs:
104
+
105
+ | Backend | How Zuplo connects |
106
+ | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
107
+ | Behind AWS, Azure, or Google Cloud IAM | [IAM authentication](../articles/upstream-iam-auth.mdx) policies sign each request with credentials your cloud provider trusts |
108
+ | Any backend that can check a certificate | [mTLS](../articles/securing-backend-mtls.mdx), so the gateway and backend authenticate each other |
109
+ | No public endpoint, bare metal, or on premises | A [secure tunnel](../articles/secure-tunnel.mdx) that opens an outbound connection from your network, with no inbound firewall rules |
110
+ | In a private VPC or VNet, with Managed Dedicated | [Private networking](../dedicated/networking.mdx) such as AWS PrivateLink, Azure Private Link, or Google Cloud Private Service Connect |
111
+ | Any backend that can check a header | A [shared secret](../articles/securing-your-backend.mdx#shared-secret-or-api-key) that the gateway adds to each request |
112
+
113
+ IAM authentication, mTLS, and secure tunnels are available on enterprise plans.
114
+
115
+ Because each route sets its own backend URL, you can move a service from one
116
+ cloud to another, or from your data center to the cloud, by changing that URL.
117
+ Clients keep calling the same API.
118
+
119
+ ## Related resources
120
+
121
+ - [How Zuplo Works](./how-zuplo-works.mdx)
122
+ - [Hosting Options](../articles/hosting-options.mdx)
123
+ - [Securing your backend](../articles/securing-your-backend.mdx)
124
+ - [Managed Dedicated architecture](../dedicated/architecture.mdx)
@@ -4,6 +4,9 @@ sidebar_label: AI-Powered Applications
4
4
  description:
5
5
  Reference architecture for secure, AI-powered applications on Akamai Connected
6
6
  Cloud with Zuplo AI Gateway, MCP servers, and Akamai AI Firewall.
7
+ applies_to:
8
+ product: gateway
9
+ hosting: [managed-dedicated]
7
10
  ---
8
11
 
9
12
  This document describes a reference architecture for AI-powered applications
@@ -3,6 +3,9 @@ title: Akamai Dedicated Architecture
3
3
  sidebar_label: Architecture
4
4
  description:
5
5
  Architecture overview for Zuplo Gateway deployments on Akamai Connected Cloud.
6
+ applies_to:
7
+ product: gateway
8
+ hosting: [managed-dedicated]
6
9
  ---
7
10
 
8
11
  Zuplo integrates with Akamai Connected Cloud to provide a secure, highly
@@ -239,7 +242,7 @@ Zuplo and your backend services. For complete documentation, see
239
242
  | **Zuplo JWT Service** | Issue signed JWTs that your backend validates using Zuplo's JWKS endpoint. Provides cryptographic proof that requests originate from your gateway. |
240
243
  | **mTLS (Mutual TLS)** | Certificate-based authentication where both gateway and backend present certificates. Provides zero-trust security for enterprise requirements. |
241
244
  | **Cloud Provider IAM** | Use AWS IAM, GCP Identity-Aware Proxy, or Microsoft Entra ID to authorize requests. No credentials to manage - uses federated identity. |
242
- | **Secure Tunnel (VPN)** | WireGuard-based tunnel for backends that can't be exposed to the internet. Useful for on-premise or bare-metal deployments. |
245
+ | **Secure Tunnel (VPN)** | Secure tunnel for backends that can't be exposed to the internet. Useful for on-premise or bare-metal deployments. |
243
246
  | **Private Network** | VPC peering, PrivateLink, or Transit Gateway for private connectivity without traversing the public internet. |
244
247
 
245
248
  ### Recommendations by backend location
@@ -5,6 +5,9 @@ description:
5
5
  Cache Zuplo responses at the Akamai edge with the CDN Cache Control policy.
6
6
  Covers Edge-Control TTLs, Edge-Cache-Tag purge tags, and the Property Manager
7
7
  settings that make them work.
8
+ applies_to:
9
+ product: gateway
10
+ hosting: [managed-dedicated]
8
11
  ---
9
12
 
10
13
  An Akamai property in front of a Zuplo gateway can absorb most of the read
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Setting up Akamai CDNs
3
3
  sidebar_label: CDN Setup
4
+ applies_to:
5
+ product: [gateway, developer-portal]
6
+ hosting: managed-dedicated
4
7
  ---
5
8
 
6
9
  <!-- vale Vale.Spelling["Edgescape","Maxage"] = NO -->
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Managed Dedicated: Architecture"
3
3
  sidebar_label: Architecture
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  Zuplo's managed dedicated instances are highly available, scalable, and secure.
@@ -17,10 +20,11 @@ A managed dedicated instance of Zuplo consists of the following components:
17
20
  receives incoming requests, routes them to the appropriate backend, and
18
21
  returns the response to the client. The gateway handles authentication,
19
22
  authorization, rate limiting, and other features.
20
- - **Gateway Services**: Zuplo, being a highly distributed gateway, uses services
21
- to facilitate features such as
23
+ - **Gateway Services**: Zuplo-hosted services that power features such as
22
24
  [Rate Limiting](../getting-started/gateway/add-rate-limiting/index.mdx) and
23
- [API Key Authentication](../articles/api-key-management.mdx).
25
+ [API Key Authentication](../articles/api-key-management.mdx). Every Zuplo
26
+ deployment, including managed dedicated instances, uses the same gateway
27
+ services.
24
28
  - **Control Plane**: The Control Plane manages the configuration of the Zuplo
25
29
  Gateway. It deploys new configurations, manages the lifecycle of the Zuplo
26
30
  Gateway, and monitors its health.
@@ -89,9 +93,6 @@ instance of Zuplo and how the components interact with each other.
89
93
  <DiagramNode id="gateway" variant="zuplo">
90
94
  Zuplo Gateway
91
95
  </DiagramNode>
92
- <DiagramNode id="services" variant="zuplo">
93
- Gateway Services
94
- </DiagramNode>
95
96
  </DiagramGroup>
96
97
  <DiagramGroup id="customer-vpc" label="Customer Private Network">
97
98
  <DiagramNode id="backend">Backend</DiagramNode>
@@ -99,6 +100,9 @@ instance of Zuplo and how the components interact with each other.
99
100
  <DiagramNode id="control" variant="zuplo">
100
101
  Control Plane
101
102
  </DiagramNode>
103
+ <DiagramNode id="services" variant="zuplo">
104
+ Gateway Services
105
+ </DiagramNode>
102
106
  <DiagramEdge from="client" to="gateway" />
103
107
  <DiagramEdge from="gateway" to="backend" />
104
108
  <DiagramEdge from="gateway" to="services" fromSide="bottom" toSide="top" />
@@ -4,6 +4,9 @@ sidebar_label: Architecture
4
4
  description:
5
5
  How a Zuplo Managed Dedicated instance runs on AWS, and what you need to know
6
6
  to connect clients and backends to it.
7
+ applies_to:
8
+ product: gateway
9
+ hosting: [managed-dedicated]
7
10
  ---
8
11
 
9
12
  A Managed Dedicated instance on AWS runs in its own VPC, in an AWS account that
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Managed Dedicated: AWS Private Networking"
3
3
  sidebar_label: Private Networking
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  Zuplo Managed Dedicated can run on AWS and connect privately to backends that
@@ -4,6 +4,9 @@ sidebar_label: Architecture
4
4
  description:
5
5
  How a Zuplo Managed Dedicated instance runs on Azure, and what you need to
6
6
  know to connect clients and backends to it.
7
+ applies_to:
8
+ product: gateway
9
+ hosting: [managed-dedicated]
7
10
  ---
8
11
 
9
12
  A Managed Dedicated instance on Azure runs in its own virtual network (VNet), in
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Managed Dedicated: Azure Private Networking"
3
3
  sidebar_label: Private Networking
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  Zuplo Managed Dedicated can run on Azure and connect privately to backends that
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Managed Dedicated: Host Header Override"
3
3
  sidebar_label: Host Header Override
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  By default, the `Host` header your gateway sends to a backend is derived from
@@ -2,6 +2,9 @@
2
2
  title: "Managed Dedicated: Configuration"
3
3
  sidebar_label: Overview
4
4
  description: Settings in zuplo.jsonc that apply to Managed Dedicated projects.
5
+ applies_to:
6
+ product: gateway
7
+ hosting: [managed-dedicated]
5
8
  ---
6
9
 
7
10
  Managed Dedicated projects use the same `zuplo.jsonc` file as every other Zuplo
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Managed Dedicated: Custom Domains"
3
3
  sidebar_label: Custom Domains
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  Configuration of custom domains with your managed dedicated instance of Zuplo
@@ -1,6 +1,10 @@
1
1
  ---
2
2
  title: "Managed Dedicated: Federated Gateways"
3
3
  sidebar_label: Federated Gateways
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
7
+ plan: enterprise
4
8
  ---
5
9
 
6
10
  <EnterpriseFeature name="Federated Gateways" />
@@ -4,6 +4,9 @@ sidebar_label: Architecture
4
4
  description:
5
5
  How a Zuplo Managed Dedicated instance runs on Google Cloud, and what you need
6
6
  to know to connect clients and backends to it.
7
+ applies_to:
8
+ product: gateway
9
+ hosting: [managed-dedicated]
7
10
  ---
8
11
 
9
12
  A Managed Dedicated instance on Google Cloud runs in its own VPC network, in a
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Managed Dedicated: GCP Private Networking"
3
3
  sidebar_label: Private Networking
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  Zuplo Managed Dedicated can run on Google Cloud and connect privately to
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Managed Dedicated: Networking"
3
3
  sidebar_label: Networking
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  Your dedicated managed instance of Zuplo will be deployed to the cloud provider
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Zuplo Managed Dedicated
3
3
  sidebar_label: Overview
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  Zuplo Managed Dedicated is a deployment model where Zuplo runs one or more
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Managed Dedicated: Source Control"
3
3
  sidebar_label: "Source Control"
4
+ applies_to:
5
+ product: gateway
6
+ hosting: [managed-dedicated]
4
7
  ---
5
8
 
6
9
  Zuplo supports GitOps workflows for managing your Zuplo Gateway configuration.
@@ -6,6 +6,9 @@ description:
6
6
  Learn how to create a custom API identity plugin for the Dev Portal to
7
7
  authenticate API playground requests with OAuth JWT tokens or other custom
8
8
  credentials.
9
+ applies_to:
10
+ product: developer-portal
11
+ hosting: all
9
12
  ---
10
13
 
11
14
  The Dev Portal API playground allows users to make authenticated requests to
@@ -4,6 +4,9 @@ sidebar_label: Zuplo Branding
4
4
  description:
5
5
  Learn which plans show the "Powered by Zuplo" badge on the Developer Portal
6
6
  and how to remove it.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
7
10
  ---
8
11
 
9
12
  Developer Portals on Zuplo's self-serve plans display a "Powered by Zuplo"
@@ -6,6 +6,9 @@ description:
6
6
  Learn how to automatically create an API Key Consumer for users upon login to
7
7
  your Developer Portal using Auth0 actions. This guide provides step-by-step
8
8
  instructions for integrating with the Dev Portal.
9
+ applies_to:
10
+ product: developer-portal
11
+ hosting: all
9
12
  ---
10
13
 
11
14
  By default, users who log into your Zuplo powered Developer Portal won't have an
@@ -5,6 +5,9 @@ navigation_icon: bot
5
5
  description:
6
6
  Use the x-mcp-server OpenAPI extension to render an MCP setup card in the Dev
7
7
  Portal for external or proxied MCP servers.
8
+ applies_to:
9
+ product: developer-portal
10
+ hosting: all
8
11
  ---
9
12
 
10
13
  The Dev Portal renders a dedicated
@@ -3,6 +3,15 @@ title: Dev Portal Migration Guide
3
3
  sidebar_label: Migration Guide
4
4
  description:
5
5
  Instruction for migrating from the legacy developer portal to Zudoku.
6
+ applies_to:
7
+ product: developer-portal
8
+ hosting: all
9
+ differs:
10
+ managed-dedicated: >-
11
+ The in-browser **Migrate to Zudoku** button isn't available because
12
+ working copy environments aren't available. Use the CLI or manual
13
+ migration in [local development](../articles/local-development.mdx)
14
+ instead.
6
15
  ---
7
16
 
8
17
  This guide walks you through migrating your existing documentation from the
@@ -2,6 +2,9 @@
2
2
  title: Node Modules & Customization
3
3
  description:
4
4
  Guide to installing custom node modules in Zuplo's developer portal.
5
+ applies_to:
6
+ product: developer-portal
7
+ hosting: all
5
8
  ---
6
9
 
7
10
  The Dev Portal supports installing and using custom node modules in your
@@ -4,6 +4,16 @@ sidebar_label: Overview
4
4
  description:
5
5
  Build and publish an API developer portal with interactive documentation,
6
6
  authentication, and API key self-service.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
10
+ differs:
11
+ managed-dedicated: >-
12
+ Zuplo hosts the Developer Portal the same way on every hosting option. If
13
+ you prefer, you can deploy it to your own infrastructure instead.
14
+ self-hosted: >-
15
+ Zuplo hosts the Developer Portal the same way on every hosting option. If
16
+ you prefer, you can deploy it to your own infrastructure instead.
7
17
  ---
8
18
 
9
19
  <span id="what-is-the-dev-portal" />
@@ -4,6 +4,10 @@ sidebar_icon: server-cog
4
4
  description:
5
5
  Run the Dev Portal on a server for each deployment so protected routes are
6
6
  enforced server-side.
7
+ applies_to:
8
+ product: developer-portal
9
+ hosting: all
10
+ plan: enterprise
7
11
  ---
8
12
 
9
13
  <EnterpriseFeature name="Dev Portal Server-Side Rendering" />
@@ -3,6 +3,9 @@ title: Updating Versions
3
3
  description:
4
4
  How to update Zuplo's developer portal to keep it up to date with the latest
5
5
  changes.
6
+ applies_to:
7
+ product: developer-portal
8
+ hosting: all
6
9
  ---
7
10
 
8
11
  When developing your Dev Portal locally, you likely want to keep your version of
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Alert
3
3
  sidebar_icon: triangle-alert
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Alert, AlertDescription, AlertTitle } from "zudoku/ui/Alert";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Badge
3
3
  sidebar_icon: tag
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  A small badge component used to display status information or labels.
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Browser Window
3
3
  sidebar_icon: app-window
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { BrowserWindow } from "zudoku/components";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Button
3
3
  sidebar_icon: mouse-pointer-click
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Button } from "zudoku/ui/Button";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Callout
3
3
  sidebar_icon: circle-alert
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Callout } from "zudoku/ui/Callout";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Card
3
3
  sidebar_icon: square
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import {
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Checkbox
3
3
  sidebar_icon: check-square
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Checkbox } from "zudoku/ui/Checkbox";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: ClientOnly
3
3
  sidebar_icon: monitor
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  A component that only renders its children on the client-side, preventing hydration mismatches
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: CodeTabs
3
3
  sidebar_icon: columns-2
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  A tabbed code block component that groups multiple code blocks into a single unified view. Useful
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Dialog
3
3
  sidebar_icon: rectangle-horizontal
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import {
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Head
3
3
  sidebar_icon: circle-fading-plus
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  The Head component allows you to manage document head elements like title, meta tags, and links from
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Icons
3
3
  sidebar_icon: flag
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { AtomIcon, PackagePlusIcon } from "zudoku/icons";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Input
3
3
  sidebar_icon: type
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Input } from "zudoku/ui/Input";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Label
3
3
  sidebar_icon: tag
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { Label } from "zudoku/ui/Label";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Landing Page
3
3
  sidebar_icon: layout-template
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  import { BrowserWindow, LandingPage } from "zudoku/components";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: Link
3
3
  sidebar_icon: link
4
+ applies_to:
5
+ product: developer-portal
6
+ hosting: all
4
7
  ---
5
8
 
6
9
  A navigation component that provides client-side routing capabilities for internal links and