{"@context": "https://schema.org", "@type": "WebAPI", "name": "Snyk API API", "description": "The Snyk API is available to customers on [Business and Enterprise plans](https://snyk.io/plans) and allows you to programatically integrate with Snyk. ## REST API We are in the process of building a new, improved API (`https://api.snyk.io/rest`) built using the OpenAPI and JSON API standards. We ", "provider": {"@type": "Organization", "name": "snyk.io"}, "documentation": "https://snyk.docs.apiary.io/api-description-document"}
The Snyk API is available to customers on [Business and Enterprise plans](https://snyk.io/plans) and allows you to programatically integrate with Snyk. ## REST API We are in the process of building a new, improved API (`https://api.snyk.io/rest`) built using the OpenAPI and JSON API standards. We
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.snyk.io/api/v1
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The Snyk API is available to customers on [Business and Enterprise plans](https://snyk.io/plans) and allows you to programatically integrate with Snyk. ## REST API We are in the process of building a new, improved API (`https://api.snyk.io/rest`) built using the OpenAPI and JSON API standards. We welcome you to try it out as we shape and release endpoints until it, ultimately, becomes a full rep
| method | path | what the vendor says it does |
|---|---|---|
POST | /group/{groupId}/audit | Get group level audit logs Audit logs |
GET | /group/{groupId}/members | List all members in a group Groups |
POST | /group/{groupId}/org/{orgId}/members | Add a member to an organization within a group Groups |
GET | /group/{groupId}/orgs | List all organizations in a group Groups |
GET | /group/{groupId}/roles | List all roles in a group Groups |
GET | /group/{groupId}/settings | View group settings Groups |
PUT | /group/{groupId}/settings | Update group settings Groups |
GET | /group/{groupId}/tags | List all tags in a group Groups |
POST | /group/{groupId}/tags/delete | Delete tag from group Groups |
POST | /monitor/dep-graph | Monitor Dep Graph Use this endpoint to monitor a [DepGraph data object](https://github.com/snyk/dep-graph#depg |
POST | /org | Create a new organization Organizations |
DELETE | /org/{orgId} | Remove organization Organizations |
POST | /org/{orgId}/audit | Get organization level audit logs Audit logs |
POST | /org/{orgId}/dependencies | List all dependencies Dependencies |
GET | /org/{orgId}/entitlement/{entitlementKey} | Get an organization's entitlement value Entitlements |
GET | /org/{orgId}/entitlements | List all entitlements Entitlements |
GET | /org/{orgId}/integrations | List Integrations |
POST | /org/{orgId}/integrations | Add new integration Add new integration for given organization. Integrations |
PUT | /org/{orgId}/integrations/{integrationId} | Update existing integration + Update integration's credentials for given organization. Integration must be **n |
DELETE | /org/{orgId}/integrations/{integrationId}/authentication | Delete credentials Removes any credentials set for this integration. If this is a brokered connection the oper |
POST | /org/{orgId}/integrations/{integrationId}/authentication/provision-token | Provision new broker token Issue a new and unique provisional broker token for the brokered integration. Used |
POST | /org/{orgId}/integrations/{integrationId}/authentication/switch-token | Switch between broker tokens Switch the existing broker token with the provisioned token for this integration |
POST | /org/{orgId}/integrations/{integrationId}/clone | Clone an integration (with settings and credentials) Clone an integration, including all of its settings and c |
POST | /org/{orgId}/integrations/{integrationId}/import | Import targets Import Projects |
GET | /org/{orgId}/integrations/{integrationId}/import/{jobId} | Get import job details Import Projects |
GET | /org/{orgId}/integrations/{integrationId}/settings | Retrieve Integrations |
PUT | /org/{orgId}/integrations/{integrationId}/settings | Update Integrations |
GET | /org/{orgId}/integrations/{type} | Get existing integration by type Integrations |
POST | /org/{orgId}/invite | Invite users Organizations |
POST | /org/{orgId}/licenses | List all licenses Licenses |
GET | /org/{orgId}/members | List Members Organizations |
PUT | /org/{orgId}/members/update/{userId} | Update a member's role in the organization Organizations |
PUT | /org/{orgId}/members/{userId} | Update a member in the organization Organizations |
DELETE | /org/{orgId}/members/{userId} | Remove a member from the organization Organizations |
GET | /org/{orgId}/notification-settings | Get organization notification settings Organizations |
PUT | /org/{orgId}/notification-settings | Set notification settings Organizations |
GET | /org/{orgId}/project/{projectId} | Retrieve a single project Projects |
PUT | /org/{orgId}/project/{projectId} | Update a project Projects |
DELETE | /org/{orgId}/project/{projectId} | Delete a project Projects |
POST | /org/{orgId}/project/{projectId}/activate | Activate Activating a project will: - Add a repository webhook for supported integrations. - Enable pull req |
and 63 more operation(s) in this specification, all searchable.
specification origin: https://snyk.docs.apiary.io/api-description-document
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.