SastSettings

This document uses the REST API. For more details, see the Authentication for API page.

Enable/Disable the Snyk Code settings for an org

Enable/Disable the Snyk Code settings for an org

PATCHhttps://api.snyk.io/rest/orgs/{org_id}/settings/sast

Path parameters

org_id*string (uuid)

The id of the org for which we want to update the Snyk Code setting

Query parameters

Body

application/vnd.api+json

data*object

Response

201400401403404500

The SAST settings for the org are being updated

Headers

Body

application/vnd.api+json

data*SastEnablement (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/settings/sast?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "attributes": {
          "sast_enabled": false
        }
      }
    }),
});
const data = await response.json();

Response

201400401403404500

{
  "data": {
    "attributes": {
      "autofix_enabled": false,
      "sast_enabled": false
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

Retrieves the SAST settings for an org

Retrieves the SAST settings for an org

GEThttps://api.snyk.io/rest/orgs/{org_id}/settings/sast

Path parameters

org_id*string (uuid)

The id of the org for which we want to retrieve the SAST settings

Query parameters

Response

200400401403404500

The SAST settings for the org are being retrieved

Headers

Body

application/vnd.api+json

data*SastEnablement (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/settings/sast?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "data": {
    "attributes": {
      "autofix_enabled": false,
      "sast_enabled": false
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}