For the complete documentation index, see llms.txt. This page is also available as Markdown.

GetLocalhostIp

Returns the localhost IP address (string), or all local IP addresses (array) if the 'all' argument is set to true.

The lookup for ALL IP addresses is cached by default, but can be forced to refresh with the 'refresh' argument. The 'refresh' argument will clear the cache and perform a new lookup, when called with 'all' set to true.

Method Signature

GetLocalhostIp(all=[boolean], refresh=[boolean])

Arguments

Argument
Type
Required
Description
Default

all

boolean

false

(optional, boolean) If true, returns an array of all local IP addresses. Default is false (returns only the primary local IP).

false

refresh

boolean

false

(optional, boolean) If true, forces a refresh of the local IP address cache. Default is false (uses cached value if available).

false

Examples

Get the localhost IP address

ip = getLocalhostIp();
writeOutput( isString( ip ) );

Result: true

  • HTTP

  • SOAP

Last updated

Was this helpful?