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.

Connect the CLI

Configure the API key.
```
ox-cli config set api-key <your-api-key>
```
Alternatively, run the following command and press Enter to securely enter the API key interactively.
```
ox-cli config
```
(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.
```
ox-cli config set api-host https://custom.api.endpoint.com
```
Verify the configuration.
To verify the configured API key:
```
ox-cli config get api-key
```
To verify the configured API endpoint:
```
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.

Last updated 11 days ago