Skip to content

Configure Payload Capture

In the Payload Capture section of the Admin Console, you can configure Global Data Capture settings that apply to all managed API environments on the Yappes platform.

This is the first step in enabling payload capture across your organization. API Manager users cannot create Payload Capture gateway policies until Enable Payload is turned on here.

Overview

Global Data Capture controls whether payload capture is active platform-wide and defines the limits that apply to all captured data:

  • Whether payload capture is enabled
  • Maximum payload size that can be stored
  • How long captured data is retained before automatic purge
  • Default field names to mask in all captured payloads

Payloads are captured exclusively for authentication requests and error scenarios, with data automatically purged once the maximum retention period is exceeded.

Prerequisites

Before configuring Payload Capture, ensure you have:

  • Access to the Admin Console
  • An understanding of your organization's data retention and privacy requirements
  • Open the Admin Console
  • Select Payload from the sidebar
  • The Configure Global Data Capture page opens

Configuration Fields

UI Label Description Required Validation
Enable Payload Turns payload capture on or off for the entire platform. Once enabled, capture applies only to APIs with the policy attached. — Confirmation modal appears when turning off
Max Payload capture size (MB) Maximum size of a single captured payload in megabytes Yes Non-zero whole number
Data Retention Duration Number of days captured payloads are retained before automatic purge Yes Non-zero whole number (days)
Default Masking Fields JSON field names or paths masked in all captured payloads (e.g. email, password) Optional No spaces; max 64 characters per tag; pre-configured default tags cannot be removed

Note

Default masking fields configured here apply platform-wide. API managers can add additional masked fields per endpoint when creating a Payload Capture policy.

Step-by-Step Configuration

  1. Open the Admin Console and navigate to Payload in the sidebar.
  2. Review the information banner describing capture scope (authentication requests and error scenarios) and automatic data purge.
  3. Toggle Enable Payload to turn the feature on or off.
  4. Enter Max Payload capture size (MB) (e.g. 5).
  5. Enter Data Retention Duration in days (e.g. 15).
  6. Add Default Masking Fields as needed — type a field name and press Enter to save it as a tag.
  7. Click Save to apply the settings.

Disabling Payload Capture

When you turn off Enable Payload, a confirmation modal appears:

"Disabling this will stop all payload capture. Existing policies will no longer collect data, and new policies cannot be created."

  • Click Cancel to keep payload capture enabled.
  • Click Save to confirm and disable capture.

Impact of Changes

When Payload Capture is enabled

When Payload Capture is disabled

  • All payload capture stops immediately — existing policies no longer collect data.
  • New Payload Capture policies cannot be created in API Manager.
  • Existing policy configurations are preserved but inactive until the feature is re-enabled.

Verification

After saving settings:

  • Confirm Enable Payload reflects your intended state.
  • In API Manager, verify that the Payload Capture option is available (or blocked) on endpoint configuration as expected.
  • After attaching endpoint policies, confirm captured entries appear on the Payload dashboard.

Troubleshooting

Issue Possible Cause Resolution
Cannot create Payload Capture policy in API Manager Enable Payload is off Turn on Enable Payload and click Save
Save button does nothing No values were changed Modify at least one field before saving
Validation error on size or retention Non-numeric or zero value entered Enter a non-zero whole number
Masking field rejected Spaces or invalid characters in tag Use variable-style names (e.g. emailId, user_name)