> For the complete documentation index, see [llms.txt](https://docs.snyk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snyk.io/scan-fix-and-prevent/scan-with-snyk/snyk-api-web/integrations/generate-api-key.md).

# Generate API key

Learn how to generate API keys to integrate with Snyk API & Web.

## Overview

Snyk API & Web provides API keys for authentication purposes in the integration with third-party systems (for example, Slack, Jira, Azure Boards, Azure DevOps, or Jenkins), as well as the integration of your own applications with Snyk API & Web using the Snyk API & Web API.

Generating an API key has two steps:

1. Access the API key configuration.
2. Configure, generate, and save the API key.

This article describes these steps in detail.

## Step 1: Access the API key configuration

Start by accessing the API key configuration as follows:

1. Go to the Snyk API & Web application.
2. Go to the **Settings** dropdown menu at the bottom-left corner of the navigation bar and click **API Keys**.
3. Click **Add API key** to open the configuration form.

## Step 2: Configure, generate, and save the API key

In the configuration form, fill out the following fields:

1. **Name**: Type a meaningful name for the API key (for example, "Azure DevOps Integration" or "My App Integration with Snyk API & Web").
2. **Role / Scope**: Choose the roles that can use the API key and at which level (scope) (for example, "Admin" / "Global (account)"). Click the plus (**+**) button to add the pairs of roles and scopes.
3. (Optional) **Labels**: Tag the API key with meaningful labels for filtering purposes.

Click **Generate key** and copy and save the API key.

{% hint style="warning" %}
This is the only time the API key is displayed. Make sure you copy and save it in a secure place.
{% endhint %}

With the API key saved, proceed to the integration with third-party tools or the integration of your own applications with Snyk API & Web using the Snyk API & Web API.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.snyk.io/scan-fix-and-prevent/scan-with-snyk/snyk-api-web/integrations/generate-api-key.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
