Introducing and Using BYOE

BYOE stands for Bring Your Own Egress. It lets you attach your own outbound proxy connector to a node in your service, so traffic for that node exits through the connector you provide instead of the platform's default egress path.

This feature is intended for advanced users who already operate a stable outbound proxy endpoint. In our client area, a BYOE connector profile can be created, saved for later use, and optionally bound to one service node.

Important behavior If a bound BYOE connector becomes unavailable, egress traffic for that binding is blocked until the connector becomes reachable again. In the client area, this may appear as a Fail-closed runtime status.

1. Before You Start

  • Your service must include at least one BYOE slot. If your plan does not include BYOE, the BYOE section will not be available.
  • You need a working outbound proxy endpoint that supports either SOCKS5 or HTTP-compatible connections.
  • The connector host must be a valid public hostname or public IP address. Private IPs, reserved IPs, and local-only names such as localhost are not accepted.
  • Authentication is optional. If your connector requires credentials, prepare the username and password before you begin.

2. Core BYOE Concepts

Term Meaning
BYOE slot How many BYOE profiles your service is allowed to store.
BYOE profile One saved connector configuration, including type, host, port, and optional authentication.
Bound node The service node currently using that BYOE profile for egress.
Unbound The BYOE profile is saved but is not attached to any node yet.
Runtime Status The latest health state reported for that BYOE profile, shown as Available, Unknown, or Fail-closed.

A single node can only have one active BYOE binding at a time. If you bind a new BYOE profile to a node that already has one, the old binding is replaced automatically.


3. How to Create a BYOE Profile

  1. Log into your Client Area and open your Product Details Page.
  2. Open the BYOE section.
  3. Click Add BYOE Profile.
  4. Select the connector type: SOCKS5-compatible or HTTP-compatible.
  5. Enter the connector host and port.
  6. If required, enter the username and password.
  7. Optionally select a node now, or leave the profile as Unbound.
  8. Click Create.

After the profile is created, it appears in the BYOE list together with its current bound node and runtime status.


4. How Node Binding Works

  • Binding is done at the node level, not at the entire service level.
  • A BYOE profile can remain saved without being bound to any node.
  • When selecting a node, the interface shows the expected binding impact so you can confirm what will be affected.
  • If another BYOE profile is already bound to the selected node, the new binding replaces the previous one automatically.
  • Changes are not always instantaneous. Connector updates and binding changes apply after the next platform sync.

5. How to Edit, Rebind, or Unbind a Profile

  1. Open the BYOE list in your product details page.
  2. Click View Details for the profile you want to manage.
  3. Update the connector type, host, port, or username as needed.
  4. If you want to keep the current password, leave the password field empty.
  5. To move the profile to another node, select a different node in the binding section.
  6. To remove the node binding while keeping the connector settings, select Unbound.
  7. Click Save.

This page also shows the latest Runtime Status and Last Seen (UTC) values reported for the profile.


6. How to Delete a BYOE Profile

  1. Open BYOE and enter the profile's View Details page.
  2. Click Delete.
  3. Confirm the deletion when prompted.

Deleting a BYOE profile permanently removes that saved connector profile from your service.


7. Understanding Runtime Status

  • Available: The platform recently confirmed that the bound connector is reachable.
  • Unknown: No recent runtime state is available yet, or the last report is stale.
  • Fail-closed: The connector is currently not usable, and egress traffic for that binding is blocked until the connector recovers.
Troubleshooting tip If you see Fail-closed, first verify that your connector host is public and reachable, the port is correct, and any required authentication credentials are still valid.

8. Important Notes and Limitations

  • BYOE is available only when your plan includes one or more BYOE slots.
  • Supported connector types are limited to SOCKS5 and HTTP-compatible.
  • Connector host validation is strict. Local addresses and non-public IP space are rejected.
  • One node can use only one BYOE profile at a time.
  • When a service is migrated between regions, existing BYOE bindings may be cleared and need to be reviewed again afterward.
  • Changes to BYOE settings are operationally sensitive. Always verify connectivity after updating a bound connector.


Was this article helpful?

mood_bad Dislike 573
mood Like 361
visibility Views: 15290