Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Snyk API Postman 2.1 Collection
{
"info": {
"_postman_id": "97de3cec-8bcc-4d1f-be6b-30f4e202504e",
"name": "Snyk API",
"description": "The Snyk API is available to customers on [paid plans](https://snyk.io/plans) and allows you to programatically integrate with Snyk.\n\n## API vs CLI vs Snyk integration\n\nThe API detailed below has the ability to test a package for issues, as they are defined by Snyk. It is important to note that for many package managers, using this API will be less accurate than running the [Snyk CLI](https://snyk.io/docs/using-snyk) as part of your build pipe, or just using it locally on your package. The reason for this is that more than one package version fit the requirements given in manifest files. Running the CLI locally tests the actual deployed code, and has an accurate snapshot of the dependency versions in use, while the API can only infer it, with inferior accuracy. It should be noted that the Snyk CLI has the ability to output machine-readable JSON output (with the `--json` flag to `snyk test`).\n\nA third option, is to allow Snyk access to your development flow via the existing [Snyk integrations](https://snyk.io/docs/). The advantage to this approach is having Snyk monitor every new pull request, and suggest fixes by opening new pull requests. This can be achieved either by integrating Snyk directly to your source code management (SCM) tool, or via a broker to allow greater security and auditability.\n\nIf those are not viable options, this API is your best choice.\n\n## API url\n\nThe base URL for all API endpoints is https://snyk.io/api/v1/\n\n## Authorization\n\nTo use this API, you must get your token from Snyk. It can be seen on https://snyk.io/account/ after you register with Snyk and login.\n\nThe token should be supplied in an `Authorization` header with the token, preceded by `token`:\n\n```http\nAuthorization: token API_KEY\n```\n\nOtherwise, a 401 \"Unauthorized\" response will be returned.\n\n```http\nHTTP/1.1 401 Unauthorized\n\n {\n \"code\": 401,\n \"error\": \"Not authorised\",\n \"message\": \"Not authorised\"\n }\n```\n\n## Overview and entities\n\nThe API is a REST API. It has the following entities:\n\n### Test result\n\nThe test result is the object returned from the API giving the results of testing a package for issues. It has the following fields:\n\n| Property | Type | Description | Example |\n|----------------:|---------|-------------------------------------------------------|-----------------------------------------------------------------|\n| ok | boolean | Does this package have one or more issues? | false |\n| issues | object | The issues found. See below for details. | See below |\n| dependencyCount | number | The number of dependencies the package has. | 9 |\n| org | object | The organization this test was carried out for. | {\"name\": \"anOrg\", \"id\": \"5d7013d9-2a57-4c89-993c-0304d960193c\"} |\n| licensesPolicy | object | The organization's licenses policy used for this test | See in the examples |\n| packageManager | string | The package manager for this package | \"maven\" |\n| | | | |\n\n### Issue\n\nAn issue is either a vulnerability or a license issue, according to the organization's policy. It has the following fields:\n\n| Property | Type | Description | Example |\n|---------------:|---------------|----------------------------------------------------------------------------------------------------------------------------|----------------------------------------|\n| id | string | The issue ID | \"SNYK-JS-BACKBONE-10054\" |\n| url | string | A link to the issue details on snyk.io | \"https://snyk.io/vuln/SNYK-JS-BACKBONE-10054 |\n| title | string | The issue title | \"Cross Site Scripting\" |\n| type | string | The issue type: \"license\" or \"vulnerability\". | \"license\" |\n| paths | array | The paths to the dependencies which have an issue, and their corresponding upgrade path (if an upgrade is available). [More information about from and upgrade paths](#introduction/overview-and-entities/from-and-upgrade-paths) | [<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;\"from\": [\"a@1.0.0\", \"b@4.8.1\"],<br>&nbsp;&nbsp;&nbsp;&nbsp;\"upgrade\": [false, \"b@4.8.2\"]<br>&nbsp;&nbsp;}<br>] |\n| package | string | The package identifier according to its package manager | \"backbone\", \"org.apache.flex.blazeds:blazeds\"|\n| version | string | The package version this issue is applicable to. | \"0.4.0\" |\n| severity | string | The Snyk defined severity level: \"critical\", \"high\", \"medium\" or \"low\". - critical in beta until June 28th 2021, to activate critical please follow these instructions: https://updates.snyk.io/critical-severity-level-195891 | \"high\" |\n| language | string | The package's programming language | \"js\" |\n| packageManager | string | The package manager | \"npm\" |\n| semver | array[string] OR map[string]array[string] | One or more [semver](https://semver.org) ranges this issue is applicable to. The format varies according to package manager. | [\"<0.5.0, >=0.4.0\", \"<0.3.8, >=0.3.6\"] OR { \"vulnerable\": [\"[2.0.0, 3.0.0)\"], \"unaffected\": [\"[1, 2)\", \"[3, )\"] } |\n\n### Vulnerability\n\nA vulnerability in a package. In addition to all the fields present in an issue, a vulnerability also has these fields:\n\nProperty | Type | Description | Example |\n----------------:|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|\n publicationTime | Date | The vulnerability publication time | \"2016-02-11T07:16:18.857Z\" |\n disclosureTime | Date | The time this vulnerability was originally disclosed to the package maintainers | \"2016-02-11T07:16:18.857Z\" |\n isUpgradable | boolean | Is this vulnerability fixable by upgrading a dependency? | true |\n description | string | The detailed description of the vulnerability, why and how it is exploitable. Provided in markdown format. | \"## Overview\\n[`org.apache.logging.log4j:log4j-core`](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22log4j-core%22)\\nIn Apache Log4j 2.x before 2.8.2, when using the TCP socket server or UDP socket server to receive serialized log events from another application, a specially crafted binary payload can be sent that, when deserialized, can execute arbitrary code.\\n\\n# Details\\nSerialization is a process of converting an object into a sequence of bytes which can be persisted to a disk or database or can be sent through streams. The reverse process of creating object from sequence of bytes is called deserialization. Serialization is commonly used for communication (sharing objects between multiple hosts) and persistence (store the object state in a file or a database). It is an integral part of popular protocols like _Remote Method Invocation (RMI)_, _Java Management Extension (JMX)_, _Java Messaging System (JMS)_, _Action Message Format (AMF)_, _Java Server Faces (JSF) ViewState_, etc.\\n\\n_Deserialization of untrusted data_ ([CWE-502](https://cwe.mitre.org/data/definitions/502.html)), is when the application deserializes untrusted data without sufficiently verifying that the resulting data will be valid, letting the attacker to control the state or the flow of the execution. \\n\\nJava deserialization issues have been known for years. However, interest in the issue intensified greatly in 2015, when classes that could be abused to achieve remote code execution were found in a [popular library (Apache Commons Collection)](https://snyk.io/vuln/SNYK-JAVA-COMMONSCOLLECTIONS-30078). These classes were used in zero-days affecting IBM WebSphere, Oracle WebLogic and many other products.\\n\\nAn attacker just needs to identify a piece of software that has both a vulnerable class on its path, and performs deserialization on untrusted data. Then all they need to do is send the payload into the deserializer, getting the command executed.\\n\\n> Developers put too much trust in Java Object Serialization. Some even de-serialize objects pre-authentication. When deserializing an Object in Java you typically cast it to an expected type, and therefore Java's strict type system will ensure you only get valid object trees. Unfortunately, by the time the type checking happens, platform code has already created and executed significant logic. So, before the final type is checked a lot of code is executed from the readObject() methods of various objects, all of which is out of the developer's control. By combining the readObject() methods of various classes which are available on the classpath of the vulnerable application an attacker can execute functions (including calling Runtime.exec() to execute local OS commands).\\n- Apache Blog\\n\\n\\n## References\\n- [NVD](https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2017-5645)\\n- [jira issue](https://issues.apache.org/jira/browse/LOG4J2-1863)\\n\" |\n isPatchable | boolean | Is this vulnerability fixable by using a Snyk supplied patch? | true |\n isPinnable | boolean | Is this vulnerability fixable by pinning a transitive dependency | true |\n identifiers | object | Additional vulnerability identifiers | {\"CWE\": [], \"CVE\": [\"CVE-2016-2402]} |\n credit | string | The reporter of the vulnerability | \"Snyk Security Team\" |\n CVSSv3 | string | Common Vulnerability Scoring System (CVSS) provides a way to capture the principal characteristics of a vulnerability, and produce a numerical score reflecting its severity, as well as a textual representation of that score. | \"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:N/A:N\" |\n cvssScore | number | CVSS Score | 5.3 |\n patches | array | Patches to fix this issue, by snyk | see \"Patch\" below. |\n upgradePath | object | The path to upgrade this issue, if applicable | see below |\n isPatched | boolean | Is this vulnerability patched? | false |\n exploitMaturity | string | The snyk exploit maturity level\n\n#### Patch\n\nA patch is an object like this one:\n\n```json\n{\n \"urls\": [\n \"https://snyk-patches.s3.amazonaws.com/npm/backbone/20110701/backbone_20110701_0_0_0cdc525961d3fa98e810ffae6bcc8e3838e36d93.patch\"\n ],\n \"version\": \"<0.5.0 >=0.3.3\",\n \"modificationTime\": \"2015-11-06T02:09:36.180Z\",\n \"comments\": [\n \"https://github.com/jashkenas/backbone/commit/0cdc525961d3fa98e810ffae6bcc8e3838e36d93.patch\"\n ],\n \"id\": \"patch:npm:backbone:20110701:0\"\n}\n```\n\n### From and upgrade paths\n\nBoth from and upgrade paths are arrays, where each item within the array is a package `name@version`.\n\nTake the following `from` path:\n\n```\n[\n \"my-project@1.0.0\",\n \"actionpack@4.2.5\",\n \"rack@1.6.4\"\n]\n```\n\nAssuming this was returned as a result of a test, then we know:\n\n- The package that was tested was `my-project@1.0.0`\n\n- The dependency with an issue was included in the tested package via the direct dependency `actionpack@4.2.5`\n\n- The dependency with an issue was [rack@1.6.4](https://snyk.io/vuln/rubygems:rack@1.6.4)\n\nTake the following `upgrade` path:\n\n```\n[\n false,\n \"actionpack@5.0.0\",\n \"rack@2.0.1\"\n]\n```\n\nAssuming this was returned as a result of a test, then we know:\n\n- The package that was tested is not upgradable (`false`)\n\n- The direct dependency `actionpack` should be upgraded to at least version `5.0.0` in order to fix the issue\n\n- Upgrading `actionpack` to version `5.0.0` will cause `rack` to be installed at version `2.0.1`\n\nIf the `upgrade` path comes back as an empty array (`[]`) then this means that there is no upgrade path available which would fix the issue.\n\n### License issue\n\nA license issue has no additional fields other than the ones in \"Issue\".\n\n### Snyk organization\n\nThe organization in Snyk this request is applicable to. The organization determines the access rights, licenses policy and is the unit of billing for private projects.\n\nA Snyk organization has these fields:\n\nProperty | Type | Description | Example |\n-----------:| ------ | ----------------------------- | -------------------------------------- |\nname | string | The organization display name | \"deelmaker\" |\nid | string | The ID of the organization | \"3ab0f8d3-b17d-4953-ab6d-e1cbfe1df385\" |\n\n## Errors\n\nThis is a beta release of this API. Therefore, despite our efforts, errors might occur. In the unlikely event of such an error, it will have the following structure as JSON in the body:\n\nProperty | Type | Description | Example |\n-----------:| ------ | ----------------------------- | -------------------------------------- |\nmessage | string | Error message with reference | Error calling Snyk api (reference: 39db46b1-ad57-47e6-a87d-e34f6968030b) |\nerrorRef | V4 uuid | An error ref to contact Snyk with | 39db46b1-ad57-47e6-a87d-e34f6968030b |\n\nThe error reference will also be supplied in the `x-error-reference` header in the server reply.\n\nExample response:\n\n```http\nHTTP/1.1 500 Internal Server Error\nx-error-reference: a45ec9c1-065b-4f7b-baf8-dbd1552ffc9f\nContent-Type: application/json; charset=utf-8\nContent-Length: 1848\nVary: Accept-Encoding\nDate: Sun, 10 Sep 2017 06:48:40 GMT\n```\n\n## Rate Limiting\n\nTo ensure resilience against increasing request rates, we are starting to introduce rate-limiting.\nWe are monitoring the rate-limiting system to ensure minimal impact on users while ensuring system stability.\nCurrent limit is up to 2000 requests per minute, per user. This limit is above industry standards, and is subject to change. As such, we recommend calls to the API are throttled regardless of the current limit.\nAll requests above the limit will get a response with status code `429` - `Too many requests` until requests stop for the duration of the rate-limiting interval (currently a minute).\n\n## Consuming Webhooks\n\nWebhooks are delivered with a `Content-Type` of `application/json`, with the event payload as JSON in the request body. We also send the following headers:\n\n- `X-Snyk-Event` - the name of the event\n\n- `X-Snyk-Transport-ID` - a GUID to identify this delivery\n\n- `X-Snyk-Timestamp` - an ISO 8601 timestamp for when the event occurred, for example: `2020-09-25T15:27:53Z`\n\n- `X-Hub-Signature` - the HMAC hex digest of the request body, used to secure your webhooks and ensure the request did indeed come from Snyk\n\n- `User-Agent` - identifies the origin of the request, for example: `Snyk-Webhooks/XXX`\n\n---\n\nAfter your server is configured to receive payloads, it listens for any payload sent to the endpoint you configured. For security reasons, you should limit requests to those coming from Snyk.\n\n### Validating payloads\n\nAll transports sent to your webhooks have a `X-Hub-Signature` header, which contains the hash signature for the transport. The signature is a HMAC hexdigest of the request body, generated using sha256 and your `secret` as the HMAC key.\n\nYou could use a function in Node.JS such as the following to validate these signatures on incoming requests from Snyk:\n\n```javascript\nimport * as crypto from 'crypto';\n\nfunction verifySignature(request, secret) {\n const hmac = crypto.createHmac('sha256', secret);\n const buffer = JSON.stringify(request.body);\n hmac.update(buffer, 'utf8');\n\n const signature = `sha256=${hmac.digest('hex')}`;\n\n return signature === request.headers['x-hub-signature'];\n}\n```\n\n### Payload versioning\n\nPayloads may evolve over time, and so are versioned. Payload versions are supplied as a suffix to the `X-Snyk-Event` header. For example, `project_snapshot/v0` indicates that the payload is `v0` of the `project_snapshot` event.\n\nVersion numbers only increment when a breaking change is made; for example, removing a field that used to exist, or changing the name of a field. Version numbers do not increment when making an additive change, such as adding a new field that never existed before.\n\n**Note:** During the BETA phase, the structure of webhook payloads may change at any time, so we recommend you check the payload version.\n\n### Event types\n\nWhile consuming a webhook event, `X-Snyk-Event` header must be checked, as an end-point may receive multiple event types.\n\n#### ping\n\nThe ping event happens after a new webhook is created, and can also be manually triggered using the ping webhook API. This is useful to test that your webhook receives data from Snyk correctly.\n\nThe `ping` event makes the following request:\n\n```jsx\nPOST /webhook-handler/snyk123 HTTP/1.1\nHost: my.app.com\nX-Snyk-Event: ping/v0\nX-Snyk-Transport-ID: 998fe884-18a0-45db-8ae0-e379eea3bc0a\nX-Snyk-Timestamp: 2020-09-25T15:27:53Z\nX-Hub-Signature: sha256=7d38cdd689735b008b3c702edd92eea23791c5f6\nUser-Agent: Snyk-Webhooks/044aadd\nContent-Type: application/json\n{ \n \"webhookId\": \"d3cf26b3-2d77-497b-bce2-23b33cc15362\"\n}\n```\n\n#### project_snapshot\n\nThis event is triggered every time an existing project is tested and a new snapshot is created. It is triggered on every test of a project, whether or not there are new issues. This event is not triggered when a new project is created or imported.\n\n```jsx\nPOST /webhook-handler/snyk123 HTTP/1.1\nHost: my.app.com\nX-Snyk-Event: project_snapshot/v0\nX-Snyk-Transport-ID: 998fe884-18a0-45db-8ae0-e379eea3bc0a\nX-Snyk-Timestamp: 2020-09-25T15:27:53Z\nX-Hub-Signature: sha256=7d38cdd689735b008b3c702edd92eea23791c5f6\nUser-Agent: Snyk-Webhooks/044aadd\nContent-Type: application/json\n{\n \"project\": { ... }, // project object matching API responses\n \"org\": { ... }, // org object matching API responses\n \"group\": { ... }, // group object matching API responses\n \"newIssues\": [], // array of issues object matching API responses\n}\n```\n\n#### Detailed example of a payload\n\n##### project\n\nsee: [https://snyk.docs.apiary.io/#reference/projects](https://snyk.docs.apiary.io/#reference/projects)\n\n```tsx\n\"project\": {\n \"name\": \"snyk/goof\",\n \"id\": \"af137b96-6966-46c1-826b-2e79ac49bbd9\",\n \"created\": \"2018-10-29T09:50:54.014Z\",\n \"origin\": \"github\",\n \"type\": \"maven\",\n \"readOnly\": false,\n \"testFrequency\": \"daily\",\n \"totalDependencies\": 42,\n \"issueCountsBySeverity\": {\n \"low\": 13,\n \"medium\": 8,\n \"high\": 4\n },\n \"imageId\": \"sha256:caf27325b298a6730837023a8a342699c8b7b388b8d878966b064a1320043019\",\n \"imageTag\": \"latest\",\n \"imageBaseImage\": \"alpine:3\",\n \"imagePlatform\": \"linux/arm64\",\n \"imageCluster\": \"Production\",\n \"hostname\": null,\n \"remoteRepoUrl\": \"https://github.com/snyk/goof.git\",\n \"lastTestedDate\": \"2019-02-05T08:54:07.704Z\",\n \"browseUrl\": \"https://app.snyk.io/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/af137b96-6966-46c1-826b-2e79ac49bbd9\",\n \"importingUser\": {\n \"id\": \"e713cf94-bb02-4ea0-89d9-613cce0caed2\",\n \"name\": \"example-user@snyk.io\",\n \"username\": \"exampleUser\",\n \"email\": \"example-user@snyk.io\"\n },\n \"isMonitored\": false,\n \"branch\": null,\n \"tags\": [\n {\n \"key\": \"example-tag-key\",\n \"value\": \"example-tag-value\"\n }\n ],\n \"attributes\": {\n \"criticality\": [\n \"high\"\n ],\n \"environment\": [\n \"backend\"\n ],\n \"lifecycle\": [\n \"development\"\n ]\n },\n \"remediation\": {\n \"upgrade\": {},\n \"patch\": {},\n \"pin\": {}\n }\n}\n```\n\n##### org\n\nsee: [https://snyk.docs.apiary.io/#reference/organizations](https://snyk.docs.apiary.io/#reference/organizations)\n\n```tsx\n\"org\": {\n \"name\": \"My Org\",\n \"id\": \"a04d9cbd-ae6e-44af-b573-0556b0ad4bd2\",\n \"slug\": \"my-org\",\n \"url\": \"https://api.snyk.io/org/my-org\",\n \"created\": \"2020-11-18T10:39:00.983Z\"\n}\n```\n\n##### group\n\nsee: [https://snyk.docs.apiary.io/#reference/groups](https://snyk.docs.apiary.io/#reference/groups)\n\n```tsx\n\"group\": {\n \"name\": \"ACME Inc.\",\n \"id\": \"a060a49f-636e-480f-9e14-38e773b2a97f\"\n}\n```\n\n##### issue\n\nsee: https://snyk.docs.apiary.io/#reference/users/user-organization-notification-settings/list-all-aggregated-issues\n\n```tsx\n{\n \"id\": \"npm:ms:20170412\",\n \"issueType\": \"vuln\",\n \"pkgName\": \"ms\",\n \"pkgVersions\": [\n \"1.0.0\"\n ],\n \"issueData\": {\n \"id\": \"npm:ms:20170412\",\n \"title\": \"Regular Expression Denial of Service (ReDoS)\",\n \"severity\": \"low\",\n \"url\": \"https://snyk.io/vuln/npm:ms:20170412\",\n \"description\": \"Lorem ipsum\",\n \"identifiers\": {\n \"CVE\": [],\n \"CWE\": [\n \"CWE-400\"\n ],\n \"ALTERNATIVE\": [\n \"SNYK-JS-MS-10509\"\n ]\n },\n \"credit\": [\n \"Snyk Security Research Team\"\n ],\n \"exploitMaturity\": \"no-known-exploit\",\n \"semver\": {\n \"vulnerable\": [\n \">=0.7.1 <2.0.0\"\n ]\n },\n \"publicationTime\": \"2017-05-15T06:02:45Z\",\n \"disclosureTime\": \"2017-04-11T21:00:00Z\",\n \"CVSSv3\": \"CVSS:3.0/AV:N/AC:H/PR:N/UI:N/S:U/C:N/I:N/A:L\",\n \"cvssScore\": 3.7,\n \"language\": \"js\",\n \"patches\": [\n {\n \"id\": \"patch:npm:ms:20170412:2\",\n \"urls\": [\n \"https://snyk-patches.s3.amazonaws.com/npm/ms/20170412/ms_071.patch\"\n ],\n \"version\": \"=0.7.1\",\n \"comments\": [],\n \"modificationTime\": \"2019-12-03T11:40:45.866206Z\"\n }\n ],\n \"nearestFixedInVersion\": \"2.0.0\"\n },\n \"isPatched\": false,\n \"isIgnored\": false,\n \"fixInfo\": {\n \"isUpgradable\": false,\n \"isPinnable\": false,\n \"isPatchable\": true,\n \"nearestFixedInVersion\": \"2.0.0\"\n },\n \"priority\": {\n \"score\": 399,\n \"factors\": [\n {\n \"name\": \"isFixable\",\n \"description\": \"Has a fix available\"\n },\n {\n \"name\": \"cvssScore\",\n \"description\": \"CVSS 3.7\"\n }\n ]\n }\n}\n```",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "General",
"item": [
{
"name": "General API documentation",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
""
]
}
},
"response": []
}
]
},
{
"name": "Users",
"item": [
{
"name": "Get User Details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/user/:userId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"user",
":userId"
],
"variable": [
{
"key": "userId",
"value": "{{user_id}}"
}
]
}
},
"response": []
},
{
"name": "Get My Details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/user/me",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"user",
"me"
]
},
"description": "Retrieves information about the the user making the request."
},
"response": []
},
{
"name": "Get org notification settings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/user/me/notification-settings/org/{{org_id}}",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"user",
"me",
"notification-settings",
"org",
"{{org_id}}"
]
},
"description": "The organization notification settings for the user that will determine which emails are sent."
},
"response": []
},
{
"name": "Modify org notification settings",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"new-issues-remediations\": {\r\n \"enabled\": true,\r\n \"issueSeverity\": \"high\",\r\n \"issueType\": \"vuln\"\r\n },\r\n \"project-imported\": {\r\n \"enabled\": true\r\n },\r\n \"test-limit\": {\r\n \"enabled\": true\r\n },\r\n \"weekly-report\": {\r\n \"enabled\": true\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/user/me/notification-settings/org/:orgId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"user",
"me",
"notification-settings",
"org",
":orgId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}"
}
]
},
"description": "The organization notification settings for the user that will determine which emails are sent."
},
"response": []
},
{
"name": "Get project notification settings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/user/me/notification-settings/org/:orgId/project/:projectId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"user",
"me",
"notification-settings",
"org",
":orgId",
"project",
":projectId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to return notification settings for."
}
]
},
"description": "The project notification settings for the user that will determine which emails are sent."
},
"response": []
},
{
"name": "Modify project notification settings",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"new-issues-remediations\": {\r\n \"enabled\": true,\r\n \"issueSeverity\": \"high\",\r\n \"issueType\": \"vuln\"\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/user/me/notification-settings/org/:orgId/project/:projectId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"user",
"me",
"notification-settings",
"org",
":orgId",
"project",
":projectId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}"
},
{
"key": "projectId",
"value": "{{project_id}}"
}
]
},
"description": "The project notification settings for the user that will determine which emails are sent."
},
"response": []
}
],
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
}
]
},
{
"name": "Groups",
"item": [
{
"name": "View group settings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/group/:groupId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"group",
":groupId",
"settings"
],
"variable": [
{
"key": "groupId",
"value": "{{group_id}}",
"description": "The group ID. The `API_KEY` must have admin access to this group."
}
]
}
},
"response": []
},
{
"name": "Update group settings",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"sessionLength\": 50,\r\n \"requestAccess\": {\r\n \"enabled\": true\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/group/:groupId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"group",
":groupId",
"settings"
],
"variable": [
{
"key": "groupId",
"value": "{{group_id}}",
"description": "The group ID. The `API_KEY` must have admin access to this group."
}
]
}
},
"response": []
},
{
"name": "List all members in a group",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/group/:groupId/members",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"group",
":groupId",
"members"
],
"variable": [
{
"key": "groupId",
"value": "{{group_id}}",
"description": "The group ID. The `API_KEY` must have access admin to this group."
}
]
}
},
"response": []
},
{
"name": "Add a member to an organization within a group",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"userId\": \"\",\r\n \"role\": \"\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/group/:groupId/org/:orgId/members",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"group",
":groupId",
"org",
":orgId",
"members"
],
"variable": [
{
"key": "groupId",
"value": "{{group_id}}",
"description": "The group ID. The `API_KEY` must have access admin to this group."
},
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID we want to add the member to. The `API_KEY` must have access to this organization."
}
]
}
},
"response": []
},
{
"name": "List all tags in a group",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/group/:groupId/tags?perPage=10&page=1",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"group",
":groupId",
"tags"
],
"query": [
{
"key": "perPage",
"value": "10",
"description": "The number of results to return (the default is 1000)."
},
{
"key": "page",
"value": "1",
"description": "The offset from which to start returning results from."
}
],
"variable": [
{
"key": "groupId",
"value": "{{group_id}}",
"description": "The group ID. The `API_KEY` must have access admin to this group."
}
]
}
},
"response": []
},
{
"name": "Delete tag from group",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"key\": \"\",\r\n \"value\": \"\",\r\n \"force\": false\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/group/:groupId/tags/delete",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"group",
":groupId",
"tags",
"delete"
],
"variable": [
{
"key": "groupId",
"value": "{{group_id}}",
"description": "The group ID. The `API_KEY` must have access admin to this group."
}
]
}
},
"response": []
},
{
"name": "List all organizations in a group",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/group/:groupId/orgs?perPage=100&page=1&name=my",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"group",
":groupId",
"orgs"
],
"query": [
{
"key": "perPage",
"value": "100",
"description": "The number of results to return (maximum/default is 100)."
},
{
"key": "page",
"value": "1",
"description": "For pagination - offset (from which to start returning results)."
},
{
"key": "name",
"value": "my",
"description": "Only organizations that have a name that **starts with** this value (case insensitive) will be returned."
}
],
"variable": [
{
"key": "groupId",
"value": "{{group_id}}",
"description": "The group ID. The `API_KEY` must have READ access to this group and LIST organizations access in this group."
}
]
}
},
"response": []
}
],
"description": "A group is a set of multiple organizations."
},
{
"name": "Organizations",
"item": [
{
"name": "List all the organizations a user belongs to",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/orgs",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"orgs"
]
},
"description": "Each request to Snyk has to be done in the context of a Snyk organization. If no org is specified, the user's default organization (user is identified according to the `API_KEY`) will be used.\nThe organization determines the access rights, licenses policy and is the unit of billing for private projects.\n\nAn organization should be given as a query parameter named `org`, with the public identifier given to this org. The list of organizations and their corresponding public ids can be found with the org resource."
},
"response": []
},
{
"name": "Create a new organization",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"name\": \"new-org\",\r\n \"groupId\": \"4a18d42f-0706-4ad0-b127-24078731fbed\",\r\n \"sourceOrgId\": \"6b4a3261-b68f-43a0-9218-1f082e77f879\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org"
]
},
"description": "An organization can be created as part of a group, or independently. If the **groupId** is not provided, a **Personal Org** will be created independent of a group."
},
"response": []
},
{
"name": "Get org notification settings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/notification-settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"notification-settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
}
]
},
"description": "Manage the default settings for org notifications. These will be used as defaults, but can be re-defined by org members."
},
"response": []
},
{
"name": "Set notification settings",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"new-issues-remediations\": {\r\n \"enabled\": true,\r\n \"issueSeverity\": \"high\",\r\n \"issueType\": \"vuln\"\r\n },\r\n \"project-imported\": {\r\n \"enabled\": true\r\n },\r\n \"test-limit\": {\r\n \"enabled\": true\r\n },\r\n \"weekly-report\": {\r\n \"enabled\": true\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/notification-settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"notification-settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}"
}
]
},
"description": "Manage the default settings for org notifications. These will be used as defaults, but can be re-defined by org members."
},
"response": []
},
{
"name": "Invite users",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"email\": \"\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/invite",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"invite"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
}
]
},
"description": "Invite users to the organization by email."
},
"response": []
},
{
"name": "List Members",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/members?includeGroupAdmins=true",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"members"
],
"query": [
{
"key": "includeGroupAdmins",
"value": "true",
"description": "Include group administrators who also have access to this organization."
}
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
}
]
},
"description": "Manage members in your organization."
},
"response": []
},
{
"name": "View organization settings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
}
]
}
},
"response": []
},
{
"name": "Update organization settings",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"requestAccess\": {\r\n \"enabled\": true\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
}
]
},
"description": "Settings that are not provided will not be modified."
},
"response": []
},
{
"name": "Update a member in the organization",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"role\": \"\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/members/:userId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"members",
":userId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
},
{
"key": "userId",
"value": "{{user_id}}",
"description": "The user ID."
}
]
},
"description": "Manage member's roles in your organization."
},
"response": []
},
{
"name": "Remove a member from the organization",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/members/:userId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"members",
":userId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must admin have access to this organization."
},
{
"key": "userId",
"value": "{{user_id}}",
"description": "The user ID we want to remove."
}
]
},
"description": "Manage member's roles in your organization."
},
"response": []
},
{
"name": "Update a member's role in the organization",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"rolePublicId\": \"\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/members/update/:userId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"members",
"update",
":userId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
},
{
"key": "userId",
"value": "{{user_id}}",
"description": "The user ID."
}
]
},
"description": "Update member's role in your organization by role publicId."
},
"response": []
},
{
"name": "Remove organization",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId"
],
"variable": [
{
"key": "orgId",
"value": "{{user_id}}",
"description": "The organization ID. The `API_KEY` must have permission to delete the provided organization. Currently this operation is only supported for organizations without any projects."
}
]
}
},
"response": []
}
]
},
{
"name": "Integrations",
"item": [
{
"name": "List",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
}
]
}
},
"response": []
},
{
"name": "Add new integration",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"google-artifact-cr\",\r\n \"credentials\": {\r\n \"username\": \"username16\",\r\n \"password\": \"password16\",\r\n \"registryBase\": \"registryBase16\"\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
}
]
},
"description": "Add new integration for given organization."
},
"response": []
},
{
"name": "Update existing integration",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"github\",\r\n \"broker\": {\r\n \"enabled\": true\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_Id}}",
"description": "The unique identifier for the configured integration. This can be found on the [Integration page in the Settings area](https://app.snyk.io/manage/integrations) for all integrations that have been configured."
}
]
},
"description": "+ Update integration's credentials for given organization. Integration must be **not brokered**\n\n+ Enable or disable brokered integration for given organization. *Credentials required for disabling brokered integration*\n\nExamples in right section:\n\n1. Set up a broker for an existing integration\n\n2. Update credentials for an existing non-brokered integration\n\n3. Disable broker for an existing integration"
},
"response": []
},
{
"name": "Delete credentials",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId/authentication",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId",
"authentication"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_id}}",
"description": "The integration ID."
}
]
},
"description": "Removes any credentials set for this integration. If this is a brokered connection the operation will have no effect."
},
"response": []
},
{
"name": "Provision new broker token",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId/authentication/provision-token",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId",
"authentication",
"provision-token"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The `API_KEY` must have access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_id}}"
}
]
},
"description": "Issue a new and unique provisional broker token for the brokered integration.\n\nUsed for zero down-time token rotation with the Snyk Broker. Once provisioned, the token can be used to initialize a new broker client before using the switch API to update the token in use by the integration.\n\nThe new provisional token will fail to be created if the integration, or any other integration in the same group, already has one provisioned."
},
"response": []
},
{
"name": "Switch between broker tokens",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId/authentication/switch-token",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId",
"authentication",
"switch-token"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The `API_KEY` must have access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_id}}"
}
]
},
"description": "Switch the existing broker token with the provisioned token for this integration and any other in the same group.\nOnly perform this action when you have a Broker client running with the provisioned token.\nThis action will fail if there is no token provisioned for this integration or any integration in the same group."
},
"response": []
},
{
"name": "Clone an integration (with settings and credentials)",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"destinationOrgPublicId\": \"9a3e5d90-b782-468a-a042-9a2073736f0b1\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId/clone",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId",
"clone"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The `API_KEY` must have access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_id}}"
}
]
},
"description": "Clone an integration, including all of its settings and credentials from one org to another org in the same group.\nThis API supports both brokered and non-brokered integrations.\n\nUse this API for when you want to share a Broker token between several Snyk orgs (integrations)."
},
"response": []
},
{
"name": "Get existing integration by type",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:type",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":type"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The `API_KEY` must have admin access to this organization."
},
{
"key": "type",
"value": "github",
"description": "Integration type."
}
]
}
},
"response": []
},
{
"name": "Import",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"target\": {\r\n \"owner\": \"\",\r\n \"name\": \"\",\r\n \"branch\": \"\"\r\n },\r\n \"files\": [\r\n {\r\n \"path\": \"\"\r\n }\r\n ]\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId/import",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId",
"import"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_id}}",
"description": "The unique identifier for the configured integration. This can be found on the [Integration page in the Settings area](https://app.snyk.io/manage/integrations) for all integrations that have been configured."
}
]
}
},
"response": []
},
{
"name": "Get import job details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId/import/:jobId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId",
"import",
":jobId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_id}}",
"description": "The unique identifier for the configured integration. This can be found on the [Integration page in the Settings area](https://app.snyk.io/manage/integrations) for all integrations that have been configured."
},
{
"key": "jobId",
"value": "{{job_id}}",
"description": "The ID of the job."
}
]
}
},
"response": []
},
{
"name": "Retrieve",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId",
"settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_id}}",
"description": "The unique identifier for the configured integration. This can be found on the [Integration page in the Settings area](https://app.snyk.io/manage/integrations) for all integrations that have been configured."
}
]
}
},
"response": []
},
{
"name": "Update",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"autoDepUpgradeLimit\": 2,\r\n \"autoDepUpgradeIgnoredDependencies\": [],\r\n \"autoDepUpgradeEnabled\": false,\r\n \"autoDepUpgradeMinAge\": 21,\r\n \"pullRequestTestEnabled\": true,\r\n \"pullRequestFailOnAnyVulns\": false,\r\n \"pullRequestFailOnlyForHighSeverity\": true,\r\n \"pullRequestAssignment\": \"{\\\"enabled\\\":true,\\\"type\\\":\\\"manual\\\",\\\"assignees\\\":[\\\"username\\\"]}\",\r\n \"autoRemediationPrs\": {\r\n \"backlogPrsEnabled\": false,\r\n \"freshPrsEnabled\": true,\r\n \"usePatchRemediation\": false\r\n },\r\n \"manualRemediationPrs\": {\r\n \"useManualPatchRemediation\": false\r\n },\r\n \"dockerfileSCMEnabled\": true\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/integrations/:integrationId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"integrations",
":integrationId",
"settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have admin access to this organization."
},
{
"key": "integrationId",
"value": "{{integration_id}}",
"description": "The unique identifier for the configured integration. This can be found on the [Integration page in the Settings area](https://app.snyk.io/manage/integrations) for all integrations that have been configured."
}
]
}
},
"response": []
}
],
"description": "Integrations are connections to places where code lives. They can be configured from the [Integration page in the Settings area](https://app.snyk.io/manage/integrations) page."
},
{
"name": "Projects",
"item": [
{
"name": "List all projects",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"filters\": {\r\n \"name\": \"snyk/goof\",\r\n \"origin\": \"github\",\r\n \"type\": \"maven\",\r\n \"isMonitored\": false,\r\n \"tags\": {\r\n \"includes\": [\r\n \"includes26\"\r\n ]\r\n },\r\n \"attributes\": \"attributes26\"\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/projects",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"projects"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to list projects for. The `API_KEY` must have access to this organization."
}
]
}
},
"response": []
},
{
"name": "Retrieve a single project",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID the project belongs to. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID."
}
]
}
},
"response": []
},
{
"name": "Update a project",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"owner\": {\r\n \"id\": \"1acd4d09-5602-4d04-9640-045fe928aaea\"\r\n },\r\n \"branch\": \"main\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID the project belongs to. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID."
}
]
}
},
"response": []
},
{
"name": "Delete a project",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID the project belongs to. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID."
}
]
}
},
"response": []
},
{
"name": "Deactivate",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/deactivate",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"deactivate"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID the project belongs to. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID."
}
]
},
"description": "Deactivating a project will:\n\n- Remove any webhooks from the supported integrations related to the project.\n\n- Disable pull request tests for new vulnerabilities.\n\n- Disable Fix pull request from being opened for newly disclosed vulnerabilities.\n\n- Disable recurring tests - email alerts about newly disclosed vulnerabilities will be turned off."
},
"response": []
},
{
"name": "Activate",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/activate",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"activate"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID the project belongs to. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID."
}
]
},
"description": "Activating a project will:\n\n- Add a repository webhook for supported integrations.\n\n- Enable pull request tests for new vulnerabilities.\n\n- Open Fix pull request for newly disclosed vulnerabilities.\n\n- Enable recurring tests, sending email alerts about newly disclosed vulnerabilities."
},
"response": []
},
{
"name": "List all issues - DEPRECATED",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"filters\": {\r\n \"severities\": [\r\n \"critical\",\r\n \"high\",\r\n \"medium\",\r\n \"low\"\r\n ],\r\n \"exploitMaturity\": [\r\n \"mature\",\r\n \"proof-of-concept\",\r\n \"no-known-exploit\",\r\n \"no-data\"\r\n ],\r\n \"types\": [\r\n \"vuln\",\r\n \"license\"\r\n ],\r\n \"ignored\": false,\r\n \"patched\": false,\r\n \"priorityScore\": {\r\n \"min\": 0,\r\n \"max\": 1000\r\n }\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/issues",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"issues"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to return issues for."
}
]
},
"description": "This endpoint is deprecated, please use `Aggregated Project issues` instead."
},
"response": []
},
{
"name": "List all Aggregated issues",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"includeDescription\": false,\r\n \"includeIntroducedThrough\": false,\r\n \"filters\": {\r\n \"severities\": [\r\n \"critical\",\r\n \"high\",\r\n \"medium\",\r\n \"low\"\r\n ],\r\n \"exploitMaturity\": [\r\n \"mature\",\r\n \"proof-of-concept\",\r\n \"no-known-exploit\",\r\n \"no-data\"\r\n ],\r\n \"types\": [\r\n \"vuln\",\r\n \"license\"\r\n ],\r\n \"ignored\": false,\r\n \"patched\": false,\r\n \"priority\": {\r\n \"score\": {\r\n \"min\": 0,\r\n \"max\": 1000\r\n }\r\n }\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/aggregated-issues",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"aggregated-issues"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to return issues for."
}
]
}
},
"response": []
},
{
"name": "List all project snapshots",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"filters\": {\r\n \"imageId\": \"sha256:a368cbcfa6789bc347345f6d78902afe138b62ff5373d2aa5f37120277c90a67\"\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/history?perPage=:perPage&page=:page",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"history"
],
"query": [
{
"key": "perPage",
"value": ":perPage"
},
{
"key": "page",
"value": ":page"
}
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to return snapshots for."
}
]
}
},
"response": []
},
{
"name": "List all project snapshot aggregated issues",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"includeDescription\": false,\r\n \"includeIntroducedThrough\": false,\r\n \"filters\": {\r\n \"severities\": [\r\n \"critical\",\r\n \"high\",\r\n \"medium\",\r\n \"low\"\r\n ],\r\n \"exploitMaturity\": [\r\n \"mature\",\r\n \"proof-of-concept\",\r\n \"no-known-exploit\",\r\n \"no-data\"\r\n ],\r\n \"types\": [\r\n \"vuln\",\r\n \"license\"\r\n ],\r\n \"ignored\": false,\r\n \"patched\": false,\r\n \"priority\": {\r\n \"score\": {\r\n \"min\": 0,\r\n \"max\": 1000\r\n }\r\n }\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/history/:snapshotId/aggregated-issues",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"history",
":snapshotId",
"aggregated-issues"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "6d5813be-7e6d-4ab8-80c2-1e3e2a454545",
"description": "The project ID."
},
{
"key": "snapshotId",
"value": "6d5813be-7e6d-4ab8-80c2-1e3e2a454553",
"description": "The snapshot ID."
}
]
}
},
"response": []
},
{
"name": "Get Project dependency graph",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/dep-graph",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"dep-graph"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to return issues for."
}
]
}
},
"response": []
},
{
"name": "List all ignores",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/ignores",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"ignores"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to list ignores for. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to list ignores for."
}
]
},
"description": "Ignores from `.snyk` files are not included here.Temporary ignores include an `expires` attribute, while permanent ignores do not."
},
"response": []
},
{
"name": "Retrieve ignore",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/ignore/:issueId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"ignore",
":issueId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to modify ignores for. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to modify ignores for."
},
{
"key": "issueId",
"value": "npm:qs:20140806-1",
"description": "The issue ID to modify ignores for."
}
]
},
"description": "Ignores from `.snyk` files are not included here."
},
"response": []
},
{
"name": "Add ignore",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"ignorePath\": \"\",\r\n \"reason\": \"\",\r\n \"reasonType\": \"not-vulnerable\",\r\n \"disregardIfFixable\": false,\r\n \"expires\": \"\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/ignore/:issueId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"ignore",
":issueId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to modify ignores for. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to modify ignores for."
},
{
"key": "issueId",
"value": "npm:qs:20140806-1",
"description": "The issue ID to modify ignores for."
}
]
},
"description": "Ignores from `.snyk` files are not included here."
},
"response": []
},
{
"name": "Replace ignores",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "[\r\n {\r\n \"ignorePath\": \"\",\r\n \"reason\": \"\",\r\n \"reasonType\": \"not-vulnerable\",\r\n \"disregardIfFixable\": false,\r\n \"expires\": \"\"\r\n }\r\n]"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/ignore/:issueId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"ignore",
":issueId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to modify ignores for. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to modify ignores for."
},
{
"key": "issueId",
"value": "npm:qs:20140806-1",
"description": "The issue ID to modify ignores for."
}
]
},
"description": "Ignores from `.snyk` files are not included here."
},
"response": []
},
{
"name": "Delete ignores",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/ignore/:issueId",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"ignore",
":issueId"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to modify ignores for. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to modify ignores for."
},
{
"key": "issueId",
"value": "npm:qs:20140806-1",
"description": "The issue ID to modify ignores for."
}
]
},
"description": "Ignores from `.snyk` files are not included here."
},
"response": []
},
{
"name": "List all jira issues",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/jira-issues",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"jira-issues"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to list Jira issues for. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to list Jira issues for."
}
]
},
"description": "If you have configured an integration with Jira, it is possible to create Jira issues for project vulnerabilities or license issues directly from the Snyk API.\n\nThe Jira integration is available to customers on the pro or enterprise plan."
},
"response": []
},
{
"name": "Create jira issue",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"fields\": {\r\n \"project\": {},\r\n \"issueType\": {},\r\n \"summary\": \"\"\r\n }\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/issue/:issueId/jira-issue",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"issue",
":issueId",
"jira-issue"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to list Jira issues for. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to list Jira issues for."
},
{
"key": "issueId",
"value": "npm:qs:20140806-1",
"description": "The issue ID to create Jira issue for."
}
]
},
"description": "If you have configured an integration with Jira, it is possible to create Jira issues for project vulnerabilities or license issues directly from the Snyk API.\n\nThe Jira integration is available to customers on the pro or enterprise plan."
},
"response": []
},
{
"name": "List project settings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to which the project belongs. The API_KEY must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID"
}
]
}
},
"response": []
},
{
"name": "Update project settings",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"autoDepUpgradeLimit\": 2,\r\n \"autoDepUpgradeIgnoredDependencies\": [\r\n \"tap\",\r\n \"ava\"\r\n ],\r\n \"autoDepUpgradeEnabled\": false,\r\n \"autoDepUpgradeMinAge\": 21,\r\n \"pullRequestFailOnAnyVulns\": false,\r\n \"pullRequestFailOnlyForHighSeverity\": true,\r\n \"pullRequestTestEnabled\": true,\r\n \"pullRequestAssignment\": \"{\\\"enabled\\\":true,\\\"type\\\":\\\"manual\\\",\\\"assignees\\\":[\\\"username\\\"]}\",\r\n \"autoRemediationPrs\": \"{\\\"freshPrsEnabled\\\":true,\\\"backlogPrsEnabled\\\":false,\\\"usePatchRemediation\\\":false}\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to which the project belongs. The API_KEY must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID"
}
]
}
},
"response": []
},
{
"name": "Delete project settings",
"request": {
"method": "DELETE",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/settings",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"settings"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to which the project belongs. The API_KEY must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID"
}
]
},
"description": "Deleting project settings will set the project to inherit default settings from its integration."
},
"response": []
},
{
"name": "Move project to a different org",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"targetOrgId\": \"4a18d42f-0706-4ad0-b127-24078731fbed\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/move",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"move"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID to which the project belongs. The API_KEY must have admin access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID."
}
]
},
"description": "Note: when moving a project to a new organization, the historical data used for reporting does not move with it."
},
"response": []
},
{
"name": "Add a tag to a project",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"key\": \"example-tag-key\",\r\n \"value\": \"example-tag-value\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/tags",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"tags"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to apply the tag to"
}
]
},
"description": ""
},
"response": []
},
{
"name": "Remove a tag from a project",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"key\": \"example-tag-key\",\r\n \"value\": \"example-tag-value\"\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/tags/remove",
"protocol": "https",
"host": [
"snyk",
"io"
],
"path": [
"api",
"v1",
"org",
":orgId",
"project",
":projectId",
"tags",
"remove"
],
"variable": [
{
"key": "orgId",
"value": "{{org_id}}",
"description": "The organization ID. The `API_KEY` must have access to this organization."
},
{
"key": "projectId",
"value": "{{project_id}}",
"description": "The project ID to remove a tag from"
}
]
}
},
"response": []
},
{
"name": "Applying attributes",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"criticality\": [\r\n \"high\"\r\n ],\r\n \"environment\": [\r\n \"backend\"\r\n ],\r\n \"lifecycle\": [\r\n \"development\"\r\n ]\r\n}"
},
"url": {
"raw": "https://snyk.io/api/v1/org/:orgId/project/:projectId/attributes",
"protocol": "https",
"host": [