> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/ox-code/scanning/ox-cli-1/authenticating-ox-cli/connect-ox-cli-with-an-api-key.md).

# Connect OX CLI with an API key

Use an API key when OAuth authentication isn't available or when you prefer to authenticate the OX CLI with a static credential. After you configure the API key, the CLI uses it for subsequent commands until you configure a different authentication method.

### Before you begin

[Retrieve your IDE/CLI integration key from the OX platform.](/ox-code/scanning/ox-ide-integrations/generating-ide-cli-integration-key.md)

### Connect the CLI

1. Configure the API key.

   ```bash
   ox-cli config set api-key <your-api-key>
   ```

   Alternatively, run the following command and press **Enter** to securely enter the API key interactively.

   ```bash
   ox-cli config
   ```
2. (Optional) Configure the OX API endpoint.

   Configure a custom API endpoint only if you're connecting to an environment other than the default OX Cloud endpoint.

   ```bash
   ox-cli config set api-host https://custom.api.endpoint.com
   ```
3. Verify the configuration.

   To verify the configured API key:

   ```bash
   ox-cli config get api-key
   ```

   To verify the configured API endpoint:

   ```bash
   ox-cli config get api-host
   ```

> **Note**
>
> Running `ox-cli config` without arguments is the recommended way to securely enter your API key because the value isn't displayed in your terminal or stored in your shell history.


---

# 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://docs.ox.security/ox-code/scanning/ox-cli-1/authenticating-ox-cli/connect-ox-cli-with-an-api-key.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.