Integrations (v1)

This document uses the v1 API, which will eventually be deprecated, as further Snyk developments are now focused on the REST API. For more details, see the v1 API.

Add new integration

post

Add new integration for given organization.

Required permissions

• View Organization
• View Integrations
• Edit Integrations

Path parameters

orgIdstringrequired

The organization ID. The API_KEY must have admin access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

Body

one ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "acr",
    "credentials": {
      "username": "text",
      "password": "text",
      "registryBase": "text"
    }
  }'

200

200

{
  "id": "9a3e5d90-b782-468a-a042-9a2073736f0b"
}

List

get

Required permissions

• View Organization
• View Integrations

Path parameters

orgIdstringrequired

The organization public ID. The API_KEY must have admin access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations'

200

200

{
  "github": "9a3e5d90-b782-468a-a042-9a2073736f0b",
  "gitlab": "1b3e3d90-c678-347a-n232-6a3453738h1e",
  "bitbucket-cloud": "6jje4c92-e7rn-t59a-f456-8n5675432fe9"
}

Get existing integration by type

get

Required permissions

• View Organization
• View Integrations

Path parameters

orgIdstringrequired

The API_KEY must have admin access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

typestring · enumrequired

Integration type.

Example: github

Options: acr, artifactory-cr, azure-repos, bitbucket-cloud, bitbucket-server, digitalocean-cr, docker-hub, ecr, gcr, github, github-cr, github-enterprise, github-cloud-app, gitlab, gitlab-cr, google-artifact-cr, harbor-cr, nexus-cr, quay-cr

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations/{type}'

200

200

{
  "id": "9a3e5d90-b782-468a-a042-9a2073736f0b"
}

Update existing integration

put

• Update integration’s credentials for given organization. Integration must be not brokered
• Enable or disable brokered integration for given organization. Credentials required for disabling brokered integration Examples:
• Set up a broker for an existing integration
• Update credentials for an existing non-brokered integration
• Disable broker for an existing integration

Required permissions

• View Organization
• View Integrations
• Edit Integrations

Path parameters

orgIdstringrequired

The organization ID. The API_KEY must have admin access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

integrationIdstringrequired

The unique identifier for the configured integration. This can be found on the Integration page in the Settings area for all integrations that have been configured.

Example: 9a3e5d90-b782-468a-a042-9a2073736f0b

Body

one ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "github",
    "broker": {
      "enabled": true
    }
  }'

200

200

{
  "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
  "brokerToken": "4a18d42f-0706-4ad0-b127-24078731fbed"
}

Update Integration Settings

put

Required permissions

• View Organization
• View Integrations
• Edit Integrations

Path parameters

orgIdstringrequired

The organization ID. The API_KEY must have admin access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

integrationIdstringrequired

The unique identifier for the configured integration. This can be found on the Integration page in the Settings area for all integrations that have been configured.

Example: 9a3e5d90-b782-468a-a042-9a2073736f0b

Body

autoDepUpgradeLimitnumberoptional

A limit on how many automatic dependency upgrade PRs can be opened simultaneously

autoDepUpgradeIgnoredDependenciesstring[]optional

A list of strings defining what dependencies should be ignored

autoDepUpgradeEnabledbooleanoptional

Defines if the functionality is enabled

autoDepUpgradeMinAgenumberoptional

The age (in days) that an automatic dependency check is valid for

pullRequestFailOnAnyVulnsbooleanoptional

If an opened PR should fail to be validated if any vulnerable dependencies have been detected

pullRequestFailOnlyForHighSeveritybooleanoptional

If an opened PR only should fail its validation if any dependencies are marked as being of high severity

pullRequestTestEnabledbooleanoptional

If opened PRs should be tested

pullRequestAssignmentstringoptional

assign Snyk pull requests

autoRemediationPrsall ofoptional

Defines automatic remediation policies

Defines automatic remediation policies

manualRemediationPrsall ofoptional

Defines manual remediation policies

Defines manual remediation policies

dockerfileSCMEnabledbooleanoptional

If true, will automatically detect and scan Dockerfiles in your Git repositories, surface base image vulnerabilities and recommend possible fixes

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/settings' \
  --header 'Content-Type: application/json' \
  --data '{
    "autoDepUpgradeLimit": 2,
    "autoDepUpgradeIgnoredDependencies": [],
    "autoDepUpgradeEnabled": false,
    "autoDepUpgradeMinAge": 21,
    "pullRequestTestEnabled": true,
    "pullRequestFailOnAnyVulns": false,
    "pullRequestFailOnlyForHighSeverity": true,
    "pullRequestAssignment": "{\"enabled\":true,\"type\":\"manual\",\"assignees\":[\"username\"]}",
    "autoRemediationPrs": {
      "backlogPrsEnabled": false,
      "backlogPrStrategy": "vuln",
      "freshPrsEnabled": true,
      "usePatchRemediation": false
    },
    "manualRemediationPrs": {
      "useManualPatchRemediation": false
    },
    "dockerfileSCMEnabled": true
  }'

