Skip to main content

Create a Proxy

The proxy wizard walks you through all six steps needed to configure an endpoint — from route definition to schema and review.

Open a collection and click Add Proxy to start the wizard.

Step 1 — Info​

Set the basic identity for this proxy:

  • Name — descriptive label shown in the UI and Developer Portal (e.g. List Charges)
  • Description — appears in portal endpoint listings and the OpenAPI export
  • Tags (optional) — used for filtering in large collections

Step 2 — Route​

Define how requests are matched and where they're forwarded:

FieldDescriptionExample
HTTP MethodOne or more methods this proxy handlesGET, POST
Incoming PathPath pattern appended to the collection base path/v1/charges
Target PathPath forwarded to the upstream/charges
StreamingEnable SSE / chunked streaming pass-throughToggle on for event streams

The Streaming flag, when enabled:

  • Bypasses response buffering, cache, and ETag middleware
  • Streams the upstream response directly to the client
  • Shown as a Streaming badge on proxy cards in the collection view
  • Required for Server-Sent Events (SSE) and any chunked response API

Wildcard paths — use * at the end to match arbitrary suffixes:

  • Incoming: /files/* → captures /files/a/b/c.txt
  • Target: /v1/storage/* → forwards the same suffix to upstream

Step 3 — Headers​

Add HTTP headers to inject into every upstream request:

ModeBehaviourUI badge
StaticLiteral value sent on every requestPurple badge
Env VarValue read from a named container environment variable at runtimeBlue badge

Env Var mode lets you inject secrets (API keys, tokens) without storing them in the database. Set the environment variable on the gateway container, then reference it by name.

Proxy-level credential override — if you attach a credential here, it overrides the collection-level credential for this endpoint only. This lets you route different endpoints to different upstream auth schemes within the same collection.

Step 4 — Parameters​

Define path and query parameters for documentation, validation, and portal display:

FieldDescription
NameParameter identifier used in path or query string
Inpath or query
Typestring, integer, boolean, number
RequiredWhether the parameter must be present
DescriptionShown in portal endpoint details
DefaultDefault value for optional query parameters
EnumComma-separated list of allowed values

When you define an enum list on a query parameter, the Developer Portal testing console renders that parameter as a dropdown <select> instead of a free-text input — making it harder for consumers to send invalid values.

Step 5 — Schema​

Add JSON Schema (draft-07) definitions for request and response bodies:

  • Request Schema — validates inbound request bodies; rejects malformed payloads with 400 Bad Request
  • Response Schema — documents the expected response shape; included in OpenAPI export
  • Request Example — sample body shown in portal docs
  • Response Example — sample response shown in portal docs

Schemas and examples populate both the Developer Portal documentation and the OpenAPI 3.0/3.1 download automatically.

Step 6 — Review​

Confirm all settings before saving:

  • Review route, headers, parameters, and schemas
  • Click Save as Draft to save without publishing
  • Click Save and Publish to go live immediately (collection must also be published)

After saving​

The proxy appears in the collection's proxy list with its current status badge:

  • Draft — saved but not live
  • Published — live on the gateway
  • Streaming badge — streaming mode enabled

Use the Publish toggle on the proxy row to change status at any time. You can also select multiple proxies and use Publish All / Unpublish All / Delete for bulk operations.