npm - zuplo - Versions diffs - 7.12.5 → 7.12.7 - Mend

zuplo 7.12.5 → 7.12.7

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 (579) hide show

package/docs/articles/accounts/roles-and-permissions.mdx CHANGED Viewed

@@ -4,6 +4,9 @@ sidebar_label: Role Permissions
 description:
   Compare account, project, and AI Gateway permissions for Admin, Developer,
   Member, AI User, and pool roles.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 <EnterpriseFeature name="Role Based Access Control" />

package/docs/articles/accounts/switching-between-accounts.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Switching Between Accounts
 sidebar_label: Switching Accounts
+applies_to:
+  product: gateway
+  hosting: all
 ---
 If you belong to more than one Zuplo account (for example, your own personal

package/docs/articles/accounts/zuplo-api-keys.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Zuplo API Keys
 sidebar_label: API Keys
+applies_to:
+  product: gateway
+  hosting: all
 ---
 The [Zuplo Developer API](https://dev.zuplo.com) allows you to programmatically

package/docs/articles/add-api-to-backstage.mdx CHANGED Viewed

@@ -8,6 +8,9 @@ tags:
   - openapi
   - backends
   - integrations
+applies_to:
+  product: gateway
+  hosting: all
 ---
 In this guide, we'll walk you through the steps to add your Zuplo API to

package/docs/articles/advanced-path-matching.mdx CHANGED Viewed

@@ -7,6 +7,9 @@ description:
 tags:
   - openapi
   - custom-code
+applies_to:
+  product: gateway
+  hosting: all
 ---
 By default, path matching in Zuplo uses the OpenAPI slug format, for example

package/docs/articles/api-key-administration.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Manage Keys in the Portal
 sidebar_label: Manage in the Portal
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Manage API Key Consumers from the

package/docs/articles/api-key-api.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Use the Developer API
 sidebar_label: Developer API
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo runs a globally distributed API Key management service that scales to

package/docs/articles/api-key-authentication.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Authentication and Authorization
 sidebar_label: Authentication
+applies_to:
+  product: gateway
+  hosting: all
 ---
 With the [API Key Authentication Policy](../policies/api-key-inbound.mdx)

package/docs/articles/api-key-best-practices.mdx CHANGED Viewed

@@ -1,6 +1,16 @@
 ---
 title: API Key Best Practices
 sidebar_label: Best Practices
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Validation results are cached in the regions of your dedicated instance
+      instead of across 300+ edge locations.
+    self-hosted: >-
+      Validation results are cached by your gateways inside your own cluster,
+      and Zuplo cloud services provide key storage and management.
 ---
 A well-designed API key system handles much more than authentication. It covers

package/docs/articles/api-key-buckets.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Buckets and Environments
 sidebar_label: Buckets
+applies_to:
+  product: gateway
+  hosting: all
 ---
 API keys are stored in "buckets," which organize and isolate authentication

package/docs/articles/api-key-consumer-bucket-portal-ui.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Learn how to create API key consumers in a specific bucket using the Zuplo
   portal UI, including bucket selection, environment mapping, and
   troubleshooting.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Every API key consumer in Zuplo lives inside a **bucket**. Each project's

package/docs/articles/api-key-end-users.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Share Keys with End Users
 sidebar_label: End-User Access
+applies_to:
+  product: [gateway, developer-portal]
+  hosting: all
 ---
 Once your API uses [API Key Authentication](../policies/api-key-inbound.mdx),

package/docs/articles/api-key-leak-detection.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: API Key Leak Detection
 sidebar_label: Leak Detection
+applies_to:
+  product: gateway
+  hosting: all
 ---
 ## API key format enables leak detection

package/docs/articles/api-key-management.mdx CHANGED Viewed

@@ -1,6 +1,16 @@
 ---
 title: API Keys Overview
 sidebar_label: Overview
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Keys are validated and cached in the regions of your dedicated instance
+      instead of across 300+ edge locations.
+    self-hosted: >-
+      Your gateways validate keys inside your own cluster, and Zuplo cloud
+      services provide key storage and management.
 ---
 Zuplo provides a fully managed API key authentication system that you can add to

package/docs/articles/api-key-metadata.mdx CHANGED Viewed

@@ -5,6 +5,9 @@ description:
   Set, read, and forward consumer metadata on API key requests to gate features
   by plan, route to tenant-specific backends, and pass identity to your upstream
   services.
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Consumer metadata is a JSON object (up to 1 KB) attached to each

package/docs/articles/api-key-react-component.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: API Key Manager React Component
 sidebar_label: React Component
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo provides an open source react component that can be used on your own UI to

package/docs/articles/api-key-self-serve-integration.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Build Self-Serve Key Management
 sidebar_label: Self-Serve Integration
+applies_to:
+  product: gateway
+  hosting: all
 ---
 If you want your users to create, view, rotate, and delete API keys from within

package/docs/articles/api-key-service-limits.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: API Key Service Limits
 sidebar_label: Service Limits
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo's API Key Service can handle billions of requests and tokens. The service

package/docs/articles/archiving-requests-to-storage.mdx CHANGED Viewed

@@ -7,6 +7,17 @@ description:
 tags:
   - request-handling
   - observability
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Your instance can send outbound traffic from fixed IP addresses, so
+      restricting the SAS token by IP can work. Contact your account team for
+      your instance's addresses.
+    self-hosted: >-
+      Outbound requests come from your own cluster's network, so you can
+      restrict the SAS token to your cluster's egress IP addresses.
 ---
 > Note - this sample uses Policies, read [this guide](../policies) first.

package/docs/articles/audit-logging.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Audit Logging
 sidebar_label: Overview
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Audit logs answer the question "who did what through your API, and when?" —

package/docs/articles/audit-logs.mdx CHANGED Viewed

@@ -1,6 +1,9 @@
 ---
 title: Zuplo Audit Logs
 sidebar_label: Zuplo Audit Logs
+applies_to:
+  product: gateway
+  hosting: all
 ---
 Zuplo's Audit Logs feature gives you a complete

package/docs/articles/branch-based-deployments.mdx CHANGED Viewed

@@ -1,6 +1,19 @@
 ---
 title: Branch-Based Deployments
 sidebar_label: Branch-Based Deployments
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Branch-based deployments work the same way through the Git integrations or
+      the Zuplo CLI, and preview environments use your instance's domain. See
+      [Managed Dedicated: Source Control](../dedicated/source-control.mdx).
+    self-hosted: >-
+      Environment hostnames are created under the wildcard subdomain you
+      configure for your cluster, and deployments from the Zuplo Portal require
+      Zuplo to register your management API hostname. See [Self-Hosted
+      requirements](../self-hosted/requirements.md).
 ---
 Zuplo uses a branch-based deployment model that automatically maps Git branches

package/docs/articles/bypass-policy-for-testing.mdx CHANGED Viewed

@@ -8,6 +8,9 @@ tags:
   - testing
   - authentication
   - custom-code
+applies_to:
+  product: gateway
+  hosting: all
 ---
 There are times when you need to bypass a policy for purposes such as testing,

package/docs/articles/certificate-pinning.mdx CHANGED Viewed

@@ -1,6 +1,18 @@
 ---
 title: Certificate Pinning
 sidebar_label: Certificate Pinning
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    managed-dedicated: >-
+      Zuplo manages the certificates for your instance's domains, so check the
+      rotation schedule with your account team before you pin. See [Managed
+      Dedicated: Custom Domains](../dedicated/custom-domains.mdx).
+    self-hosted: >-
+      cert-manager in your cluster issues and renews certificates, so the
+      rotation schedule depends on your own configuration. See [Self-Hosted
+      requirements](../self-hosted/requirements.md).
 ---
 Certificate pinning is a security technique where a client validates a server's

package/docs/articles/check-ip-address.mdx CHANGED Viewed

@@ -7,6 +7,13 @@ description:
 tags:
   - request-handling
   - deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      The address is trustworthy only if the proxy you run overwrites the client
+      IP header. See [Self-hosted deployments](#self-hosted-deployments).
 ---
 To get the IP address of the client that made the current request, read it from
@@ -50,13 +57,13 @@ trustworthy or `undefined` — never one the caller chose.
 | Deployment        | Determined by                         | Trustworthy                              |
 | ----------------- | ------------------------------------- | ---------------------------------------- |
-| Zuplo Cloud       | The Zuplo edge                        | Yes                                      |
-| Zuplo Dedicated   | Your environment, configured by Zuplo | Yes                                      |
-| Self-hosted       | The proxy you run                     | Only if that proxy overwrites the header |
+| Managed Edge      | The Zuplo edge                        | Yes                                      |
+| Managed Dedicated | Your environment, configured by Zuplo | Yes                                      |
+| Self-Hosted       | The proxy you run                     | Only if that proxy overwrites the header |
 | Local development | Nothing — the caller is loopback      | Reports `127.0.0.1`                      |
-Zuplo Cloud and Zuplo Dedicated need no configuration. Self-hosted deployments
-depend on the proxy you run, covered in
+Managed Edge and Managed Dedicated need no configuration. Self-hosted
+deployments depend on the proxy you run, covered in
 [Self-hosted deployments](#self-hosted-deployments).
 :::caution
@@ -133,11 +140,12 @@ This works only if your CDN **overwrites** that header on every request. If it
 merely adds the header when absent, a caller can supply their own value and it
 passes straight through to your code.
-## Zuplo Dedicated
+## Managed Dedicated
-Zuplo configures your Dedicated environment to determine the client address, so
-there's nothing for you to set up. `context.incomingRequestProperties.ip`
-returns the caller's address the same way it does on Zuplo Cloud.
+Zuplo configures your Managed Dedicated environment to determine the client
+address, so there's nothing for you to set up.
+`context.incomingRequestProperties.ip` returns the caller's address the same way
+it does on Managed Edge.
 Dedicated environments aren't identical to one another — they differ by cloud,
 region, and what sits in front of the gateway, such as a CDN or WAF you already

package/docs/articles/ci-cd-azure/basic-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Azure Pipelines: Basic Deployment"
 sidebar_label: Basic Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 The simplest pipeline deploys your API to Zuplo on every push to main.

package/docs/articles/ci-cd-azure/deploy-and-test.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Azure Pipelines: Deploy and Test"
 sidebar_label: Deploy and Test
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Run your test suite against the deployed environment to validate changes.

package/docs/articles/ci-cd-azure/local-testing.mdx CHANGED Viewed

@@ -4,6 +4,14 @@ sidebar_label: Local testing in CI
 description:
   Start a local Zuplo dev server inside Azure Pipelines, poll it until it
   answers, run your test suite, and only deploy if every test passes.
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Test against a local Zuplo server before deploying anywhere.

package/docs/articles/ci-cd-azure/multi-stage-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Azure Pipelines: Multi-Stage Deployment"
 sidebar_label: Multi-Stage Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy to staging, test, then promote to production with approval.

package/docs/articles/ci-cd-azure/pr-preview-environments.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Azure Pipelines: PR Preview Environments"
 sidebar_label: PR Preview Environments
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../../cli/deploy.mdx).
 ---
 Deploy preview environments for pull requests and clean up when they close.

package/docs/articles/ci-cd-azure/tag-based-releases.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Azure Pipelines: Tag-Based Releases"
 sidebar_label: Tag-Based Releases
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy only when tags are pushed for controlled releases.

package/docs/articles/ci-cd-bitbucket/basic-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Bitbucket Pipelines: Basic Deployment"
 sidebar_label: Basic Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 The simplest pipeline deploys your API to Zuplo on every push to main.

package/docs/articles/ci-cd-bitbucket/deploy-and-test.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Bitbucket Pipelines: Deploy and Test"
 sidebar_label: Deploy and Test
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Run your test suite against the deployed environment to validate changes.

package/docs/articles/ci-cd-bitbucket/local-testing.mdx CHANGED Viewed

@@ -4,6 +4,14 @@ sidebar_label: Local testing in CI
 description:
   Start a local Zuplo dev server inside Bitbucket Pipelines, poll it until it
   answers, run your test suite, and only deploy if every test passes.
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Test against a local Zuplo server before deploying anywhere.

package/docs/articles/ci-cd-bitbucket/multi-stage-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Bitbucket Pipelines: Multi-Stage Deployment"
 sidebar_label: Multi-Stage Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy to staging, test, then promote to production with approval.

package/docs/articles/ci-cd-bitbucket/pr-preview-environments.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Bitbucket Pipelines: PR Preview Environments"
 sidebar_label: PR Preview Environments
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../../cli/deploy.mdx).
 ---
 Deploy preview environments for pull requests and clean up when they close.

package/docs/articles/ci-cd-bitbucket/tag-based-releases.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "Bitbucket Pipelines: Tag-Based Releases"
 sidebar_label: Tag-Based Releases
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy only when tags are pushed for controlled releases.

package/docs/articles/ci-cd-circleci/basic-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "CircleCI: Basic Deployment"
 sidebar_label: Basic Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 The simplest workflow deploys your API to Zuplo on every push to main.

package/docs/articles/ci-cd-circleci/deploy-and-test.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "CircleCI: Deploy and Test"
 sidebar_label: Deploy and Test
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Run your test suite against the deployed environment to validate changes.

package/docs/articles/ci-cd-circleci/local-testing.mdx CHANGED Viewed

@@ -4,6 +4,14 @@ sidebar_label: Local testing in CI
 description:
   Start a local Zuplo dev server inside CircleCI, poll it until it answers, run
   your test suite, and only deploy if every test passes.
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Test against a local Zuplo server before deploying anywhere.

package/docs/articles/ci-cd-circleci/multi-stage-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "CircleCI: Multi-Stage Deployment"
 sidebar_label: Multi-Stage Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy to staging, test, then promote to production with approval.

package/docs/articles/ci-cd-circleci/pr-preview-environments.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "CircleCI: PR Preview Environments"
 sidebar_label: PR Preview Environments
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` and `zuplo delete` command so it targets your cluster. See
+      [zuplo deploy](../../cli/deploy.mdx).
 ---
 Deploy preview environments for pull requests and clean up after tests.

package/docs/articles/ci-cd-circleci/tag-based-releases.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "CircleCI: Tag-Based Releases"
 sidebar_label: Tag-Based Releases
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 Deploy only when tags are pushed for controlled releases.

package/docs/articles/ci-cd-github/basic-deployment.mdx CHANGED Viewed

@@ -1,6 +1,14 @@
 ---
 title: "GitHub Actions: Basic Deployment"
 sidebar_label: Basic Deployment
+applies_to:
+  product: gateway
+  hosting: all
+  differs:
+    self-hosted: >-
+      Add `--self-hosted-endpoint` with your management API hostname to each
+      `zuplo deploy` command so it targets your cluster. See [zuplo
+      deploy](../../cli/deploy.mdx).
 ---
 The simplest workflow deploys your API to Zuplo on every push to main.