- To deploy a gateway for your organization, see Roll out an LLM gateway
- For what Claude Code sends to a gateway, see the gateway protocol reference
Check for an existing configuration
Administrators can distribute the gateway address and credential through managed settings, device management, or anapiKeyHelper, so Claude Code picks them up at startup with nothing for you to set. To check whether your organization already did this:
1
Start Claude Code
Run
claude. If it opens to the login screen instead of a session, no gateway credential was distributed; configure it yourself below.2
Check the Status tab
If Claude Code started a session without showing the login screen, run
/status, which opens on the Status tab, and check two lines:Anthropic base URL: this line only appears when a gateway address is set. If it isn’t there, Claude Code isn’t pointed at the gateway; configure it yourself below.Auth tokenorAPI key: a line namingANTHROPIC_AUTH_TOKEN,ANTHROPIC_API_KEY, or anapiKeyHelperconfirms a gateway credential is active. ALogin methodline naming a claude.ai account instead means the credential wasn’t distributed; set it yourself.
3
Send a test message
Close the
/status menu and send any prompt in Claude Code. A normal response from Claude, with no error, confirms the gateway connection works./status menu look right but the message to Claude fails, see the troubleshooting table.
Configure Claude Code yourself
To configure Claude Code for the gateway yourself, you need from your gateway team:- The gateway’s base URL
- A credential: a key or token string, or a command that fetches one
- If your gateway team didn’t say which kind of credential it is, the credential variable section below covers what to try
- Set the credential variable and set the base URL: the two variables every gateway connection needs
- Verify the connection: confirm it works before persisting anything
- Configure each surface: if you are using a surface besides the Claude Code CLI, such as VS Code, see how to configure it with your gateway credentials
- Additional configuration: variables some gateways need beyond the base URL and credential, such as a custom header, a credential helper, model discovery, a provider-format base URL, or turning off traffic outside the gateway path. Set these only if your administrator named them or your network restricts egress
Set the credential variable
To authenticate Claude Code to the gateway, set your credential in an environment variable. Which variable depends on what your gateway team told you:
If you weren’t told which kind, use
ANTHROPIC_AUTH_TOKEN; the verification request below shows how to tell if you need to switch.
Set the base URL and credential
Set the gateway’s base URL and the credential variable you picked above as environment variables. The examples useANTHROPIC_AUTH_TOKEN; swap it for ANTHROPIC_API_KEY if that’s the variable you picked. You can set them in your shell, which lasts for one terminal session, or in a Claude Code settings file, which persists everywhere Claude Code runs.
For your first connection, start with shell exports and run the verification request before moving the values to a settings file.
Set as shell environment variables
Replace the values with the ones your gateway team gave you:- Bash or Zsh
- PowerShell
~/.zshrc, ~/.bashrc, or your PowerShell $PROFILE.
If you export the gateway only in your shell, it doesn’t reliably reach background agents hosted by the supervisor; see how each background session sources its gateway. Use a settings file for any gateway that background agents must always route through.
Set in a settings file
To make the configuration apply everywhere Claude Code runs, including background agents, set the variables in theenv block of a settings file instead of relying on your shell. Settings files have different scopes:
~/.claude/settings.jsonapplies to all your projects. On Windows the path is%USERPROFILE%\.claude\settings.json.claude/settings.local.jsonapplies to one project. Claude Code adds it to your gitignore when it creates the file; if you create it yourself, add it to your gitignore manually first so you don’t accidentally commit your credential
env block looks the same in either file:
env block set the same variable, the settings-file value applies. Run /status to see which base URL and credential source Claude Code is using.
Verify the connection
With the variables exported in your shell, send a one-token request to the gateway directly. This confirms the URL and credential work before you open Claude Code, so a failure points at the gateway rather than your configuration. The commands below read the shell variables, so they need the shell exports even if you also put the values in a settings file.- Bash or Zsh
- PowerShell
x-api-key header, replace the Authorization header with x-api-key: $ANTHROPIC_API_KEY in the Bash command, or the "Authorization" hashtable entry with "x-api-key" = "$env:ANTHROPIC_API_KEY" in the PowerShell command.
A JSON response that starts with {"id":"msg_ and includes a "content":[...] field means the gateway is reachable and the credential works. An error naming an unknown model still proves the URL and credential work, since the gateway authenticated the request before rejecting the model name; you don’t need to find a model your gateway serves for this test. A 401 means the credential was rejected: if you guessed the variable, switch to the other one and re-export.
Confirm in Claude Code
Startclaude from the same shell so it inherits the exports, send a message, and run /status.
On the Status tab, the Anthropic base URL line should show your gateway address, which confirms requests are routing there; if the line isn’t there, the variable didn’t reach the session. An Auth token or API key line naming the variable you set confirms the gateway credential is active rather than a saved claude.ai login.
If the message fails, or /status doesn’t show the gateway URL, see the troubleshooting table below.
How the credential variable maps to a header
Each variable sends the credential in a different HTTP header:ANTHROPIC_AUTH_TOKEN in Authorization: Bearer, ANTHROPIC_API_KEY in x-api-key, and apiKeyHelper in both. A credential in the wrong variable reaches the gateway in a header it doesn’t read, and the request fails with 401. If the verification request returned 401, switch to the other variable and try again.
Conflicts with an existing login
A gateway credential variable takes precedence over a saved claude.ai login or Console key. Your claude.ai login stays saved and unused while the variable is set; unset the variable and Claude Code goes back to it. WithANTHROPIC_AUTH_TOKEN, the variable takes precedence immediately. With ANTHROPIC_API_KEY, you are prompted once in interactive mode to approve the key before it takes over.
Run /status to confirm which credential source is active. If startup shows an auth-conflict warning naming two sources, see the first row of the troubleshooting table for which one to drop. To clear a saved login so only the gateway credential remains, run /logout.
Configure each surface
The CLI reads the environment variables and settings files above. The other surfaces are the VS Code extension, the desktop app, GitHub Actions, the Agent SDK, and the cloud surfaces such as Slack and the web; the sections below cover whether those settings reach each one.VS Code extension
Set the gateway variables for the VS Code extension inclaudeCode.environmentVariables, in VS Code’s own user settings opened with the Preferences: Open User Settings (JSON) command. The extension checks credentials from this setting before launching, so it’s the reliable place for the gateway credential; values in ~/.claude/settings.json reach the spawned process but not the extension’s own login check.
Desktop app
The desktop app reads gateway routing from its third-party inference configuration, not fromANTHROPIC_BASE_URL or settings.json. That configuration can come from your organization or from a form in the app itself:
- Distributed by an administrator: if your organization has deployed the configuration, the desktop app routes through the gateway with no setup on your part
- Configured locally: for devices without an administrator-distributed configuration, open Help → Troubleshooting → Enable Developer Mode, which restarts the app with a Developer menu. Then open Developer → Configure Third-Party Inference and enter your gateway base URL. An administrator-distributed configuration takes precedence and makes this form read-only
ANTHROPIC_BASE_URL and the gateway credential set there.
If the desktop app shows Gateway was unreachable, the app couldn’t reach the configured base URL at startup; check the URL and network path with the curl test above.
GitHub Actions
Claude Code GitHub Actions readsANTHROPIC_BASE_URL and ANTHROPIC_CUSTOM_HEADERS from the workflow’s env block. Pass the credential as the action’s anthropic_api_key input; the action sets it as ANTHROPIC_API_KEY, so it reaches the gateway in the x-api-key header.
For an x-api-key gateway, set the base URL in env and pass the gateway key as the input:
anthropic_api_key input and as ANTHROPIC_AUTH_TOKEN in the workflow env block. The action requires anthropic_api_key, CLAUDE_CODE_OAUTH_TOKEN, or workload identity federation before it launches Claude Code, and it doesn’t read ANTHROPIC_AUTH_TOKEN, so the input is there only to satisfy that launch check. The env variable is what puts the key in the Authorization header the gateway reads; the copy in x-api-key is ignored:
CLAUDE_CODE_OAUTH_TOKEN and workload identity federation, see Claude Code GitHub Actions and the action’s README.
Agent SDK
The Agent SDK has no gateway-specific options; it passes environment variables to the Claude Code process it spawns. Each SDK accepts anenv option that sets the spawned process’s environment, and the TypeScript and Python SDKs treat it differently:
- TypeScript: the spawned process inherits the parent environment by default, but setting
options.envreplaces the environment entirely. Spreadprocess.envinto it to keep your gateway variables. - Python:
ClaudeAgentOptions(env=...)merges on top of the inherited environment, so gateway variables set in the parent process carry through without spreading.
Slack, web, and Remote Control
Claude Code in Slack and Claude Code on the web are Anthropic-hosted products that always use Anthropic’s API; they aren’t part of a gateway deployment. Gateway variables set in a cloud session’s environment configuration are not applied. If your traffic must stay on the gateway, don’t enable these surfaces for those users. Remote Control and voice dictation both rely on a claude.ai identity: Remote Control to pair a live session with your account, and voice dictation to reach the claude.ai transcription endpoint. They are unavailable whileANTHROPIC_API_KEY, ANTHROPIC_AUTH_TOKEN, or an apiKeyHelper is active. As of v2.1.196, Remote Control is also disabled while ANTHROPIC_BASE_URL points at a non-Anthropic host, so signing in with claude.ai isn’t enough on its own.
To restore either feature, log in with claude.ai and unset the gateway variables that feature checks. The Remote Control section of claude doctor names the credential variable to unset.
- Voice dictation: unset the gateway credential
- Remote Control: unset the gateway credential and
ANTHROPIC_BASE_URL
Additional configuration
These settings cover cases beyond the base URL and credential. Set them only if your administrator’s instructions, your network’s egress rules, or the troubleshooting table call for one.Send additional headers
Some gateways route or tag requests using a custom header in addition to the credential, for example a tenant identifier or a routing key. To send one, setANTHROPIC_CUSTOM_HEADERS with one Name: Value pair per line. The example below adds a routing header named X-Org-Route:
- Bash or Zsh
- PowerShell
ANTHROPIC_CUSTOM_HEADERS in the env block of a settings file. Use \n between pairs there, since JSON strings can’t span multiple lines:
Add gateway models to the model picker
Model discovery queries the gateway for its model list at startup and adds those names to the/model picker alongside the built-in entries.
Enable it if your gateway serves model names that aren’t in Claude Code’s built-in list and you want to select them from the picker. If the built-in models are what you use, you don’t need discovery; your administrator may also have already enabled it through managed settings.
To enable it, set CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY=1 in your shell or in the env block of ~/.claude/settings.json. Discovery requires Claude Code v2.1.129 or later.
Discovered models appear as additional /model entries labeled From gateway. To confirm discovery ran, start claude --debug and look for the [gatewayDiscovery] lines: a success logs how many models were cached, and a 404, timeout, or redirect is recorded there too. For when discovery runs, what it filters, and the response format gateways serve, see the model discovery reference.
Rotate credentials with apiKeyHelper
AnapiKeyHelper is a command Claude Code runs to fetch your gateway credential, instead of reading it from a static environment variable.
Use a helper when the credential expires on a schedule, comes from a vault or SSO command, or your administrator told you to configure one. If your credential is a fixed string you set once, the credential variable is all you need and you can skip this section.
The helper is any shell command that prints the current credential to stdout. Claude Code runs it through your system shell, so on Windows it can be an executable or a PowerShell invocation. Write the script, make it executable, and reference it from apiKeyHelper in your settings file:
- Bash or Zsh
- PowerShell
For example, a script that reads from a vault:Reference its path in
~/.claude/settings.json:CLAUDE_CODE_API_KEY_HELPER_TTL_MS in milliseconds, for example CLAUDE_CODE_API_KEY_HELPER_TTL_MS=900000 for 15 minutes.
The helper’s value is sent in both the Authorization and x-api-key headers, so it works whichever header your gateway reads.
Turn off traffic outside the gateway path
The gateway carries model requests, but Claude Code also sends nonessential background traffic outside the gateway path, to Anthropic and to third-party services such as GitHub: version checks, telemetry, error reports, release notes, and similar requests. On a network that only allows egress to the gateway, these requests fail and can appear as blocked connections in your egress monitoring. To turn that traffic off, setCLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1 alongside the gateway variables, in the same shell exports or settings-file env block:
- Bash or Zsh
- PowerShell
- It disables auto-updates, so plan for another update path, such as your package manager or managed distribution.
- It suppresses the fast mode availability check. Unless a previous check already enabled fast mode on the machine,
/fastreports that fast mode is unavailable. - It turns off gateway model discovery, even though discovery queries the gateway itself. Previously discovered models stay available from the local cache, but the list isn’t refreshed.
- The WebFetch tool’s domain safety check isn’t affected and still calls
api.anthropic.com. Turn it off separately withskipWebFetchPreflight: truein settings if your network blocks that host. - For each telemetry stream and the variable that controls it, see telemetry services.
Route to a cloud provider through a gateway
These configurations point Claude Code at a gateway through a provider-specific base URL variable in place ofANTHROPIC_BASE_URL. Amazon Bedrock and Google Cloud’s Agent Platform gateways accept those providers’ native request formats; Microsoft Foundry and Claude Platform on AWS gateways accept the Anthropic Messages format and differ only in which base URL variable reaches them.
Use one only if your gateway team specifically named Amazon Bedrock, Google Cloud’s Agent Platform, Microsoft Foundry, or the Claude Platform on AWS. If the verification request above returned JSON, you can skip this section.
Set the block for the provider your gateway team named. The skip-auth variables tell Claude Code not to sign requests with provider credentials, since the gateway holds those. If the gateway needs its own token, add ANTHROPIC_AUTH_TOKEN after the block, except for Microsoft Foundry, which uses ANTHROPIC_FOUNDRY_API_KEY as shown. A Microsoft Foundry gateway that expects a bearer token can use ANTHROPIC_FOUNDRY_AUTH_TOKEN instead; it takes precedence over ANTHROPIC_FOUNDRY_API_KEY when both are set. ANTHROPIC_FOUNDRY_AUTH_TOKEN requires Claude Code v2.1.203 or later.
Amazon Bedrock
- Bash or Zsh
- PowerShell
Google Cloud’s Agent Platform
- Bash or Zsh
- PowerShell
Microsoft Foundry
Put the gateway’s credential inANTHROPIC_FOUNDRY_API_KEY; it is sent to the gateway as the x-api-key header. A gateway that expects a bearer token can take ANTHROPIC_FOUNDRY_AUTH_TOKEN instead. Claude Code sends that value as the Authorization: Bearer header, and it takes precedence over ANTHROPIC_FOUNDRY_API_KEY when both are set. Requires Claude Code v2.1.203 or later.
For a gateway that injects its own Authorization header, set CLAUDE_CODE_SKIP_FOUNDRY_AUTH=1 and leave both credential variables unset. Claude Code then sends requests without an Azure credential and preserves the Authorization header you supply, for example through ANTHROPIC_CUSTOM_HEADERS. Before v2.1.203, CLAUDE_CODE_SKIP_FOUNDRY_AUTH without an API key left the Microsoft Foundry client unable to send requests.
- Bash or Zsh
- PowerShell
Claude Platform on AWS
See Claude Platform on AWS for the workspace ID.- Bash or Zsh
- PowerShell
Troubleshoot gateway errors
These are the most common errors when running Claude Code through a gateway, with the gateway-side cause and the fix:
If Claude Code prompts you to log in repeatedly after removing gateway configuration, the cause is usually credential storage rather than the gateway; see authentication errors.
Related resources
- LLM gateways overview: what a gateway is and how it interacts with claude.ai subscriptions
- Roll out an LLM gateway for your organization: the admin-facing checklist for deploying and distributing gateway configuration
- Gateway protocol reference: what Claude Code sends to a gateway, including the headers and fields the gateway must forward
- Settings: where settings files live and how the
envblock is read - Authentication: how credential variables,
apiKeyHelper, and OAuth login interact