SlackSettings

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

Create new Slack notification default settings.

Create new Slack notification default settings for a given tenant.

POSThttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}

Path parameters

org_id*string (uuid)

Org ID

bot_id*Uuid (string (uuid))

Bot ID

Query parameters

Body

application/vnd.api+json

Create new Slack notification default settings for a tenant.

data*object

Response

201400401403404409500

Default settings created successfully

Headers

Body

application/vnd.api+json

dataSlackDefaultSettingsData (object)

jsonapiJsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "slack",
        "attributes": {
          "target_channel_id": "slack://channel?team=team-id&id=channel-id",
          "severity_threshold": "high"
        }
      }
    }),
});
const data = await response.json();

Response

201400401403404409500

{
  "data": {
    "attributes": {
      "severity_threshold": "high",
      "target_channel_id": "slack://channel?team=team-id&id=channel-id",
      "target_channel_name": "channel-name"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "slack"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Get Slack integration default notification settings.

Get Slack integration default notification settings for the provided tenant ID and bot ID.

GEThttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}

Path parameters

org_id*string (uuid)

Org ID

bot_id*Uuid (string (uuid))

Bot ID

Query parameters

Response

200400401403404409500

Default settings created successfully

Headers

Body

application/vnd.api+json

dataSlackDefaultSettingsData (object)

jsonapiJsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

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

Response

200400401403404409500

{
  "data": {
    "attributes": {
      "severity_threshold": "high",
      "target_channel_id": "slack://channel?team=team-id&id=channel-id",
      "target_channel_name": "channel-name"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "slack"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Remove the given Slack App integration

Remove the given Slack App integration

DELETEhttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}

Path parameters

org_id*string (uuid)

Org ID

bot_id*Uuid (string (uuid))

Bot ID

Query parameters

Response

204400401403404409500

Slack App integration successfully removed

Headers

Request

JavaScriptCurlPython

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

Response

400401403404409500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Slack notification settings overrides for projects

Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.

GEThttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects

Path parameters

org_id*string (uuid)

Org ID

bot_id*Uuid (string (uuid))

Bot ID

Query parameters

Response

200400401403404409500

Return default settings for a tenant

Headers

Body

application/vnd.api+json

data*array of ProjectSettingsData (object)

jsonapi*JsonApi (object)

links*PaginatedLinks (object)

Request

JavaScriptCurlPython

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

Response

200400401403404409500

{
  "data": [
    {
      "attributes": {
        "is_active": true,
        "severity_threshold": "high",
        "target_channel_id": "slack://channel?team=team-id&id=channel-id",
        "target_channel_name": "channel-name",
        "target_project_name": "snyk/goof:package.json"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "slack"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource?ending_before=v1.eyJpZCI6IjExIn0K",
    "last": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjMwIn0K",
    "next": "https://example.com/api/resource?starting_after=v1.eyJpZCI6IjEwIn0K"
  }
}

Create a new Slack settings override for a given project.

Create Slack settings override for a project.

POSThttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}

Path parameters

org_id*string (uuid)

Org ID

project_id*string (uuid)

Project ID

bot_id*Uuid (string (uuid))

Bot ID

Query parameters

Body

application/vnd.api+json

Create new Slack notification default settings for a tenant.

data*object

Response

201400401403404409500

Project settings created successfully

Headers

Body

application/vnd.api+json

dataProjectSettingsData (object)

jsonapiJsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({
      "data": {
        "type": "slack",
        "attributes": {
          "target_channel_id": "slack://channel?team=team-id&id=channel-id",
          "severity_threshold": "high"
        }
      }
    }),
});
const data = await response.json();

Response

201400401403404409500

{
  "data": {
    "attributes": {
      "is_active": true,
      "severity_threshold": "high",
      "target_channel_id": "slack://channel?team=team-id&id=channel-id",
      "target_channel_name": "channel-name",
      "target_project_name": "snyk/goof:package.json"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "slack"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Update Slack notification settings for a project.

Update Slack notification settings for a project.

PATCHhttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}

Path parameters

org_id*string (uuid)

Org ID

bot_id*Uuid (string (uuid))

Bot ID

project_id*string (uuid)

Project ID

Query parameters

Body

application/vnd.api+json

Update existing project specific settings for a project.

dataobject

Response

200400401403404409500

Slack notification settings for a project updated successfully.

Headers

Body

application/vnd.api+json

dataProjectSettingsData (object)

jsonapiJsonApi (object)

linksSelfLink (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409500

{
  "data": {
    "attributes": {
      "is_active": true,
      "severity_threshold": "high",
      "target_channel_id": "slack://channel?team=team-id&id=channel-id",
      "target_channel_name": "channel-name",
      "target_project_name": "snyk/goof:package.json"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "slack"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://example.com/api/this_resource"
  }
}

Remove Slack settings override for a project.

Remove Slack settings override for a project.

DELETEhttps://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}

Path parameters

org_id*string (uuid)

Org ID

project_id*string (uuid)

Project ID

bot_id*Uuid (string (uuid))

Bot ID

Query parameters

Response

204400401403404409500

Slack settings override for the project removed successfully.

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}?version=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}