> 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/developer-tools/snyk-api/rest-api.md).

# REST API

Introduction to the Snyk REST API and resources to help you get started

This section provides an [introduction to the REST API](/developer-tools/snyk-api/rest-api/about-the-rest-api.md) and a resource to help you [get started](https://docs.snyk.io/getting-started-guides/getting-started-with-the-rest-api).

For more information, see [Authentication for API](/developer-tools/snyk-api/authentication-for-api.md) and the [Changelog](/developer-tools/snyk-api/changelog.md) of updates to the [Reference](/developer-tools/snyk-api/reference.md).

{% hint style="info" %}
Note that the date updated in the changelog is not a valid version number. The valid version number precedes the date updated in each section. For example, in the section "2024-10-15 - Updated 2025-02-11," `2024-10-15` is the valid version number.
{% endhint %}

For more information about changes in the APIs, see [API End of Life (EOL) process and migration guides](/developer-tools/snyk-api/api-end-of-life-eol-process-and-migration-guides.md).

For help finding information about how to use the Snyk API, see [API endpoints index and notes](/developer-tools/snyk-api/api-endpoints-index-and-tips.md).


---

# 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.snyk.io/developer-tools/snyk-api/rest-api.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.