Frequently asked questions¶
Which Unreal Engine versions are supported?¶
API Lens 1.0.1 supports Unreal Engine 5.6, 5.7, and 5.8 on Windows 64-bit. Install the package matching your Engine minor version.
Does API Lens work in packaged games?¶
No. API Lens is an Editor-only debugging tool for Unreal Editor and Play in Editor. It is not intended to run in a packaged or shipping build.
Does it require an external proxy?¶
No. API Lens displays supported Unreal HTTP activity directly inside the editor, so a separate proxy is not required for its normal workflow.
What information can I inspect?¶
You can inspect method, sanitized destination, status, duration, headers, bounded request and response previews, JSON content, and PIE-session context.
How does API Lens protect sensitive information?¶
Capture is off by default, history is kept in bounded memory, and recognized sensitive values in structured content are redacted before retention by default. URL paths and free-form text still require manual review.
Can I switch between REDACTED and RAW captures?¶
Yes. Check or uncheck Redact Sensitive Values in Project Settings → Plugins → API Lens → Privacy, then stop and start capture before reproducing the request. Checked is the safer default; unchecked retains original values that may include working credentials. The choice affects new records only: switching it back on does not sanitize older Raw captures, so the badge may still show RAW until you clear that history. See Turn redaction on or off before copying or exporting them.
Can it coexist with another HTTP monitoring plugin?¶
It depends on how that plugin observes traffic. API Lens uses an exclusive global Unreal HTTP callback while capture is active, so another consumer of the same callback can conflict with it.
Why can I not replay a request immediately?¶
One-click replay is withheld when a request contains missing or redacted values or uses a method that can change server data. Use Edit and resend to review the request first.
Where can I get help?¶
Open a GitLab Work item with your API Lens and Unreal Engine versions, reproduction steps, and sanitized logs. Never include credentials or unredacted private data in a public report.