> 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-ide-integrations/generating-ide-cli-integration-key.md).

# Generating IDE/CLI Integration key

Before you install IDE integrations, you need to generate an API key.

> **Note:** A user with Admin and Developer roles can create an API Key for the IDE extension. The API Key will be created according to the user's scope.

**To generate an API key:**

1. From the left pane of OX Security platform, select **Settings > API Key Settings**.
2. In the **API Key Settings** window, select **CREATE API KEY**.
3. In the **Create API Key** dialog, set the following:

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-715971677663314d6016a66115617dda5594379c%2FIDE_integration_key.png?alt=media" alt="" width="450"><figcaption></figcaption></figure>

|                     |                                                                                                                        |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| **API Key Name**    | Add a meaningful name that is easy to identify. It is good practice to include the key's intended purpose in the name. |
| **API Key Type**    | Select **IDE/CLI Integration**.                                                                                        |
| **Expiration Date** | Until when you can use this key.                                                                                       |

4. Select **CREATE**. The key appears.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-701429fb3914c329ab688cbfe2438d0fce18e108%2FIDE_integration_key1.png?alt=media" alt="" width="452"><figcaption></figcaption></figure>

5. Copy and save the API Key Secret to be used when connecting to APIs. This is the only time when you can see and copy the key.
6. Select **CLOSE**. The new key appears in the **API Key Settings** page.

<figure><img src="https://884876233-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdK3XMLdV8zRg847RmGmZ%2Fuploads%2Fgit-blob-c9069799d044e63cca21e890f8fc21d15ebfc672%2FIDE_integration_key2.png?alt=media" alt=""><figcaption></figcaption></figure>


---

# 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-ide-integrations/generating-ide-cli-integration-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.