FirelinksInstall

Summary

Create a cloaking link by configuring an offer URL, a white page URL to display filtered traffic, domain, cloaking mode, and multiple filter criteria to control when the white page is shown.

Inputs

• Offer URL (required) — Main offer page link to which traffic will be directed if not cloaked.
• White Page URL (required) — URL of a white page shown instead of the main offer for filtered traffic.
• Domain ID (required) — Identifier of your or Premium domain under which the cloaking link is created.
• Cloaking Mode (required) — Specifies how the white page is shown: either by loading the page or redirecting to it.
• Filters (required) — Select filters applied for checking visitor traffic (e.g., main filter, IPv6, VPN/Proxy, no referrer).
• Country Filter Status (required) — Enable and configure country-based filtering to allow or disallow traffic from specified ISO country codes.
• Country List — Comma-separated ISO country codes for country filtering, used when country filter is enabled.
• IP Filter Status (required) — Enable and configure IP-based filtering to allow or disallow traffic from specified IP addresses or ranges.
• IP List — Comma-separated list of IP addresses or networks for IP filtering.
• ISP Filter Status (required) — Enable and configure ISP-based filtering to allow or disallow traffic from specified internet service providers.
• ISP List — Comma-separated list of ISPs for filtering traffic.
• Referer Filter Status (required) — Enable and configure referer-based filtering to allow or disallow traffic originating from specific referers.
• Referer List — Comma-separated list of referer domains or values for filtering.
• User Agent Filter Status (required) — Enable and configure User Agent based filtering to allow or disallow traffic from specified user agents.
• User Agent List — Comma-separated list of user agent strings or fragments to filter.
• OS Filters — List of operating systems on which to display the white page.
• Additional Fields — Optional settings including whether to replace all links on page load, custom short code, group ID, keywords with matching mode, link name, and monetization flag.

Output shape

a single record representing the created cloaking link's data.

Returns the created link's details as JSON. The response includes all configured cloaking options and identifiers. Errors are returned in NodeApiError format if creation fails.

Examples

Example 1: Create a cloaking link with offer URL, white page URL, domain ID, cloaking mode (redirect), and main filter only.

Set offer URL to 'https://offer.com', white page URL to 'https://whitepage.com', domain ID to your domain's ID, cloaking mode to Redirect, and select only 'Main Filter'.

Example 2: Create a cloaking link with country disallow filter for US and RU, and enabling monetization.

Set country filter status to Disallow, add 'US,RU' in country filter list, set monetization flag to true in additional fields, and configure required URLs and domain ID accordingly.