snyk-api

name	snyk-api
description	Snyk API skill. Use when working with Snyk for user, group, orgs. Covers 100 endpoints.
version	1.0.0
generator	lapsh

Snyk API

API version: 1.0

Auth

ApiKey Authorization in header

Base URL

https://api.snyk.io/v1

Setup

1. Set your API key in the appropriate header
2. GET /user/me -- verify access
3. POST /group/{groupId}/org/{orgId}/members -- create first members

Endpoints

100 endpoints across 7 groups. See references/api-spec.lap for full details.

user

Method	Path	Description
GET	/user/{userId}	Get User Details
GET	/user/me	Get My Details
GET	/user/me/notification-settings/org/{orgId}	Get organization notification settings
PUT	/user/me/notification-settings/org/{orgId}	Modify organization notification settings
GET	/user/me/notification-settings/org/{orgId}/project/{projectId}	Get project notification settings
PUT	/user/me/notification-settings/org/{orgId}/project/{projectId}	Modify project notification settings

group

Method	Path	Description
GET	/group/{groupId}/settings	View group settings
PUT	/group/{groupId}/settings	Update group settings
GET	/group/{groupId}/members	List all members in a group
POST	/group/{groupId}/org/{orgId}/members	Add a member to an organization within a group
GET	/group/{groupId}/tags	List all tags in a group
POST	/group/{groupId}/tags/delete	Delete tag from group
GET	/group/{groupId}/orgs	List all organizations in a group
GET	/group/{groupId}/roles	List all roles in a group

orgs

Method	Path	Description
GET	/orgs	List all the organizations a user belongs to

org

Method	Path	Description
POST	/org	Create a new organization
GET	/org/{orgId}/notification-settings	Get organization notification settings
PUT	/org/{orgId}/notification-settings	Set notification settings
POST	/org/{orgId}/invite	Invite users
GET	/org/{orgId}/members	List Members
GET	/org/{orgId}/settings	View organization settings
PUT	/org/{orgId}/settings	Update organization settings
PUT	/org/{orgId}/members/{userId}	Update a member in the organization
DELETE	/org/{orgId}/members/{userId}	Remove a member from the organization
PUT	/org/{orgId}/members/update/{userId}	Update a member's role in the organization
DELETE	/org/{orgId}	Remove organization
POST	/org/{orgId}/provision	Provision a user to the organization
GET	/org/{orgId}/provision	List pending user provisions
DELETE	/org/{orgId}/provision	Delete pending user provision
GET	/org/{orgId}/integrations	List
POST	/org/{orgId}/integrations	Add new integration
PUT	/org/{orgId}/integrations/{integrationId}	Update existing integration
DELETE	/org/{orgId}/integrations/{integrationId}/authentication	Delete credentials
POST	/org/{orgId}/integrations/{integrationId}/authentication/provision-token	Provision new broker token
POST	/org/{orgId}/integrations/{integrationId}/authentication/switch-token	Switch between broker tokens
POST	/org/{orgId}/integrations/{integrationId}/clone	Clone an integration (with settings and credentials)
GET	/org/{orgId}/integrations/{type}	Get existing integration by type

test

Method	Path	Description
GET	/test/maven/{groupId}/{artifactId}/{version}	Test for issues in a public package by group id, artifact id and version
POST	/test/maven	Test maven file
GET	/test/npm/{packageName}/{version}	Test for issues in a public package by name and version
POST	/test/npm	Test package.json & package-lock.json File
POST	/test/golangdep	Test Gopkg.toml & Gopkg.lock File
POST	/test/govendor	Test vendor.json File
POST	/test/yarn	Test package.json & yarn.lock File
GET	/test/rubygems/{gemName}/{version}	Test for issues in a public gem by name and version
POST	/test/rubygems	Test gemfile.lock file
GET	/test/gradle/{group}/{name}/{version}	Test for issues in a public package by group, name and version
POST	/test/gradle	Test gradle file
GET	/test/sbt/{groupId}/{artifactId}/{version}	sbt_Test for issues in a public package by group id, artifact id and version
POST	/test/sbt	Test sbt file
GET	/test/pip/{packageName}/{version}	pip_Test for issues in a public package by name and version
POST	/test/pip	Test requirements.txt file
POST	/test/composer	Test composer.json & composer.lock file
POST	/test/dep-graph	Test Dep Graph

monitor

Method	Path	Description
POST	/monitor/dep-graph	Monitor Dep Graph

reporting

Method	Path	Description
POST	/reporting/issues/latest	Get list of latest issues
POST	/reporting/issues	Get list of issues
POST	/reporting/counts/issues/latest	Get latest issue counts
POST	/reporting/counts/issues	Get issue counts
POST	/reporting/counts/projects/latest	Get latest project counts
POST	/reporting/counts/projects	Get project counts
POST	/reporting/counts/tests	Get test counts

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Get user details?" -> GET /user/{userId}
• "List all me?" -> GET /user/me
• "Get org details?" -> GET /user/me/notification-settings/org/{orgId}
• "Update a org?" -> PUT /user/me/notification-settings/org/{orgId}
• "Get project details?" -> GET /user/me/notification-settings/org/{orgId}/project/{projectId}
• "Update a project?" -> PUT /user/me/notification-settings/org/{orgId}/project/{projectId}
• "List all settings?" -> GET /group/{groupId}/settings
• "List all members?" -> GET /group/{groupId}/members
• "Create a member?" -> POST /group/{groupId}/org/{orgId}/members
• "List all tags?" -> GET /group/{groupId}/tags
• "Create a delete?" -> POST /group/{groupId}/tags/delete
• "List all orgs?" -> GET /group/{groupId}/orgs
• "List all roles?" -> GET /group/{groupId}/roles
• "List all orgs?" -> GET /orgs
• "Create a org?" -> POST /org
• "List all notification-settings?" -> GET /org/{orgId}/notification-settings
• "Create a invite?" -> POST /org/{orgId}/invite
• "List all members?" -> GET /org/{orgId}/members
• "List all settings?" -> GET /org/{orgId}/settings
• "Update a member?" -> PUT /org/{orgId}/members/{userId}
• "Delete a member?" -> DELETE /org/{orgId}/members/{userId}
• "Update a update?" -> PUT /org/{orgId}/members/update/{userId}
• "Delete a org?" -> DELETE /org/{orgId}
• "Create a provision?" -> POST /org/{orgId}/provision
• "List all provision?" -> GET /org/{orgId}/provision
• "List all integrations?" -> GET /org/{orgId}/integrations
• "Create a integration?" -> POST /org/{orgId}/integrations
• "Update a integration?" -> PUT /org/{orgId}/integrations/{integrationId}
• "Create a provision-token?" -> POST /org/{orgId}/integrations/{integrationId}/authentication/provision-token
• "Create a switch-token?" -> POST /org/{orgId}/integrations/{integrationId}/authentication/switch-token
• "Create a clone?" -> POST /org/{orgId}/integrations/{integrationId}/clone
• "Get integration details?" -> GET /org/{orgId}/integrations/{type}
• "List all settings?" -> GET /org/{orgId}/integrations/{integrationId}/settings
• "Create a import?" -> POST /org/{orgId}/integrations/{integrationId}/import
• "Get import details?" -> GET /org/{orgId}/integrations/{integrationId}/import/{jobId}
• "Get project details?" -> GET /org/{orgId}/project/{projectId}
• "Update a project?" -> PUT /org/{orgId}/project/{projectId}
• "Delete a project?" -> DELETE /org/{orgId}/project/{projectId}

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP