# Snyk API

- [Overview](https://docs.snyk.io/snyk-api/snyk-api.md)
- [REST API](https://docs.snyk.io/snyk-api/rest-api.md)
- [About the REST API](https://docs.snyk.io/snyk-api/rest-api/about-the-rest-api.md)
- [Getting started with the REST API](https://docs.snyk.io/snyk-api/rest-api/getting-started-with-the-rest-api.md)
- [V1 API](https://docs.snyk.io/snyk-api/v1-api.md)
- [Authentication for API](https://docs.snyk.io/snyk-api/authentication-for-api.md)
- [Snyk API token permissions users can control](https://docs.snyk.io/snyk-api/authentication-for-api/snyk-api-token-permissions-users-can-control.md)
- [Personal Access Tokens (PATs)](https://docs.snyk.io/snyk-api/authentication-for-api/personal-access-tokens-pats.md)
- [Revoke and regenerate a Snyk API token](https://docs.snyk.io/snyk-api/authentication-for-api/revoke-and-regenerate-a-snyk-api-token.md)
- [Changelog](https://docs.snyk.io/snyk-api/changelog.md)
- [OAuth2 API](https://docs.snyk.io/snyk-api/oauth2-api.md)
- [Reference](https://docs.snyk.io/snyk-api/reference.md)
- [AccessRequests](https://docs.snyk.io/snyk-api/reference/accessrequests.md)
- [AIBOM](https://docs.snyk.io/snyk-api/reference/aibom.md)
- [Apps](https://docs.snyk.io/snyk-api/reference/apps.md)
- [Asset](https://docs.snyk.io/snyk-api/reference/asset.md)
- [Audit Logs](https://docs.snyk.io/snyk-api/reference/audit-logs.md)
- [Cloud](https://docs.snyk.io/snyk-api/reference/cloud.md)
- [Collection](https://docs.snyk.io/snyk-api/reference/collection.md)
- [ContainerImage](https://docs.snyk.io/snyk-api/reference/containerimage.md)
- [ContainerRegistryImportPolicy](https://docs.snyk.io/snyk-api/reference/containerregistryimportpolicy.md)
- [Custom Base Images](https://docs.snyk.io/snyk-api/reference/custom-base-images.md)
- [Dependencies (v1)](https://docs.snyk.io/snyk-api/reference/dependencies-v1.md)
- [Entitlements (v1)](https://docs.snyk.io/snyk-api/reference/entitlements-v1.md)
- [Export](https://docs.snyk.io/snyk-api/reference/export.md)
- [Findings](https://docs.snyk.io/snyk-api/reference/findings.md)
- [Group](https://docs.snyk.io/snyk-api/reference/group.md)
- [Groups (v1)](https://docs.snyk.io/snyk-api/reference/groups-v1.md)
- [Groups](https://docs.snyk.io/snyk-api/reference/groups.md)
- [IacSettings](https://docs.snyk.io/snyk-api/reference/iacsettings.md)
- [Ignores (v1)](https://docs.snyk.io/snyk-api/reference/ignores-v1.md)
- [Import Projects (v1)](https://docs.snyk.io/snyk-api/reference/import-projects-v1.md)
- [Integrations (v1)](https://docs.snyk.io/snyk-api/reference/integrations-v1.md)
- [Integrations](https://docs.snyk.io/snyk-api/reference/integrations.md)
- [Inventory Assets](https://docs.snyk.io/snyk-api/reference/inventory-assets.md)
- [Invites](https://docs.snyk.io/snyk-api/reference/invites.md)
- [Issues](https://docs.snyk.io/snyk-api/reference/issues.md)
- [Jira (v1)](https://docs.snyk.io/snyk-api/reference/jira-v1.md)
- [LanguagesSettings](https://docs.snyk.io/snyk-api/reference/languagessettings.md)
- [Learn](https://docs.snyk.io/snyk-api/reference/learn.md)
- [Licenses (v1)](https://docs.snyk.io/snyk-api/reference/licenses-v1.md)
- [Monitor (v1)](https://docs.snyk.io/snyk-api/reference/monitor-v1.md)
- [OpenSourceSettings](https://docs.snyk.io/snyk-api/reference/opensourcesettings.md)
- [Organizations (v1)](https://docs.snyk.io/snyk-api/reference/organizations-v1.md)
- [Orgs](https://docs.snyk.io/snyk-api/reference/orgs.md)
- [Package Version](https://docs.snyk.io/snyk-api/reference/package-version.md)
- [Package](https://docs.snyk.io/snyk-api/reference/package.md)
- [PersonalAccessToken](https://docs.snyk.io/snyk-api/reference/personalaccesstoken.md)
- [Policies](https://docs.snyk.io/snyk-api/reference/policies.md)
- [Projects (v1)](https://docs.snyk.io/snyk-api/reference/projects-v1.md)
- [Projects](https://docs.snyk.io/snyk-api/reference/projects.md)
- [Pull Request Templates](https://docs.snyk.io/snyk-api/reference/pull-request-templates.md)
- [Reporting API (v1)](https://docs.snyk.io/snyk-api/reference/reporting-api-v1.md)
- [SBOM](https://docs.snyk.io/snyk-api/reference/sbom.md)
- [SastSettings](https://docs.snyk.io/snyk-api/reference/sastsettings.md)
- [ServiceAccounts](https://docs.snyk.io/snyk-api/reference/serviceaccounts.md)
- [SlackSettings](https://docs.snyk.io/snyk-api/reference/slacksettings.md)
- [Slack](https://docs.snyk.io/snyk-api/reference/slack.md)
- [Snapshots (v1)](https://docs.snyk.io/snyk-api/reference/snapshots-v1.md)
- [Targets](https://docs.snyk.io/snyk-api/reference/targets.md)
- [TenantRole](https://docs.snyk.io/snyk-api/reference/tenantrole.md)
- [Tenants](https://docs.snyk.io/snyk-api/reference/tenants.md)
- [Test (v1)](https://docs.snyk.io/snyk-api/reference/test-v1.md)
- [Tests](https://docs.snyk.io/snyk-api/reference/tests.md)
- [Universal Broker](https://docs.snyk.io/snyk-api/reference/universal-broker.md)
- [Users (v1)](https://docs.snyk.io/snyk-api/reference/users-v1.md)
- [Users](https://docs.snyk.io/snyk-api/reference/users.md)
- [Webhooks (v1)](https://docs.snyk.io/snyk-api/reference/webhooks-v1.md)
- [API endpoints index and tips](https://docs.snyk.io/snyk-api/api-endpoints-index-and-tips.md)
- [Solutions for specific use cases](https://docs.snyk.io/snyk-api/api-endpoints-index-and-tips/solutions-for-specific-use-cases.md)
- [Scenarios for using the Snyk API](https://docs.snyk.io/snyk-api/api-endpoints-index-and-tips/scenarios-for-using-the-snyk-api.md)
- [Issue IDs in Snyk APIs](https://docs.snyk.io/snyk-api/api-endpoints-index-and-tips/issue-ids-in-snyk-apis.md)
- [Organization and Group identification for Projects using the API](https://docs.snyk.io/snyk-api/api-endpoints-index-and-tips/organization-and-group-identification-for-projects-using-the-api.md)
- [Project issue paths API endpoints](https://docs.snyk.io/snyk-api/api-endpoints-index-and-tips/project-issue-paths-api-endpoints.md)
- [Project type responses from the API](https://docs.snyk.io/snyk-api/api-endpoints-index-and-tips/project-type-responses-from-the-api.md)
- [Examples for the Update existing integration endpoint](https://docs.snyk.io/snyk-api/api-endpoints-index-and-tips/examples-for-the-update-existing-integration-endpoint.md)
- [Using specific Snyk APIs](https://docs.snyk.io/snyk-api/using-specific-snyk-apis.md)
- [Export API: Specifications, columns, and filters](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/export-api-specifications-columns-and-filters.md)
- [Issues: List issues for a package](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/issues-list-issues-for-a-package.md)
- [SBOM APIs](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/sbom-apis.md)
- [Get a Project’s SBOM document](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/sbom-apis/rest-api-get-a-projects-sbom-document.md)
- [Test an SBOM document for vulnerabilities](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/sbom-apis/rest-api-endpoint-test-an-sbom-document-for-vulnerabilities.md)
- [Snyk Apps APIs](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis.md)
- [About Snyk Apps](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/about-snyk-apps.md)
- [Prerequisites for Snyk Apps](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/prerequisites-for-snyk-apps.md)
- [Scopes to request](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/scopes-to-request.md)
- [Create a Snyk App using the Snyk API](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/create-a-snyk-app-using-the-snyk-api.md)
- [Create a Snyk App using the Snyk CLI](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/create-a-snyk-app-using-the-snyk-cli.md)
- [Set up a Snyk App using the OAuth2 API](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/set-up-a-snyk-app-using-the-oauth2-api.md)
- [Quick setup](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/set-up-a-snyk-app-using-the-oauth2-api/quick-setup.md)
- [Set up to authorize users](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/set-up-a-snyk-app-using-the-oauth2-api/set-up-to-authorize-users.md)
- [Set up the authorization code exchange](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/set-up-a-snyk-app-using-the-oauth2-api/set-up-the-authorization-code-exchange.md)
- [Set up the refresh token exchange](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/set-up-a-snyk-app-using-the-oauth2-api/set-up-the-refresh-token-exchange.md)
- [Retrieve the App Org IDs](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/set-up-a-snyk-app-using-the-oauth2-api/retrieve-the-app-org-ids.md)
- [Revoke compromised refresh tokens](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/set-up-a-snyk-app-using-the-oauth2-api/revoke-compromised-refresh-tokens.md)
- [Manage App details](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/manage-app-details.md)
- [Tutorial: create a Snyk App](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/tutorial-create-a-snyk-app.md)
- [Configuring Express.js](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/tutorial-create-a-snyk-app/configuring-express.js.md)
- [Register the App and configure user authorization](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/tutorial-create-a-snyk-app/register-the-app-and-configure-user-authorization.md)
- [Render content for users](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/snyk-apps-apis/tutorial-create-a-snyk-app/render-content-for-users.md)
- [Webhooks APIs](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis.md)
- [About webhooks](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/about-webhooks.md)
- [Webhook events and payloads](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/webhooks.md)
- [Validation and versioning of payloads](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/validation-and-versioning-of-payloads.md)
- [Guides to webhooks](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks.md)
- [How to use Snyk webhooks with Zapier](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/tutorial.md)
- [How to use Snyk Webhooks to integrate New Relic with Snyk](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-integrate-new-relic-with-snyk.md)
- [Create an Azure Function App](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-integrate-new-relic-with-snyk/create-an-azure-function-app.md)
- [Configure Azure Function environment variables](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-integrate-new-relic-with-snyk/configure-azure-function-environment-variables.md)
- [Copy the Azure Function URL](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-integrate-new-relic-with-snyk/copy-the-azure-function-url.md)
- [Create a Snyk Webhook](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-integrate-new-relic-with-snyk/create-a-snyk-webhook.md)
- [New Relic Curated UI and Snyk Custom Dashboard](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-integrate-new-relic-with-snyk/new-relic-curated-ui-and-snyk-custom-dashboard.md)
- [How to use Snyk Webhooks to connect Snyk to Slack with AWS Lambda](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda.md)
- [Slack setup to connect Snyk with AWS Lambda](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/slack-setup-to-connect-snyk-with-aws-lambda.md)
- [AWS Lambda setup: create Lambda function to connect Snyk to Slack](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-create-lambda-function-to-connect-snyk-to-slack.md)
- [AWS Lambda setup: add security through an environment variable](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-add-security-through-an-environment-variable.md)
- [AWS Lambda setup: expose a public URL](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-set-up-the-trigger.md)
- [With API Gateway](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-set-up-the-trigger/with-api-gateway.md)
- [AWS API Gateway: Setting up a trigger](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-set-up-the-trigger/with-api-gateway/aws-lambda-setup-set-up-the-trigger.md)
- [AWS API Gateway: add the POST method to connect Snyk to Slack](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-set-up-the-trigger/with-api-gateway/aws-api-gateway-add-the-post-method-to-connect-snyk-to-slack.md)
- [AWS API Gateway: deploy the POST method](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-set-up-the-trigger/with-api-gateway/aws-api-gateway-deploy-the-post-method.md)
- [With a Lambda Function URL](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-set-up-the-trigger/with-a-lambda-function-url.md)
- [Modify the Lambda function](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/aws-lambda-setup-set-up-the-trigger/with-a-lambda-function-url/modify-the-lambda-function.md)
- [Set up the Snyk webhook](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/set-up-the-snyk-webhook.md)
- [Test the Snyk webhook connection](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/test-the-snyk-webhook-connection.md)
- [Configure the AWS Lambda script](https://docs.snyk.io/snyk-api/using-specific-snyk-apis/webhooks-apis/guides-to-webhooks/how-to-use-snyk-webhooks-to-connect-snyk-to-slack-with-aws-lambda/configure-the-aws-lambda-script.md)
- [API End of Life (EOL) process and migration guides](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides.md)
- [API EOL endpoints and key dates](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides/api-eol-endpoints-and-key-dates.md)
- [Guides to migration](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides/guides-to-migration.md)
- [List all Projects V1 API to REST API migration guide (completed migration)](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides/guides-to-migration/list-all-projects-v1-api-to-rest-api-migration-guide-completed-migration.md)
- [REST Issues experimental API to GA API migration guide](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides/guides-to-migration/rest-issues-experimental-api-to-ga-api-migration-guide.md)
- [Search Audit Logs (Group and Org) v1 API to GA REST Audit logs API migration guide](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides/guides-to-migration/search-audit-logs-group-and-org-v1-api-to-ga-rest-audit-logs-api-migration-guide.md)
- [V1 Issues APIs to REST Issues API migration guide](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides/guides-to-migration/v1-reporting-issues-and-v1-aggregated-issues-apis-to-rest-issues-api-migration-guide.md)
- [V1 Reporting APIs to Export API migration guide](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides/guides-to-migration/v1-reporting-apis-to-export-api-migration-guide.md)
- [Candidates for upcoming API end-of-life cadences](https://docs.snyk.io/snyk-api/api-end-of-life-eol-process-and-migration-guides/candidates-for-upcoming-api-end-of-life-cadences.md)


---

# Agent Instructions: 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/snyk-api.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.