모든 프로젝트 V1 API에서 REST API 마이그레이션 가이드 (마이그레이션 완료)
수명 종료 (End of life)
2023년 6월 22일, Snyk은 REST 모든 프로젝트 목록 보기 API를 위해 2023년 12월 22일부로 V1 모든 프로젝트 목록 보기 API를 종료할 계획이라고 발표했습니다. 지정된 조직 ID를 가진 조직의 모든 프로젝트 목록 보기를 참조하십시오.
REST 프로젝트 API의 새로운 기능
OpenAPI 사양을 기반으로 하는 Snyk REST API는 일관되고 친숙하며 사용하기 쉬운 API 프레임워크를 제공하도록 설계되었으며 몇 가지 주요 개선 사항을 도입했습니다. 새로운 API의 장점은 다음과 같습니다.
일관된 버전 관리
페이지네이션 및 캐싱
성능 향상
클라이언트 생성 가능
프로젝트 REST API는 향상된 성능과 도메인 분리를 용이하게 하기 위해 개선된 데이터 아키텍처를 도입했습니다.
Snyk은 새로운 API로 마이그레이션하는 것이 큰 작업이 될 수 있음을 이해하고 있으며, 프로세스 전반에 걸쳐 여러분을 지원하고자 합니다. 이 포괄적인 마이그레이션 가이드는 단계별 지침, 코드 예시 및 모범 사례를 제공하여 새로운 API에 원활하게 통합할 수 있도록 돕기 위해 작성되었습니다.
지원 종료된 엔드포인트를 사용 중인 경우, Snyk은 이 마이그레이션 가이드를 검토하고 2023년 12월 22일 금요일 이전에 모든 자동화 기능을 이전할 것을 권장합니다.
REST API 마이그레이션 일정
V1 모든 프로젝트 목록 보기 API 지원 종료 발표
2023년 6월 22일
현재 API 사용 현황을 검토하고 마이그레이션이 필요한 위치를 식별합니다.
V1과 REST 프로젝트 API의 상세 비교가 포함된 마이그레이션 가이드 게시
2023년 6월 22일
마이그레이션 가이드를 검토하고 최종 기한 전에 기존 코드 및 워크플로우를 마이그레이션할 계획을 세웁니다.
V1 모든 프로젝트 목록 보기 API가 이제 410 Gone을 반환함:
엔터프라이즈 플랜의 모든 새로 생성된 그룹
Snyk API 액세스 권한이 있는 다른 플랜의 모든 새로 생성된 조직
2023년 6월 22일
엔터프라이즈 플랜의 기존 사용자는 별도의 조치가 필요하지 않습니다.
새로운 사용자는 모든 새로운 통합에 REST 프로젝트 API를 사용해야 합니다.
Snyk 도구(Tools) 업데이트
2023년 8월 15일
Snyk 도구를 사용하는 고객은 V1 대신 REST 프로젝트 API 사용을 지원하는 버전으로 업그레이드해야 합니다.
이 가이드에 포함된 상세 목록을 참조하십시오.
V1 모든 프로젝트 목록 보기 API 문서 제거
2023년 9월 22일
조치 필요 없음
수명 종료(End-of-life): V1 모든 프로젝트 목록 보기 API에 대한 모든 액세스가 410 Gone 응답을 반환함.
2023년 12월 22일
자동화된 워크플로우의 중단을 방지하기 위해 이때까지 마이그레이션을 완료했는지 확인합니다.
V1 모든 프로젝트 목록 보기 API를 사용하는 다음 Snyk 도구들이 REST 모든 프로젝트 목록 보기 API를 사용하도록 업데이트되었습니다.
snyk-jira-tickets-for-new-vulns: 버전 5.0.0 이상
snyk-api-ts-client: 버전 1.11.1 이상
snyk-request-manager: 버전 1.8.1 이상
backstage-plugin: 버전 2.0.0 이상
api-import-tool: 버전 1.99.0 이상
snyk-scm-mapper: 최신 버전
pysnyk: 버전 0.9.8 이상
snyk-repo-diff: 최신 버전
snyk delta: 버전 1.9.0 이상
snyk-issues-to-csv: 최신 버전
snyk-disallow: 이 도구는 이제 지원 종료되었습니다.
snyk-prevent-gh-commit-status: 버전 2.2.1 이상
다양한 CX Tools 코드 샘플이 업데이트되었습니다.
V1과 REST 프로젝트 API 비교
org.name
data[i].relationships.organization.links.related - REST GET /orgs/:org_id를 통해 조직에 대한 더 많은 데이터를 검색할 수 있는 REST API 링크를 제공합니다.
org.id
data[i].relationships.organization.data.id - REST GET /orgs/:org_id를 통해 조직에 대한 더 많은 데이터를 검색하기 위해 제공된 REST API 링크를 사용할 수도 있습니다.
name
data[i].attributes.name
created
data[i].attributes.created
origin
data[i].attributes.origin
type
data[i].attributes.type
readOnly
data[i].attributes.read_only
testFrequency
data.[i].attributes.settings.recurring_tests.frequency
totalDependencies
meta.latest_dependency_total 쿼리 매개변수를 지정하여 선택적으로 가져올 수 있습니다.
issueCountBySeverity.low issueCountBySeverity.medium issueCountBySeverity.high issueCountBySeverity.critical
meta.latest_issue_counts 쿼리 매개변수를 지정하여 선택적으로 가져올 수 있습니다.
imageId
v1 POST org/:orgId/project/:projectId/history를 통해 최신 프로젝트 스냅샷에서 가져올 수 있습니다.
imageTag
v1 POST org/:orgId/project/:projectId/history를 통해 최신 프로젝트 스냅샷에서 가져올 수 있습니다.
imageBaseImage
v1 POST org/:orgId/project/:projectId/history를 통해 최신 프로젝트 스냅샷에서 가져올 수 있습니다.
imagePlatform
v1 POST org/:orgId/project/:projectId/history를 통해 최신 프로젝트 스냅샷에서 가져올 수 있습니다.
imageCluster
Data[i].target.data.id - expand 매개변수를 사용하여 이 관계를 확장하거나, REST Targets API에 별도의 API 호출을 수행하여 일치하는 대상을 가져오고 거기서 클러스터 데이터를 가져옵니다.
remoteRepoUrl
Data[i].relationships.target.data.attributes.url - expand 매개변수를 사용하여 대상 관계를 확장합니다.
lastTestedDate
meta.latest_dependency_total.updated_at 또는 meta.latest_issue_counts.updated_at - meta.latest_issue_counts 또는 meta.latest_dependency_total 쿼리 매개변수를 지정하여 선택적으로 가져올 수 있습니다.
owner.id
owner.name
owner.username
owner.email
data[i].relationships.owner.links.related - REST GET /orgs/:org_id/users/:id (beta)를 통해 가져온 사용자에 대한 더 많은 데이터를 검색할 수 있는 REST API 링크를 제공합니다.
browseUrl
해당 없음 - 조직 slug와 프로젝트 ID를 사용하여 구성할 수 있습니다: https://app.snyk.io/org/:orgSlug/project/:projectId
importingUser.id
importingUser.name importingUser.username importingUser.email
data.[i]relationships.importer.data.id,
data[i]relationships.importer.links.related 추가적으로 REST GET /orgs/:org_id/users/:id (beta)를 통해 가져온 사용자에 대한 더 많은 데이터를 검색할 수 있는 REST API 링크를 제공합니다.
isMonitored
data[i].attributes.status
branch
data[i].attributes.target_reference
targetReference
data[i].attributes.target_reference
"tags": [ { "key": "example-tag-key", "value": "example-tag-value" } ]
data[i].attributes.tags[ { "key": "example-tag-key", "value": "example-tag-value" } ]
attributes.criticality
data[i].attributes.business_criticality
attributes.environment
data[i].attributes.environment
attributes.lifecycle
data[i].attributes.lifecycle
필터
이름으로 필터링 제공된 경우, 이 값으로 시작하는 이름을 가진 프로젝트만 반환됩니다.
필터: names 제공된 이름과 일치하는 프로젝트를 반환합니다.
REST Targets API를 사용하여 일치하는 대상을 찾은 다음 대상 ID를 기반으로 프로젝트를 필터링합니다. 추가 API 호출 없이 필터링하려면, REST 한 조직의 모든 프로젝트 목록 보기에서 expand 매개변수를 사용하여 대상 관계를 확장하고 모든 관련 대상 데이터를 동시에 반환합니다.
Last updated