# REST API

This section provides an [introduction to the REST API](/~/revisions/8OT8pbepxU4WoUvu2ix6/snyk-api/rest-api/about-the-rest-api.md) and resources to help you [get started](/~/revisions/8OT8pbepxU4WoUvu2ix6/snyk-api/rest-api/getting-started-with-the-rest-api.md) and [authenticate](/~/revisions/8OT8pbepxU4WoUvu2ix6/snyk-api/rest-api/authentication-for-api.md).

The [Changelog](/~/revisions/8OT8pbepxU4WoUvu2ix6/snyk-api/rest-api/changelog.md) lists additions and changes to endpoints documented in the [Reference](/~/revisions/8OT8pbepxU4WoUvu2ix6/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](/~/revisions/8OT8pbepxU4WoUvu2ix6/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](/~/revisions/8OT8pbepxU4WoUvu2ix6/snyk-api/api-endpoints-index-and-tips.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/~/revisions/8OT8pbepxU4WoUvu2ix6/snyk-api/rest-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.