> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Client variables

> Learn more about configurable client variables.

## GATEWAY\_CLIENT\_CERTIFICATE\_FILE

The full path to the certificate file that the gateway client uses when it communicates with a gateway server. Required when `GATEWAY_CLIENT_USE_TLS` is enabled.

### Environment Variable

`GATEWAY_CLIENT_CERTIFICATE_FILE`

### File

**Section:** `client`

**Key:** `certificate_file`

### Default

No default value provided

---

## GATEWAY\_CLIENT\_HOST

The host address of a gateway server that a gateway client connects to when you set `GATEWAY_APPLICATION_MODE` to `client`.

### Environment Variable

`GATEWAY_CLIENT_HOST`

### File

**Section:** `client`

**Key:** `host`

### Default

No default value provided

---

## GATEWAY\_CLIENT\_PORT

The port of a gateway server that a gateway client connects to.

### Environment Variable

`GATEWAY_CLIENT_PORT`

### File

**Section:** `client`

**Key:** `port`

### Default

`50051`

---

## GATEWAY\_CLIENT\_PRIVATE\_KEY\_FILE

The full path to the private key file that the gateway client uses when it
connects to a gateway server. Required when `GATEWAY_CLIENT_USE_TLS` is enabled.

### Environment Variable

`GATEWAY_CLIENT_PRIVATE_KEY_FILE`

### File

**Section:** `client`

**Key:** `private_key_file`

### Default

No default value provided

---

## GATEWAY\_CLIENT\_\<PROFILE>\_\<SETTING>

Gateway 5.4+

Overrides an individual setting for a named client profile. `<PROFILE>` is the uppercase profile name and `<SETTING>` is the uppercase setting name — for example, `GATEWAY_CLIENT_PRODUCTION_HOST` overrides the `host` setting for the `production` profile.

The following settings are supported:

| Setting            | Environment variable suffix |
| ------------------ | --------------------------- |
| `host`             | `_HOST`                     |
| `port`             | `_PORT`                     |
| `api_key`          | `_API_KEY`                  |
| `certificate_file` | `_CERTIFICATE_FILE`         |
| `private_key_file` | `_PRIVATE_KEY_FILE`         |
| `use_tls`          | `_USE_TLS`                  |

Profile-specific environment variables take precedence over all other configuration sources for the given setting. For full precedence rules and profile configuration, see [Configure client profiles](./configure-client-profiles).

### Examples

```bash
# Override host for the production profile
export GATEWAY_CLIENT_PRODUCTION_HOST=gw.prod-us-east.example.com
 
# Override port for the staging profile
export GATEWAY_CLIENT_STAGING_PORT=50052
```

---

## GATEWAY\_CLIENT\_USE\_TLS

Determines whether a gateway client uses TLS when it connects to a gateway
server.

### Environment Variable

`GATEWAY_CLIENT_USE_TLS`

### File

**Section:** `client`

**Key:** `use_tls`

### Default

`true`