Skip to content

Commit 964172a

Browse files
awileysnykgitbook-bot
authored andcommitted
GITBOOK-8468: API index: P-end, align wi API reference endpoints, move Jira, Ignores, rmve snapshot, upd beta lnks
1 parent f4a8c14 commit 964172a

File tree

1 file changed

+14
-16
lines changed
  • docs/snyk-api/api-endpoints-index-and-tips

1 file changed

+14
-16
lines changed

docs/snyk-api/api-endpoints-index-and-tips/README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -658,6 +658,10 @@ The query-string parameter for types is optional. The endpoint does not enforce
658658
**More information:** [Legacy reports](../../manage-issues/reporting/legacy-reports/);\
659659
[Dependencies and licenses](../../manage-risk/reporting/dependencies-and-licenses/)
660660

661+
### [Get list of issues](../reference/reporting-api-v1.md#reporting-issues)
662+
663+
See notes for [Get list of latest issues](./#get-list-of-latest-issues).
664+
661665
### [Get list of latest issues](../reference/reporting-api-v1.md#reporting-issues-latest)
662666

663667
To list all Projects that have a vulnerability linked to a CVE, use the capability to filter on strings with the reporting endpoints [Get list of latest issues](../reference/reporting-api-v1.md#reporting-issues-latest) and [Get List of issues](../reference/reporting-api-v1.md#reporting-issues). Filter by the identifier attribute.
@@ -667,13 +671,7 @@ To get a list of issues that have been fixed, use the endpoint [Get list of late
667671
**More information:** [Priority score](../../manage-risk/prioritize-issues-for-fixing/priority-score.md);\
668672
[View Snyk IaC issue reports](../../scan-with-snyk/snyk-iac/view-snyk-iac-issue-reports.md);\
669673
[Scenario: Retrieve a Project snapshot for every Project in a given Group](scenarios-for-using-the-snyk-api.md#retrieve-a-project-snapshot-for-every-project-in-a-given-group);\
670-
[Scenario: Bulk ignore issues](scenarios-for-using-the-snyk-api.md#bulk-ignore-issues)
671-
672-
### [Get list of issues](../reference/reporting-api-v1.md#reporting-issues)
673-
674-
See notes for [Get list of latest issues](./#get-list-of-latest-issues).
675-
676-
**More information:** [Find all Projects affected by a vulnerability](scenarios-for-using-the-snyk-api.md#find-all-projects-affected-by-a-vulnerability)
674+
[Scenario: Bulk ignore issues](scenarios-for-using-the-snyk-api.md#bulk-ignore-issues)**More information:** [Find all Projects affected by a vulnerability](scenarios-for-using-the-snyk-api.md#find-all-projects-affected-by-a-vulnerability)
677675

678676
### [Get test counts](../reference/reporting-api-v1.md#reporting-counts-tests)
679677

@@ -693,13 +691,13 @@ See notes for [Get list of latest issues](./#get-list-of-latest-issues).
693691

694692
**More information:** [Get a project’s SBOM document](../how-to-use-snyk-sbom-and-list-issues-apis/rest-api-get-a-projects-sbom-document.md)
695693

696-
### [Create an SBOM test run](https://apidocs.snyk.io/?version=2024-07-10%7Ebeta#post-/orgs/-org\_id-/sbom\_tests) (beta)
694+
### [Create an SBOM test run](ttps://apidocs.snyk.io/?version=2024-10-15#post-/orgs/-org\_id-/sbom\_tests) (beta)
697695

698696
**More information:** [Test an SBOM document for vulnerabilities](../how-to-use-snyk-sbom-and-list-issues-apis/rest-api-endpoint-test-an-sbom-document-for-vulnerabilities.md)
699697

700-
### [Gets an SBOM test run status](https://apidocs.snyk.io/?version=2024-07-10%7Ebeta#get-/orgs/-org\_id-/sbom\_tests/-job\_id-) (beta)
698+
### [Gets an SBOM test run status](https://apidocs.snyk.io/?version=2024-10-15#get-/orgs/-org\_id-/sbom\_tests/-job\_id-) (beta)
701699

702-
### [Gets an SBOM test run result](https://apidocs.snyk.io/?version=2024-07-10%7Ebeta#get-/orgs/-org\_id-/sbom\_tests/-job\_id-/results) (beta)
700+
### [Gets an SBOM test run result](https://apidocs.snyk.io/?version=2024-10-15#get-/orgs/-org\_id-/sbom\_tests/-job\_id-/results) (beta)
703701

704702
**More information:** [Test an SBOM document for vulnerabilities](../how-to-use-snyk-sbom-and-list-issues-apis/rest-api-endpoint-test-an-sbom-document-for-vulnerabilities.md)
705703

@@ -827,25 +825,25 @@ See notes for [Get list of latest issues](./#get-list-of-latest-issues).
827825

828826
### [Test for issues in a public gem by name and version](../reference/test-v1.md#test-rubygems-gemname-version)
829827

830-
### [Test (pip) requirements.txt file](../reference/test-v1.md#test-pip)
828+
### [Test requirements.txt file](../reference/test-v1.md#test-pip) (pip)
831829

832830
### [Pip\_Test for issues in a public (pip) package by name and version](../reference/test-v1.md#test-pip-packagename-version)
833831

834832
### [Test package.json & package-lock.json file](../reference/test-v1.md#test-npm)
835833

836-
### [Test for issues in a public (npm) package by name and version](../reference/test-v1.md#test-npm-packagename-version)
834+
### [Test for issues in a public package by name and version](../reference/test-v1.md#test-npm-packagename-version) (npm)
837835

838836
**More information:** [Guidance for JavaScript and Node.js, Unmanaged JavaScript section](../../supported-languages-package-managers-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md#unmanaged-javascript)
839837

840838
### [Test maven file](../reference/test-v1.md#test-maven)
841839

842-
### [Test for issues in a (maven) public package by group id, artifact id and version](../reference/test-v1.md#test-maven-groupid-artifactid-version)
840+
### [Test for issues in a public package by group id, artifact id and version](../reference/test-v1.md#test-maven-groupid-artifactid-version) (Maven)
843841

844842
**More information:** [Guidance for Java and Kotlin](../../supported-languages-package-managers-and-frameworks/java-and-kotlin/guidance-for-java-and-kotlin.md)
845843

846844
### [Test gradle file](../reference/test-v1.md#test-gradle)
847845

848-
### [Test for issues in a public (Gradle) package by group, name and version](../reference/test-v1.md#test-gradle-group-name-version)
846+
### [Test for issues in a public package by group, name and version](../reference/test-v1.md#test-gradle-group-name-version) (Gradle)
849847

850848
### [Test vendor.json file](../reference/test-v1.md#test-govendor)
851849

@@ -877,13 +875,13 @@ See notes for [Get list of latest issues](./#get-list-of-latest-issues).
877875

878876
### [My User Details](../reference/users.md)
879877

880-
### [Update a user’s role in a group](https://apidocs.snyk.io/?version=2024-07-10%7Ebeta#patch-/groups/-group\_id-/users/-id-) (beta)
878+
### [Update a user’s role in a group](https://apidocs.snyk.io/?version=2024-10-15#patch-/groups/-group\_id-/users/-id-) (beta)
881879

882880
Note: Use this endpoint to remove users from a group.
883881

884882
**More information:** [Remove members from Groups and Orgs using the API](../../snyk-admin/user-management-with-the-api/remove-members-from-groups-and-orgs-using-the-api.md)
885883

886-
### [Get user by ID](https://apidocs.snyk.io/?version=2024-07-10%7Ebeta#get-/orgs/-org\_id-/users/-id-) (beta)
884+
### [Get user by ID](https://apidocs.snyk.io/?version=2024-10-15#get-/orgs/-org\_id-/users/-id-) (beta)
887885

888886
## Webhooks (v1)
889887

0 commit comments

Comments
 (0)