Egress

Read and update runtime outbound network policy.

EgressManager declaration

class EgressManager

EgressManager access

This type is created by the SDK; do not construct it directly.

const manager = runtime.egress;

EgressManager methods

get()

Return the cached egress policy.

EgressManager.get(): Promise<EgressPolicy>

Returns

• Promise<EgressPolicy>

setPolicy()

Replace the complete egress policy and return refreshed runtime metadata.

EgressManager.setPolicy(policy: EgressPolicy): Promise<RuntimeInfo>

Parameters

Name	Type	Default	Description
policy	EgressPolicy	Required	Egress policy to apply.

Returns

• Promise<RuntimeInfo>

Examples

await runtime.egress.setPolicy({
  mode: "allowlist",
  allowedHosts: ["api.github.com"],
  deniedHosts: [],
});

EgressPolicy

Describes which outbound hosts a runtime may or may not reach.

EgressPolicy declaration

interface EgressPolicy

EgressPolicy properties

Name	Type	Description
allowedHosts	string[]	Hosts explicitly allowed by the policy.
deniedHosts	string[]	Hosts explicitly denied by the policy.
mode	EgressMode	Whether the policy uses an allowlist or denylist.