> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fluid.app/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract.
> Authenticate with the header Authorization: Bearer <token>; public storefront read endpoints require no auth.
> To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token.
> After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch.
> Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null.
> When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors.
> Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile.
> The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country).
> api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract).
> Successful responses wrap the resource payload alongside a top-level integer status and a meta object.
> Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other.
> For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces.
> Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings.
> Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties.
> Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables.
> A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation.
> The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations.
> Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check.
> Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times.

# Egress proxy

> Give your Mist app a fixed outbound IP address, so it can reach Exigo's API and SQL replicas, which only accept allowlisted addresses.

Exigo accepts calls only from IP addresses each tenant has allowlisted. A Mist app runs on Vercel, where the outbound address changes, so no tenant can allowlist it. Fluid's egress proxy lends your app a fixed outbound address that Exigo tenants can allowlist.

The proxy only opens a tunnel. The TLS connection runs from your app to Exigo through it, so the proxy never sees your Exigo credentials or the data you exchange.

## What the proxy reaches

* **Exigo's REST API:** any subdomain of `exigo.com`, on port 443. The bare `exigo.com` host is refused.
* **Exigo-hosted SQL replicas:** port 1433, matched by the address the host name resolves to, not by the name itself. This covers Exigo's own networks and Exigo's shared Azure SQL server, including the aliases that point to it.

The proxy refuses every other host and port. Two consequences:

* A replica host name that doesn't resolve to one of Exigo's addresses is refused with a `403`.
* The proxy refuses IP addresses as destinations. Connect to a host name and a port.

## Before you start

* Your Mist app has a droplet attached. See [Integration points](/mist-apps/integration-points).
* You're an admin of the company that owns the droplet, or you use a company service token of that company.
* The Exigo tenant has allowlisted all four of Fluid's egress addresses, for both the API and the SQL replica:

  | Address | Used |
  | - | - |
  | `34.59.103.199` | Now |
  | `34.171.199.225` | Now |
  | `34.144.173.17` | After the proxy moves to its new region |
  | `34.174.57.210` | After the proxy moves to its new region |

  Fluid is moving the proxy to a new region, and the move has no date yet. Until it moves, Exigo sees only the first two addresses. Allowlist all four now, so calls keep working through the move. Fluid will update this page when the first two can be removed.

## Turn on the egress proxy

Turn it on with any of these:

* **CLI, on an existing app:** run `fluid mist droplet egress-proxy on` from the app's folder, or pass the app's slug: `fluid mist droplet egress-proxy on spring-bonus`.
* **CLI, when you add the droplet:** add `--egress-proxy` to `fluid mist create` with a droplet, or to `fluid mist attach --kind droplet`.
* **Mist:** check the egress option when you add or edit the droplet in the integration point dialog. The option shows when your company has it.
* **Admin:** open the droplet's settings, and under **Network Access**, check **Let this droplet reach external systems (e.g. Exigo) through Fluid's egress proxy**.

The proxy lets the droplet through once egress is on, with no further approval. To turn it off, run `fluid mist droplet egress-proxy off`, or uncheck the option.

Only an admin of the company that owns the droplet, or a company service token of that company, can turn egress on. For anyone else, the API refuses the change. The CLI's `--egress-proxy` adds the droplet without egress and prints a warning. Admin and Mist don't show the option.

### How long a change takes

The proxy keeps each droplet's answer for a short time:

* After you turn egress on, new connections can still be refused for up to a minute.
* After you turn egress off, new connections are refused within a minute.

In both cases, if the proxy can't reach Fluid, it keeps using its last answer for up to five more minutes.

Connections that are already open keep running until they close.

## Use the proxy from your app

Fluid sets `FLUID_EGRESS_PROXY_URL` on your app when you add a droplet, in environments that have an egress proxy. The variable is set whether egress is on or not, so it doesn't mean egress is on: until it is, the proxy answers `403`. A Mist app whose droplet was added before the proxy existed doesn't have the variable. Add the droplet again to get it.

Your app authenticates to the proxy with the installation's droplet installation token, which starts with `dit_`. See [Authentication](/mist-apps/authentication#the-droplet-install-flow) for where the token comes from.

With the [Exigo connection SDK](/sdk/exigo-sdk), pass both to the REST client and the SQL pool:

```ts theme={null}
import { createExigoRestClient } from "@fluid-app/exigo-connection-sdk/rest";
import { getExigoPool } from "@fluid-app/exigo-connection-sdk/sql";
import { resolveFluidInstallation } from "@/lib/fluid/installation-context";
// Defined once per app: see the SDK's "Define the credentials".
import { resolveExigoCredentials } from "@/lib/exigo";

// Authorize the caller first. See the warning below.
const { installation, companyId } = await resolveFluidInstallation(request);
const { rest, sql } = await resolveExigoCredentials(String(companyId));

const egressProxy = process.env.FLUID_EGRESS_PROXY_URL
  ? {
      url: process.env.FLUID_EGRESS_PROXY_URL,
      token: installation.authenticationToken,
    }
  : undefined;

const exigo = createExigoRestClient(rest, { egressProxy });
const pool = await getExigoPool(sql, { egressProxy });
```

> [!WARNING]
>
> `resolveFluidInstallation` finds the installation from the `x-fluid-droplet-installation` header. It doesn't authenticate whoever sent the request. Before a route loads a company's Exigo credentials, check that the caller may act for that company, for example with a [session token](/mist-apps/authentication#viewer-identity-with-session-tokens).

Without the SDK, use any HTTP client that supports an HTTPS `CONNECT` proxy, and send the token on the proxy request:

```http theme={null}
Proxy-Authorization: Bearer dit_9XcT3vMq7LpW2nRb5KsZ8hJf
```

The proxy URL is always `https`, because the token travels outside the tunnel.

### Local runs

`fluid mist env pull` doesn't include `FLUID_EGRESS_PROXY_URL`, so a local run calls Exigo directly from your own IP address. The code above does that when the variable isn't set. To test the proxied path, deploy the app.

## When the proxy refuses

The Exigo connection SDK throws `ExigoProxyError`, whose `status` is the proxy's answer:

| Status | Meaning | What to do |
| - | - | - |
| `407` | The proxy doesn't accept the token. | Send the installation's `dit_` token. The installation must still be active. |
| `403` | The proxy doesn't let this droplet or this host through. | Turn on the egress proxy for the droplet, and check that the host is one [the proxy reaches](#what-the-proxy-reaches). |
| `502` or `504` | The proxy couldn't reach the host. | Check the host name and port. |
| `503` | The proxy couldn't verify the token, is at capacity, or is limiting your rate of connections. | Retry after a short wait. |

If the proxy lets you through but Exigo still refuses the call, one common cause is that the Exigo tenant hasn't allowlisted [Fluid's egress addresses](#before-you-start) for that service. The API and the SQL replica are allowlisted separately. Wrong Exigo credentials look similar: the SDK throws `ExigoAuthError`.

## Related pages

* [Exigo connection SDK](/sdk/exigo-sdk): call Exigo's API and query its SQL replica.
* [Hosting](/mist-apps/hosting): the environment variables Fluid sets on your app.
* [Integration points](/mist-apps/integration-points): attach a droplet to your Mist app.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.