List middleware configs
Retrieve secret-safe middleware configuration summaries by lifecycle status and optional category. List responses intentionally omit destination URL, headers, basic-auth password, and HMAC secret; use find-by-ID when editing a single authenticated app-internal config.
query Parameters
statusMiddleware config status filter. Empty or not-deleted excludes deleted configs.
idCategoryOptional category ID to filter by
List middleware configs › Responses
List of middleware config summaries
idMiddlewareConfigmiddlewareConfigNamestatusdestinationTypedestinationMethodidCategoryCategory ID. Empty if uncategorized.
categoryNameFind middleware config by ID
Retrieve a middleware configuration by ID. User-facing REST read responses preserve editable destination headers and basic-auth username, but never return stored basic-auth password or HMAC secret values. When those secrets are set, the response returns hasBasicAuthPassword/hasHmacSecret plus a fixed placeholder value that clients may render as dots. To preserve a stored secret on save, send the placeholder, blank, or omitted secret value together with the matching hasBasicAuthPassword=true or hasHmacSecret=true flag.
query Parameters
idMiddlewareConfigThe ID of the middleware config
Find middleware config by ID › Responses
The requested middleware config
idMiddlewareConfigID of the middleware configuration
middlewareConfigNameMiddleware config's name.
Exactly one route must be marked isDefault. Non-default routes are evaluated in ascending priority order. Route idRoute values are stable lowercase keys and are also the user-facing labels.
schemaVersionMiddleware config schema version.
timeoutMsExecution timeout in milliseconds. The effective cap is plan-dependent (Middleware basic 10s, Middleware Pro 30s synchronous); values above the active plan's cap are clamped at execution time. Values above 30000 take effect only with loadingPage.enabled (detached execution, up to 60s).
descriptionidCategoryCategory ID. Empty if uncategorized.
statusResponse variable extraction (Middleware Pro). Validation here is shape-only; tier entitlement is enforced at Edge execution time.
Loading page shown while the middleware executes detached (Middleware Pro). When enabled, timeoutMs values up to 60000 take effect; the visitor is served an interstitial and continues to the destination when the middleware completes. Tier entitlement is enforced at Edge execution time.
Compliance gate on outbound middleware payloads (all plans). When enabled, restricted sections are reduced to their allow-listed keys before the request leaves Edge, so submitted PII (names, emails, ...) never reaches the middleware endpoint. dataBuffer governs the visitor-submitted data buffer - the payload's url_buffer section and action_data.injected_params.
Find middleware configs by ID list
Retrieve all middleware configurations with the specified IDs. User-facing REST read responses preserve editable destination headers and basic-auth username, but never return stored basic-auth password or HMAC secret values. When those secrets are set, each config returns hasBasicAuthPassword/hasHmacSecret plus the fixed placeholder value. To preserve a stored secret on save, send the placeholder, blank, or omitted secret value together with the matching hasBasicAuthPassword=true or hasHmacSecret=true flag.
query Parameters
idMiddlewareConfigsComma-separated middleware config IDs to retrieve
Find middleware configs by ID list › Responses
List of middleware configs with the specified IDs
idMiddlewareConfigID of the middleware configuration
middlewareConfigNameMiddleware config's name.
Exactly one route must be marked isDefault. Non-default routes are evaluated in ascending priority order. Route idRoute values are stable lowercase keys and are also the user-facing labels.
schemaVersionMiddleware config schema version.
timeoutMsExecution timeout in milliseconds. The effective cap is plan-dependent (Middleware basic 10s, Middleware Pro 30s synchronous); values above the active plan's cap are clamped at execution time. Values above 30000 take effect only with loadingPage.enabled (detached execution, up to 60s).
descriptionidCategoryCategory ID. Empty if uncategorized.
statusResponse variable extraction (Middleware Pro). Validation here is shape-only; tier entitlement is enforced at Edge execution time.
Loading page shown while the middleware executes detached (Middleware Pro). When enabled, timeoutMs values up to 60000 take effect; the visitor is served an interstitial and continues to the destination when the middleware completes. Tier entitlement is enforced at Edge execution time.
Compliance gate on outbound middleware payloads (all plans). When enabled, restricted sections are reduced to their allow-listed keys before the request leaves Edge, so submitted PII (names, emails, ...) never reaches the middleware endpoint. dataBuffer governs the visitor-submitted data buffer - the payload's url_buffer section and action_data.injected_params.
Save middleware config
Update an existing middleware configuration. The id cannot be changed. Middleware routes are evaluated in ascending non-default priority; exactly one default route is required for fallback.
Save middleware config › Request Body
idMiddlewareConfigID of the middleware configuration
middlewareConfigNameMiddleware config's name.
Exactly one route must be marked isDefault. Non-default routes are evaluated in ascending priority order. Route idRoute values are stable lowercase keys and are also the user-facing labels.
schemaVersionMiddleware config schema version.
timeoutMsExecution timeout in milliseconds. The effective cap is plan-dependent (Middleware basic 10s, Middleware Pro 30s synchronous); values above the active plan's cap are clamped at execution time. Values above 30000 take effect only with loadingPage.enabled (detached execution, up to 60s).
descriptionidCategoryCategory ID. Empty if uncategorized.
statusResponse variable extraction (Middleware Pro). Validation here is shape-only; tier entitlement is enforced at Edge execution time.
Loading page shown while the middleware executes detached (Middleware Pro). When enabled, timeoutMs values up to 60000 take effect; the visitor is served an interstitial and continues to the destination when the middleware completes. Tier entitlement is enforced at Edge execution time.
Compliance gate on outbound middleware payloads (all plans). When enabled, restricted sections are reduced to their allow-listed keys before the request leaves Edge, so submitted PII (names, emails, ...) never reaches the middleware endpoint. dataBuffer governs the visitor-submitted data buffer - the payload's url_buffer section and action_data.injected_params.
Save middleware config › Responses
Middleware config updated successfully
Create middleware config
Create a new middleware configuration. Middleware nodes synchronously call the configured destination during Edge traversal, evaluate the response, and select a route. Supported condition fields are status_code, body_text, and body_json.<path>.
Create middleware config › Request Body
idMiddlewareConfigID of the middleware configuration
middlewareConfigNameMiddleware config's name.
Exactly one route must be marked isDefault. Non-default routes are evaluated in ascending priority order. Route idRoute values are stable lowercase keys and are also the user-facing labels.
schemaVersionMiddleware config schema version.
timeoutMsExecution timeout in milliseconds. The effective cap is plan-dependent (Middleware basic 10s, Middleware Pro 30s synchronous); values above the active plan's cap are clamped at execution time. Values above 30000 take effect only with loadingPage.enabled (detached execution, up to 60s).
descriptionidCategoryCategory ID. Empty if uncategorized.
statusResponse variable extraction (Middleware Pro). Validation here is shape-only; tier entitlement is enforced at Edge execution time.
Loading page shown while the middleware executes detached (Middleware Pro). When enabled, timeoutMs values up to 60000 take effect; the visitor is served an interstitial and continues to the destination when the middleware completes. Tier entitlement is enforced at Edge execution time.
Compliance gate on outbound middleware payloads (all plans). When enabled, restricted sections are reduced to their allow-listed keys before the request leaves Edge, so submitted PII (names, emails, ...) never reaches the middleware endpoint. dataBuffer governs the visitor-submitted data buffer - the payload's url_buffer section and action_data.injected_params.
Create middleware config › Responses
Middleware config created successfully
Duplicate middleware config
Create duplicate of existing middleware configuration.
query Parameters
idMiddlewareConfigID of the middleware config to duplicate.
Duplicate middleware config › Request Body
nameName for the new asset
parentIdOptional parent/category ID for the new asset
Optional field overrides to merge into the duplicated asset. Keys are JSON field names (e.g. baseURL, trackingFieldSlots). Protected fields (ID, owner, status) cannot be changed via this field — they are always set by the server after the merge.
Duplicate middleware config › Responses
Middleware config duplicated successfully
idID of the newly created asset