egress
The egress namespace — the engine's Luau API reference for egress.
The egress namespace — 5 functions.
globals/egress/clearCredential
globals/egress/clearCredential(name: string) -> boolean
TRUSTED ONLY. Remove a named credential.
globals/egress/credentialNames
globals/egress/credentialNames() -> { string }
List the names of configured credentials. Names only — secret values are never exposed to Luau.
globals/egress/fetch
globals/egress/fetch(name: string, method: string, url: string, headers: Headers?, body: JsonBody?, response: EgressResponseType?) -> string?
Perform an HTTP request with a named credential injected
server-side (in Rust). Returns a promise handle for
task.await(), or nil when the credential is unknown or url
is outside the credential's allowed base_url. The secret is
never exposed to Luau. This is the seam that production points
at the ZeroMind egress endpoint.
globals/egress/hasCredential
globals/egress/hasCredential(name: string) -> boolean
Whether a named credential is configured. Returns only a boolean — never the value. Service handlers use this to fail with a clear "not configured" message.
globals/egress/setCredential
globals/egress/setCredential(name: string, base_url: string, header_name: string, header_value: string) -> boolean
TRUSTED ONLY. Register a named credential whose header is
injected into matching egress.fetch calls. The value is held
in Rust and never returned to Luau.