Import Projects (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.

You can use this API to import projects into Snyk. Projects imported can be Git repositories, Docker images, containers, configuration files, and much more. See the Projects and Targets documentation for more information. A typical import would start with requesting a target to be processed and then polling the Import Job API for more details on completion of an import and the resulting Snyk Projects.

Import targets

post

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

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

or

or

or

or

or

or

or

or

or

or

Responses

post

HTTPcURLJavaScriptPython

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

{
  "target": {
    "owner": "org-security",
    "name": "goof",
    "branch": "main"
  },
  "files": [
    {
      "path": "example/package.json"
    }
  ]
}

201Success

No content

Get import job details

get

Get import job details

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

jobIdstringRequired

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

Responses

get

HTTPcURLJavaScriptPython

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

200Success

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