> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/net/getlocalhostip.md).

# 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

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

```

Result: true

## Related

* [HTTP](/boxlang-language/reference/built-in-functions/net/http.md)
* [SOAP](/boxlang-language/reference/built-in-functions/net/soap.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/net/getlocalhostip.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.