> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Snyk

> Query Snyk organizations, projects, and security issues

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key comes from `SNYK_TOKEN`.
* **Docs**: [https://docs.snyk.io/snyk-api/authentication-for-api](https://docs.snyk.io/snyk-api/authentication-for-api)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable     | Required | Description                                                                                                            |
| ------------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `SNYK_TOKEN` | Yes      | Snyk API token (personal token or service account token) [Docs](https://docs.snyk.io/snyk-api/authentication-for-api). |

## Setup

1. **Sign up for Snyk**: Create a free account at [https://app.snyk.io](https://app.snyk.io) and import at least one repository so projects and issues exist to query.
2. **Get your API token**: Go to Account Settings ([https://app.snyk.io/account](https://app.snyk.io/account)) and copy your personal API token, or create a service account token for shared use. Free plans include API access via the personal token.
3. **Set the environment variable**: Add the token to your .env as SNYK\_TOKEN=...
4. **Verify access**: Run List Organizations, then List Projects with one of the returned org IDs.

* Authentication uses 'Authorization: token \<SNYK\_TOKEN>' - the prefix is 'token', not 'Bearer'
* Every REST API request requires a date-based ?version= query parameter; tools default to 2024-10-15
* If your account is in a regional environment (e.g. US-02 at api.us.snyk.io), API hosts differ - these tools target the default [https://api.snyk.io](https://api.snyk.io)
* Responses follow the JSON:API format: items are under data\[] with attributes, pagination under links

Provider API reference: [https://docs.snyk.io/snyk-api](https://docs.snyk.io/snyk-api)

## Tools

| Tool               | Access | Description                                                                            |
| ------------------ | ------ | -------------------------------------------------------------------------------------- |
| List Organizations | Read   | List Snyk organizations the token can access                                           |
| List Projects      | Read   | List projects in a Snyk organization                                                   |
| Get Project        | Read   | Get a project's details in a Snyk organization                                         |
| List Issues        | Read   | List security issues in a Snyk organization, optionally filtered by severity or status |
| Get Organization   | Read   | Get details of a Snyk organization                                                     |

## Example prompts

* List the open critical and high severity issues across my Snyk organization and summarize them by project.
* List my Snyk projects and show which ones were tested most recently.