Import Projects (v1)

이 문서는 v1 API를 사용하며, Snyk은 향후 개발을 REST API에 집중할 예정이므로 결국 지원이 중단될 예정입니다. 자세한 내용은 v1 API를 참조하십시오.

이 API를 사용하여 프로젝트를 Snyk으로 가져올 수 있습니다. 가져온 프로젝트는 Git 리포지토리, Docker 이미지, 컨테이너, 구성 파일 등이 될 수 있습니다. 자세한 내용은 프로젝트 및 대상 문서를 참조하십시오. 일반적인 가져오기는 처리할 대상을 요청하는 것으로 시작하여, 가져오기 완료 및 결과 Snyk 프로젝트에 대한 자세한 내용을 확인하기 위해 Import Job API를 폴링하는 방식으로 진행됩니다.

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

application/json

or

or

or

or

or

or

or

or

or

or

Responses

201Success

post

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

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

200Success

application/json

get

/org/{orgId}/integrations/{integrationId}/import/{jobId}

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