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

200Success

application/json

post

/org/{orgId}/integrations

POST /v1/org/{orgId}/integrations HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "type": "acr",
  "credentials": {
    "username": "text",
    "password": "text",
    "registryBase": "text"
  }
}

200Success

{
  "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

200Success

application/json

get

/org/{orgId}/integrations

GET /v1/org/{orgId}/integrations HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

{
  "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: githubPossible values:

Responses

200Success

application/json

get

/org/{orgId}/integrations/{type}

GET /v1/org/{orgId}/integrations/{type} HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

{
  "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

200Success

application/json

Responseall of

and

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

put

/org/{orgId}/integrations/{integrationId}

PUT /v1/org/{orgId}/integrations/{integrationId} HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "type": "github",
  "broker": {
    "enabled": true
  }
}

200Success

{
  "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

and

anyOptional

Defines automatic remediation policies

manualRemediationPrsall ofOptional

and

anyOptional

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

200Success

application/json

put

/org/{orgId}/integrations/{integrationId}/settings

PUT /v1/org/{orgId}/integrations/{integrationId}/settings HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 534

{
  "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
}

200Success

{
  "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

200Success

application/json

get

/org/{orgId}/integrations/{integrationId}/settings

GET /v1/org/{orgId}/integrations/{integrationId}/settings HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

{
  "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

200Success

application/json

post

/org/{orgId}/integrations/{integrationId}/clone

POST /v1/org/{orgId}/integrations/{integrationId}/clone HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "destinationOrgPublicId": "9a3e5d90-b782-468a-a042-9a2073736f0b1"
}

200Success

{
  "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

200Success

delete

/org/{orgId}/integrations/{integrationId}/authentication

DELETE /v1/org/{orgId}/integrations/{integrationId}/authentication HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

No content

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

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

Responses

200Success

post

/org/{orgId}/integrations/{integrationId}/authentication/switch-token

POST /v1/org/{orgId}/integrations/{integrationId}/authentication/switch-token HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

No content

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

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

Responses

200Success

application/json

post

/org/{orgId}/integrations/{integrationId}/authentication/provision-token

POST /v1/org/{orgId}/integrations/{integrationId}/authentication/provision-token HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

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

PreviousImport Projects (v1)NextInvites

Last updated 2 months ago

Was this helpful?