200

200

{
  "autoDepUpgradeLimit": 2,
  "autoDepUpgradeIgnoredDependencies": [],
  "autoDepUpgradeEnabled": false,
  "autoDepUpgradeMinAge": 21,
  "pullRequestTestEnabled": true,
  "pullRequestFailOnAnyVulns": false,
  "pullRequestFailOnlyForHighSeverity": true,
  "pullRequestAssignment": "{\"enabled\":true,\"type\":\"manual\",\"assignees\":[\"username\"]}",
  "autoRemediationPrs": {
    "backlogPrsEnabled": false,
    "backlogPrStrategy": "vuln",
    "freshPrsEnabled": true,
    "usePatchRemediation": false
  },
  "manualRemediationPrs": {
    "useManualPatchRemediation": false
  },
  "dockerfileSCMEnabled": true
}

Get Integration Settings

get

Required permissions

• View Organization
• View Integrations

Path parameters

orgIdstringrequired

The organization ID. The API_KEY must have admin access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

integrationIdstringrequired

The unique identifier for the configured integration. This can be found on the Integration page in the Settings area for all integrations that have been configured.

Example: 9a3e5d90-b782-468a-a042-9a2073736f0b

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/settings'

200

200

{
  "autoDepUpgradeLimit": 1,
  "autoDepUpgradeIgnoredDependencies": [
    "text"
  ],
  "autoDepUpgradeEnabled": true,
  "autoDepUpgradeMinAge": 1,
  "pullRequestFailOnAnyVulns": true,
  "pullRequestFailOnlyForHighSeverity": true,
  "pullRequestTestEnabled": true,
  "pullRequestAssignment": "text",
  "autoRemediationPrs": {
    "backlogPrsEnabled": true,
    "backlogPrStrategy": null,
    "freshPrsEnabled": true,
    "usePatchRemediation": true
  },
  "manualRemediationPrs": {
    "usePatchRemediation": true
  },
  "dockerfileSCMEnabled": true
}

Clone an integration (with settings and credentials)

post

Clone an integration, including all of its settings and credentials from one organization to another organization in the same group. This API supports both brokered and non-brokered integrations. Use this API for when you want to share a Broker token between several Snyk organizations (integrations).

Required permissions

• View Organization
• View Integrations
• Edit Integrations

Path parameters

orgIdstringrequired

Source organization public ID to clone integration settings from. The API_KEY must have access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

integrationIdstringrequired

Source integration public ID to clone.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

Body

destinationOrgPublicIdstringrequired

The organization public ID. The API_KEY must have access to this organization.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/clone' \
  --header 'Content-Type: application/json' \
  --data '{
    "destinationOrgPublicId": "9a3e5d90-b782-468a-a042-9a2073736f0b1"
  }'

200

200

{
  "newIntegrationId": "9a3e5d90-b782-468a-a042-9a2073736f0b"
}

Delete credentials

delete

Required permissions

• View Organization
• View Integrations
• Edit Integrations Removes any credentials set for this integration. If this is a brokered connection the operation will have no effect.

Path parameters

orgIdstringrequired

The organization ID. The API_KEY must have access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

integrationIdstringrequired

The integration ID.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/authentication'

200

200

No body

Switch between broker tokens

post

Switch the existing broker token with the provisioned token for this integration and any other in the same group. Only perform this action when you have a Broker client running with the provisioned token. This action will fail if there is no token provisioned for this integration or any integration in the same group.

Required permissions

• View Organization
• View Integrations
• Edit Integrations

Path parameters

orgIdstringrequired

The API_KEY must have access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

integrationIdstringrequired

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/authentication/switch-token'

200

200

No body

Provision new broker token

post

Issue a new and unique provisional broker token for the brokered integration. Used 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. The new provisional token will fail to be created if the integration, or any other integration in the same group, already has one provisioned.

Required permissions

• View Organization
• View Integrations
• Edit Integrations

Path parameters

orgIdstringrequired

The API_KEY must have access to this organization.

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

integrationIdstringrequired

Example: 4a18d42f-0706-4ad0-b127-24078731fbed

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/authentication/provision-token'

200

200

{
  "id": "9a3e5d90-b782-468a-a042-9a2073736f0b",
  "provisionalBrokerToken": "4a18d42f-0706-4ad0-b127-24078731fbed"
}