Projekte über die API importieren

Wir haben gerade einen brandneuen API-Endpunkt veröffentlicht, über den Sie Ihre Repositories, Projekte, Funktionen und Apps importieren können, damit diese auf Sicherheitslücken überwacht werden.

Die Nutzung ist ganz einfach. Sie senden eine Anfrage mit der Integration, aus der Sie importieren möchten (z. B. GitHub), und dem Repository/Projekt/der Funktion/App, auf das bzw. die Sie abzielen (z. B. das jeweilige GitHub-Repository). Den Rest erledigen wir. Optional können Sie Dateien angeben, die wir auf Sicherheitslücken scannen sollen, etwa package.json oder Gemfile.lock. Andernfalls scannen wir alle Abhängigkeitsdateien, die wir finden (die Scan-Tiefe variiert je nach Integration).

Dieser API-Aufruf erfolgt asynchron, da ein Import einige Zeit in Anspruch nehmen kann. Er gibt eine Antwort mit dem Statuscode 201 und einem Location-Header zurück, der den Endpunkt angibt, an den Sie Statusaktualisierungen zum Importauftrag senden können.

Viele Kundinnen und Kunden haben uns nach einer Möglichkeit gefragt, Projekte programmgesteuert in Snyk zu importieren. Deshalb sind wir sehr gespannt darauf, wie Sie die Import-API nutzen, um Snyk noch besser in Ihre bestehenden Systeme zu integrieren. Wenn Sie die Import-API ausprobiert haben, lassen Sie uns wissen, was Sie davon halten. So erfahren wir, wie wir sie künftig verbessern können!

Einige unserer Kundinnen und Kunden automatisieren die Erstellung von Repositories. Mit dieser API stellen sie sicher, dass alle neuen Repositories automatisch auf Sicherheitslücken und Verstöße gegen Lizenzrichtlinien überwacht werden.

Häufig wird angefragt, neue Repositories und serverlose Anwendungen automatisch direkt nach ihrer Erstellung zu importieren. Damit Sie gleich loslegen können, haben wir eine kleine Codebasis mit einem einfachen Beispiel zusammengestellt. Es nutzt die GitHub-Repositories-API, um alle seit einem bestimmten Zeitpunkt geänderten Repositories aufzulisten und in Snyk zu importieren.

Das Ganze ist als npm-Modul verfügbar. Mit einem einzigen Befehl können Sie also die an einem Tag neu erstellten oder geänderten Repositories importieren:

$ npm install -g snyk-github-import
$ snyk-github-import --orgId=c0caaa2f-6c04-4be3-876b-c72553a5551f --integrationId=ab4633ac-e6bb-4d27-854a-328c0f33c3e8  --githubToken=212312cq1bfb1bcfb13042ff5a13d01ab12f12f4

Wenn Sie beispielsweise einen Cron-Job einrichten, können Sie dieses Skript verwenden, um Repositories regelmäßig automatisch zu importieren. Sie können damit auch programmgesteuert neue Organisationen mit allen Codebasen einrichten, die Sie überwachen möchten. Weitere Informationen finden Sie in unserer API-Dokumentation. Der Zugriff auf die Snyk-API ist nur in kostenpflichtigen Tarifen verfügbar.