Snyk Import Project API using Azure Repos

In this example below we show how you could import a Azure Repo directly from the Snyk API. The Snyk API is available to customers on paid plans and allows you to programatically integrate with Snyk.

API url

The base URL for all API endpoints is https://snyk.io/api/v1/

Authorization

To use this API, you must get your token from Snyk. It can be seen on https://snyk.io/account/ after you register with Snyk and login.

The token should be supplied in an Authorization header with the token, preceded by token:

Authorization: token API_KEY

Steps

Note: You would have configured an Azure Repos Integration as shown below prior to running these steps

1. Authenticate with the CLI using your Snyk Token as follows

$ snyk auth TOKEN

Your account has been authenticated. Snyk is now ready to be used.

2. Log into your Azure DevOps account and verify which Project Repo you wish to import as per the image below

3. With your project selected you will need the following details to perform the Snyk API import request

owner: Name of your project

name: Name of your Repository

branch: Branch name you wish to import

4. Finally we will need our Organisation ID and Azure Repos ID which we retrieve from the Snyk UI as follows

organization ID

Setting > General -> Organization ID

Azure Repos ID

Setting > Integrations -> Azure Repos -> Edit Settings -> Scroll to bottom of page

Take of note of both ID's we will need them in the steps below

5. Now we are ready to import our Azure Repo using a command as follows. We are using a "curl" command to issue a POST request and this command is for a Mac OSX or linux system so it would need tweaking if running on Windows for example

Command

curl --include \

     --request POST \

     --header "Content-Type: application/json; charset=utf-8" \

     --header "Authorization: token `snyk config get api`" \

     --data-binary "{

  \"target\": {

    \"owner\": \"spring-book-service\",

    \"name\": \"spring-book-service\",

    \"branch\": \"master\"

  }

}" \

'https://snyk.io/api/v1/org/$ORG_ID/integrations/$AZURE_REPO_ID/import'

6. Set the ENV variables for ORG_ID and AZURE_REPO_ID as follows

export ORG_ID=FROM_STEP-4
export AZURE_REPO_ID=FROM_STEP-4

7. Run command

$ curl --include \

>      --request POST \

>      --header "Content-Type: application/json; charset=utf-8" \

>      --header "Authorization: token `snyk config get api`" \

>      --data-binary "{

>   \"target\": {

>     \"owner\": \"spring-book-service\",

>     \"name\": \"spring-book-service\",

>     \"branch\": \"master\"

>   }

> }" \

> "https://snyk.io/api/v1/org/${ORG_ID}/integrations/${AZURE_REPO_ID}/import"

HTTP/2 201

content-security-policy: base-uri 'none'; script-src 'self' https: 'nonce-ENlk6rSQsdLgbcWNcCaA7A==' 'unsafe-inline' 'unsafe-eval' 'strict-dynamic' 'report-sample'; img-src https: data:; object-src 'none'; report-to csp-report-group; report-uri https://web-reports.snyk.io/csp?version=39e8721a74a6dffcb97fc790cfbf1fca91cefc03;

report-to: {"group":"csp-report-group","max_age":1800,"endpoints":[{"url":"https://web-reports.snyk.io/csp?version=39e8721a74a6dffcb97fc790cfbf1fca91cefc03"}],"include_subdomains":true}

x-snyk-version: undefined

snyk-request-id: 1669e85e-abe5-401b-80bb-dae41829d6e1

location: https://snyk.io/api/v1/org/.....

content-type: application/json; charset=utf-8

content-length: 2

etag: W/"2-vyGp6PvFo4RvsFtPoIWeCReyIC8"

date: Fri, 02 Jul 2021 01:39:45 GMT

x-frame-options: deny

x-content-type-options: nosniff

x-xss-protection: 1; mode=block

strict-transport-security: max-age=31536000; preload

{}

Finally switch back to the Snyk UI and verify you have imported the Azure repo as shown below

More Information

Import Projects API

https://snyk.docs.apiary.io/#reference/integrations/import-projects/import