Import Projects (v1)

This document uses the v1 API. For more details, see the v1 API.

Import targets

Request a target to be analyzed for supported Snyk projects via a configured integration. See the Integrations API to configure a new integration.

POSThttps://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/import

Path parameters

orgId*string

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

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

integrationId*string

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

application/json; charset=utf-8

Note: Importing targets through a Github (Cloud) integration requires the use of a Snyk personal access/api token.

one of

Github and Github Enterprise Import RequestAzure Repos Target Import RequestGitLab Import RequestBitbucket Cloud and Bitbucket Cloud App Import RequestBitbucket Server Import RequestHeroku Import RequestAWS Lambda Import RequestCloudFoundry, Pivotal & IBM Cloud Import RequestDockerHub Import RequestAzure Container Registry, Elastic Container Registry, Artifactory Container Registry, Nexus Import RequestGoogle Container Registry, Google Artifact Registry, Harbor, DigitalOcean Container Registry, Quay, GitLab Container Registry, GitHub Container Registry Import Requestany

Response

201

Headers

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/import', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
    body: JSON.stringify({
      "target": {
        "owner": "org-security",
        "name": "goof",
        "branch": "main"
      },
      "files": [
        {
          "path": "example/package.json"
        }
      ]
    }),
});
const data = await response.json();

Get import job details

GEThttps://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/import/{jobId}

Path parameters

orgId*string

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

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

integrationId*string

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"

jobId*string

The ID of the job. This can be found in the Location response header from the corresponding POST request that triggered the import job.

Example: "1a325d9d-b782-468a-a242-9a2073734f0b"

Header parameters

Response

200

Body

application/json; charset=utf-8

idstring

A uuid representing the job's id

statusstring

a string representing the status of a job.

One of: pending, failed, aborted or complete.

createdstring

the time when an import job was created represented as a UTC (ISO-8601) string

logsarray of logs

all organizations imported by the job

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/integrations/{integrationId}/import/{jobId}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
});
const data = await response.json();

Response

200

{
  "id": "dce061f7-ce0f-4ccf-b49b-4335d1205bd9",
  "status": "pending",
  "created": "2018-07-23T15:21:10.611Z",
  "logs": [
    {
      "name": "org1/repo1",
      "created": "2018-07-23T15:21:10.643Z",
      "status": "failed",
      "projects": []
    },
    {
      "name": "org2/repo2",
      "created": "2018-07-23T15:21:10.644Z",
      "status": "complete",
      "projects": [
        {
          "targetFile": "package.json",
          "success": true,
          "projectUrl": "https://api.snyk.io/v1/org/org-name/project/7eeaee25-5f9b-4d05-8818-4cca2c9d9adc"
        }
      ]
    },
    {
      "name": "org3/repo3",
      "created": "2018-07-23T15:21:10.643Z",
      "status": "pending",
      "projects": [
        {
          "targetFile": "package.json",
          "success": true,
          "projectUrl": "https://api.snyk.io/v1/org/org-name/project/0382897c-0617-4429-86df-51187dfd42f6"
        }
      ]
    }
  ]
}