API 엔드포인트 색인 및 팁

org_id 찾는 방법 Snyk에 로그인하여 **조직(Organization)**으로 이동한 후, Settings > General로 이동합니다. Organization ID가 General 설정 페이지에 있으며, 이를 복사할 수 있습니다.

문서의 이 색인 및 참고 섹션은 이 색인 외에도 특정 사용 사례를 위한 솔루션, Snyk API 사용 시나리오, 그리고 Snyk API 엔드포인트 사용에 대한 자세한 정보가 포함된 페이지를 제공합니다.

다음의 특정 API에 대한 섹션도 참조하십시오.

추가 정보는 API 지원 문서를 참조하십시오.

이 색인에는 REST GA, 베타(beta) 및 V1 API 엔드포인트의 카테고리와 이름이 포함되어 있으며, 각 엔드포인트에 대한 참조 문서의 URL과 가능한 경우 관련 정보에 대한 링크가 포함되어 있습니다. 별도의 언급이 없는 한 REST가 기본이며 GA 상태입니다. 해당되는 경우 V1 API가 명시됩니다. 이 색인은 작성 중이며, 추가 정보가 지속적으로 업데이트되고 있습니다.

AccessRequests (베타)

액세스 요청 가져오기

Apps

추가 정보: Snyk Apps

사용자를 대신하여 작동하는 앱 목록 가져오기

앱 취소

앱의 활성 OAuth 세션 목록 가져오기

활성 사용자 앱 세션 취소

사용자에게 설치된 앱 목록 가져오기

설치 ID로 앱 액세스 취소

대체: 지원 종료된(DEPRECATED) 'Revoke app bot authorization'을 대체합니다.

지원 종료(DEPRECATED) 조직을 위한 새 앱 생성

대체됨: 'Create a new Snyk App for an organization'으로 대체되었습니다.

추가 정보: Snyk API를 사용하여 Snyk 앱 생성

조직에서 생성한 앱 목록 가져오기

대체: 지원 종료된 'Get a list of apps created by an organization'을 대체합니다.

추가 정보: 앱 세부 정보 관리

지원 종료(DEPRECATED) 이름, 리디렉션 URI 및 액세스 토큰 수명 등 앱 속성 업데이트

대체됨: 앱 ID를 사용하여 이름, 리디렉션 URI 및 액세스 토큰 수명과 같은 앱 생성 속성을 업데이트하는 방식으로 대체되었습니다.

지원 종료(DEPRECATED) 클라이언트 ID로 앱 가져오기

대체됨: 앱 ID를 사용하여 Snyk 앱을 가져오는 방식으로 대체되었습니다.

지원 종료(DEPRECATED) 앱 삭제

대체됨: 앱 ID를 사용하여 Snyk 앱을 삭제하는 방식으로 대체되었습니다.

지원 종료(DEPRECATED) 앱의 클라이언트 시크릿 관리

대체됨: 비대화형 Snyk 앱 설치를 위한 클라이언트 시크릿 관리 방식으로 대체되었습니다.

이 조직에 Snyk 앱 설치

조직에 설치된 앱 목록 가져오기

대체: 지원 종료된 'Get a list of app bots authorized to an organization'을 대체합니다.

추가 정보: Slack 앱 (Jira 통합) (Slack 앱 봇 ID 찾기)

Snyk 조직의 앱 권한 취소

참조: 설치 ID를 사용하여 Snyk 그룹의 앱 권한 취소

비대화형 Snyk 앱 설치를 위한 클라이언트 시크릿 관리

추가 정보: 앱 세부 정보 관리

조직을 위한 새로운 Snyk 앱 생성

대체: 지원 종료된 'Create a new app for an organization'을 대체합니다.

추가 정보: Snyk API를 사용하여 Snyk 앱 생성

지원 종료(DEPRECATED) 조직에서 생성한 앱 목록 가져오기

대체됨: 'Get a list of apps created by an organization'으로 대체되었습니다.

앱 ID를 사용하여 이름, 리디렉션 URI 및 액세스 토큰 수명과 같은 앱 생성 속성 업데이트

대체: 지원 종료된 'Update App attributes that are name, redirect URIs, and access token time to live'를 대체합니다.

추가 정보: 앱 세부 정보 관리

앱 ID로 Snyk 앱 가져오기

대체: 지원 종료된 'Get an app by client id'를 대체합니다.

앱 ID로 앱 삭제

대체: 지원 종료된 'Delete an app'을 대체합니다.

추가 정보: 앱 세부 정보 관리

Snyk 앱의 클라이언트 시크릿 관리

추가 정보: 앱 세부 정보 관리

지원 종료(DEPRECATED) 조직에 승인된 앱 봇 목록 가져오기

대체됨: 조직에 설치된 앱 목록 가져오기로 대체되었습니다.

추가 정보: Slack 앱 (Jira 통합용)

지원 종료(DEPRECATED) 앱 봇 승인 취소

대체됨: 설치 ID를 사용하여 Snyk 그룹의 앱 승인 취소 방식으로 대체되었습니다.

참조: 설치 ID로 앱 액세스 취소

이 그룹에 Snyk 앱 설치

그룹에 설치된 앱 목록 가져오기

설치 ID를 사용하여 Snyk 그룹의 앱 승인 취소

비대화형 Snyk 앱 설치를 위한 클라이언트 시크릿 관리

대체: 지원 종료된 'Manage client secrets for an app'을 대체합니다.

감사 로그

추가 정보: API를 통해 조직 또는 그룹의 사용자 시작 활동 감사 로그 검색; AWS CloudTrail Lake

조직 감사 로그 검색

추가 정보: API를 통해 조직 또는 그룹의 사용자 시작 활동 감사 로그 검색, AWS CloudTrail Lake

그룹 감사 로그 검색

추가 정보: 새로운 GA REST 버전의 감사 로그 API를 사용하여 보다 효율적으로 감사 로그 필터링 (제품 업데이트); API를 통해 조직 또는 그룹의 사용자 시작 활동 감사 로그 검색

감사 로그 (v1)

그룹 수준 감사 로그

그룹 감사 로그 검색을 사용하십시오.

조직 수준 감사 로그

조직 감사 로그 검색을 사용하십시오.

클라우드 (베타)

환경 목록 보기

새 환경 생성

환경 삭제

환경 업데이트

클라우드 공급자 권한 생성

리소스 목록 보기

Snyk IaC (사용 용도: IaC 파일에서 생성된 IaC 및 클라우드 리소스 인벤토리 보기)

스캔 목록 보기

스캔 생성

스캔 가져오기

컬렉션

이 API를 사용하려면 '프로젝트 기록 보기(View Project History)' 권한이 필요합니다.

추가 정보: 프로젝트 컬렉션 그룹화

컬렉션 생성

컬렉션 가져오기

컬렉션 편집

컬렉션 상세 조회

컬렉션 삭제

컬렉션에 프로젝트 추가

지정된 컬렉션에서 프로젝트 가져오기

컬렉션에서 프로젝트 제거

ContainerImage

컨테이너 이미지 인스턴스 목록 보기

컨테이너 이미지 인스턴스 가져오기

컨테이너 이미지의 이미지 대상 참조 인스턴스 목록 보기

사용자 정의 베이스 이미지

추가 정보: 사용자 정의 베이스 이미지 권장 사항 사용

기존 컨테이너 프로젝트에서 사용자 정의 베이스 이미지 생성

추가 정보: 사용자 정의 베이스 이미지 권장 사항 사용의 생성된 프로젝트를 사용자 정의 베이스 이미지로 표시 섹션; 사용자 정의 베이스 이미지의 버전 관리 스키마

사용자 정의 베이스 이미지 컬렉션 가져오기

사용자 정의 베이스 이미지 업데이트

사용자 정의 베이스 이미지 가져오기

사용자 정의 베이스 이미지 삭제

종속성 (v1)

모든 종속성 목록 보기

권한 (v1)

모든 권한 목록 보기

조직의 권한 값 가져오기

그룹 (베타)

모든 그룹 가져오기

그룹 가져오기

추가 정보: API를 사용하는 프로젝트의 조직 및 그룹 식별

그룹의 모든 SSO 연결 가져오기

지정된 SSO 연결을 사용하는 모든 사용자 가져오기

그룹 SSO 연결에서 사용자 삭제

추가 정보: API를 사용하여 그룹 및 조직에서 멤버 제거; API를 통해 조직 또는 그룹의 사용자 시작 활동 감사 로그 검색

그룹 (v1)

그룹의 모든 태그 목록 보기

추가 정보: 프로젝트 태그

그룹에서 태그 삭제

추가 정보: 프로젝트 태그

그룹 설정 업데이트

그룹 설정 보기

그룹의 모든 역할 목록 보기

추가 정보: API를 사용하여 멤버 역할 업데이트; Snyk API를 사용하여 서비스 계정 관리

그룹의 모든 조직 목록 보기

추가 정보: 프로젝트의 조직 및 그룹 식별; 레거시 사용자 정의 매핑; api-import 가져오기를 위한 가져오기 대상 데이터 생성; 시나리오: 지정된 그룹의 모든 프로젝트에 대해 프로젝트 스냅샷 검색; 시나리오: 취약점의 영향을 받는 모든 프로젝트 찾기

그룹 내 조직에 멤버 추가

그룹의 모든 멤버 목록 보기

추가 정보: API를 사용하여 그룹 및 조직에서 멤버 제거; 시나리오: 지정된 목록의 모든 사용자를 회사의 모든 조직(그룹 내 모든 조직)에 할당

그룹

그룹 사용자의 조직 멤버십 목록 가져오기

역할을 가진 사용자의 그룹 멤버십 생성

그룹의 모든 멤버십 가져오기

그룹 멤버십의 역할 업데이트

그룹에서 멤버십 삭제

IacSettings

조직의 코드형 인프라(Infrastructure as Code) 설정 업데이트

추가 정보: 원격 IaC 사용자 정의 규칙 번들 사용

조직의 코드형 인프라 설정 가져오기

그룹의 코드형 인프라 설정 업데이트

추가 정보: 원격 IaC 사용자 정의 규칙 번들 사용, 파이프라인 내 IaC 사용자 정의 규칙;원격 IaC 사용자 정의 규칙 번들 사용

그룹의 코드형 인프라 설정 가져오기

무시 (v1)

추가 정보: CI/CD 통합의 Snyk 테스트 및 Snyk 모니터

모든 무시 목록 보기

무시 교체

무시 추가

무시 검색

추가 정보: 시나리오: 조직의 모든 프로젝트에서 Snyk Code 문제를 포함한 모든 문제 목록 보기

무시 삭제

프로젝트 가져오기 (v1)

프로젝트는 Git 리포지토리, Docker 이미지, 컨테이너, 구성 파일 등이 될 수 있습니다. 자세한 내용은 Snyk 프로젝트를 참조하십시오. 해당 페이지에는 대상(Targets) 정의가 포함되어 있습니다.

일반적인 가져오기는 대상 가져오기(Import targets) 엔드포인트를 사용하여 처리할 대상을 요청하는 것으로 시작합니다. 그런 다음, 가져오기 작업 세부 정보 가져오기(Get import job details) 엔드포인트를 사용하여 가져오기 작업 API를 폴링하여 완료 여부 및 결과 Snyk 프로젝트에 대한 자세한 내용을 확인합니다.

대상 가져오기 및 가져오기 작업 세부 정보 가져오기

target.owner는 대소문자를 구분합니다.

대상 가져오기를 사용하는 시기와 방법에 대한 정보는 엔터프라이즈 구현 가이드의 프로젝트 가져오기 페이지의 Git 통합을 참조하십시오.

대상 가져오기 엔드포인트 호출이 실패하면 가져오기 작업 세부 정보 가져오기를 사용하여 이유를 파악하십시오. 실패에는 두 가지 유형이 있습니다.

리포지토리가 처리를 위해 거부되었습니다. 즉, HTTP 상태 코드 201이 반환되지 않았습니다. 이는 Snyk이 빠르게 확인할 수 있는 문제가 있을 때 발생합니다. 예:
- 리포지토리가 존재하지 않습니다.
- 토큰이 유효하지 않거나 권한이 충분하지 않아 Snyk이 리포지토리에 연결할 수 없습니다. 기본 브랜치가 없습니다.
리포지토리가 처리를 위해 수락되었습니다. 즉, 사용자가 HTTP 상태 코드 201과 폴링할 URL을 받았지만, 프로젝트가 감지되지 않았거나 일부가 실패했습니다. 이는 다음과 같은 이유로 발생할 수 있습니다.
- 이 리포지토리에 Snyk이 지원하는 매니페스트가 없습니다.
- 리포지토리가 보관(Archive)되었으며 파일을 가져오기 위한 Snyk API 호출이 실패합니다.
- 개별 프로젝트 또는 매니페스트를 처리하는 동안 문제가 발생했습니다. 이 경우 Snyk은 로그에 메시지와 함께 success: false를 반환합니다.

폴링 결과는 처리된 매니페스트당 success: true 또는 success: false 메시지를 반환합니다.

추가 정보: api-import 가져오기를 위한 가져오기 대상 데이터 생성; api-import 가져오기 시작

대상 가져오기(Import targets) 추가 정보: 통합 구성 (엔터프라이즈 구현 가이드, 2단계); 프로젝트 가져오기 (엔터프라이즈 구현 가이드, 3단계); 도구: snyk-api-import api-import 가져오기를 위한 가져오기 대상 데이터 생성 api-import 가져오기 시작 시나리오: 새로운 리포지토리만 식별하고 가져오기 시나리오: 리포지토리에서 새로운 프로젝트를 감지하여 대상으로 가져오기 시나리오: 정기적으로 리포지토리의 새로운 프로젝트(파일)를 감지하여 Snyk의 대상으로 가져오기 새로운 컨테이너 이미지 가져오기 코드 취약점 관리 (사용 용도: 여러 리포지토리 가져오기 자동화)

가져오기 작업 세부 정보 가져오기(Get import job details) 추가 정보: 시나리오: 새로운 컨테이너 이미지 가져오기; 도구: snyk-api-import api-import 가져오기를 위한 가져오기 대상 데이터 생성 api-import 가져오기 시작

통합 (v1)

새로운 통합 추가

추가 정보: 시나리오: 어떤 이유로든 Broker 토큰을 순환하거나 변경

목록 보기

추가 정보: 시나리오: 특정 이벤트 또는 시간 동안 Snyk에서 코드 베이스(소스 제어 관리)로의 모든 상호 작용(풀 리퀘스트, 테스트) 비활성화; api-import 가져오기를 위한 가져오기 대상 데이터 생성;

유형별 기존 통합 가져오기

기존 통합 업데이트

추가 정보: 설정에 필요한 토큰 획득; 시나리오: 특정 이벤트 또는 시간 동안 Snyk에서 코드 베이스(소스 제어 관리)로의 모든 상호 작용(풀 리퀘스트, 테스트) 비활성화; 기존 통합 업데이트 엔드포인트 예시

업데이트

검색

통합 복제 (설정 및 자격 증명 포함)

추가 정보: 배포를 위한 Snyk Broker 준비; 설정에 필요한 토큰 획득; 시나리오: 지정된 그룹 내에서 모두 동일한 설정을 가진 여러 개의 새로운 조직 생성

자격 증명 삭제

Broker 토큰 간 전환

새로운 Broker 토큰 프로비저닝

추가 정보: 설정에 필요한 토큰 획득

초대

사용자 초대도 참조하십시오.

사용자를 조직으로 초대

조직에 대한 대기 중인 사용자 초대 목록 보기

조직에 대한 대기 중인 사용자 초대 취소

문제

패키지별 문제 목록 보기

추가 정보: Dart 및 Flutter; Rust: Snyk C++용 지침 페이지, 대체 테스트 옵션 섹션; Java 및 Kotlin용 지침; JavaScript 및 Node.js용 지침; 패키지별 문제 목록 보기 페이지

지정된 패키지 세트에 대한 문제 목록 보기 (모든 고객이 사용할 수 있는 것은 아님)

조직 ID로 문제 가져오기

2025년 4월부터 이 엔드포인트를 사용하여 Snyk Code 문제를 검색할 수 있습니다. 문제의 coordinates 내 representations에 있는 source_location 데이터에 기본 파일 경로와 기본 영역 정보가 포함됩니다.

추가 정보: 시나리오: 대량 문제 무시; 조직의 모든 프로젝트에서 Snyk Code 문제를 포함한 모든 문제 목록 보기

문제 가져오기 (조직용)

그룹 ID로 문제 가져오기

참고: 응답에 해결 방법(Remedies)은 포함되지 않습니다.

추가 정보: 도달 가능성(Reachability)

문제 가져오기 (그룹용)

Jira (v1)

모든 Jira 문제 목록 보기

추가 정보: Jira 통합; CI/CD 통합의 Snyk 테스트 및 Snyk 모니터

Jira 문제 생성

추가 정보: Jira 통합; CI/CD 통합의 Snyk 테스트 및 Snyk 모니터

라이선스 (v1)

모든 라이선스 목록 보기

모니터 (v1)

종속성 그래프(Dep Graph) 모니터링

추가 정보: Dep Graph API (Bazel)

조직 (v1)

추가 정보: 웹훅 이벤트 및 페이로드

사용자가 속한 모든 조직 목록 보기

추가 정보: API를 사용하는 프로젝트의 조직 및 그룹 식별; 시나리오: 어떤 이유로든 Broker 토큰을 순환하거나 변경

새 조직 생성

추가 정보: 가시성 설정 및 조직 템플릿 구성 (엔터프라이즈 구현 가이드 2단계, 계정 구성); api-import: Snyk에서 조직 생성; 시나리오: 지정된 그룹 내에서 모두 동일한 설정을 가진 여러 개의 새로운 조직 생성

조직 제거

조직 설정 업데이트

'조직 설정 업데이트'에서 수정 가능한 유일한 속성은 requestAccess입니다.

추가 정보: 시나리오: 지정된 그룹 내에서 모두 동일한 설정을 가진 여러 개의 새로운 조직 생성

조직 알림 설정 가져오기

멤버 목록 보기

추가 정보: API를 사용하여 멤버 역할 업데이트; API를 사용하여 그룹 및 조직에서 멤버 제거

조직 내 멤버 정보 업데이트

추가 정보: 사용자 역할 관리

조직에서 멤버 제거

추가 정보: API를 사용하여 그룹 및 조직에서 멤버 제거; 사용자 역할 관리

조직 내 멤버 역할 업데이트

추가 정보: 사용자 역할 관리; API를 사용하여 멤버 역할 업데이트

사용자 초대

추가 정보: API를 사용하여 멤버 역할 업데이트; 시나리오: 지정된 목록의 모든 사용자를 회사의 모든 조직(그룹 내 모든 조직)에 할당

조직 (GA 및 베타)

접근 가능한 조직 목록 보기

추가 정보: Snyk Apps 사전 준비 사항; API를 사용하는 프로젝트의 조직 및 그룹 식별

조직 업데이트

역할을 가진 사용자의 조직 멤버십 생성

조직의 모든 멤버십 가져오기

역할을 가진 사용자의 조직 멤버십 업데이트

그룹의 모든 조직 목록 보기

조직 정보 가져오기 (베타)

추가 정보: 프로젝트의 조직 및 그룹 식별

프로젝트 (v1)

추가 정보: API의 프로젝트 유형 응답; 웹훅 이벤트 및 페이로드

프로젝트 업데이트

단일 프로젝트 검색

추가 정보: API의 프로젝트 유형 응답

프로젝트 삭제

추가 정보: API의 프로젝트 유형 응답; 시나리오: 새로운 컨테이너 이미지 가져오기

프로젝트에 태그 추가

추가 정보: 프로젝트 태그; Insights 설정: Snyk 오픈소스, 코드 및 컨테이너 프로젝트 연결; 시나리오: 어떤 이유로든 Broker 토큰을 순환하거나 변경

프로젝트에서 태그 제거

추가 정보: 프로젝트 태그

프로젝트 설정 업데이트

프로젝트 설정 목록 보기

프로젝트 설정 삭제

프로젝트를 다른 조직으로 이동

추가 정보: 시나리오: 한 조직에서 다른 조직으로 프로젝트 이동

모든 프로젝트 문제 경로 목록 보기

추가 정보: 프로젝트 문제 경로 API 엔드포인트

프로젝트 종속성 그래프(Dependency Graph) 가져오기

프로젝트 비활성화

프로젝트 속성 적용 (Applying attributes)

'속성 적용' API 엔드포인트를 사용하여 프로젝트가 생성된 후 비즈니스 중요도, 수명 주기 단계 및 환경을 포함한 Snyk 프로젝트의 속성을 설정할 수 있습니다. 방법은 다음과 같습니다.

대상 가져오기(Import targets) 엔드포인트를 사용하여 프로젝트를 가져옵니다.
대상 가져오기에서 상태 API ID를 가져옵니다.
모든 가져오기가 완료될 때까지 가져오기 작업 세부 정보 엔드포인트를 사용하여 폴링합니다.
projectURL 필드에서 프로젝트 ID를 파싱합니다.
속성 적용 엔드포인트를 사용하여 프로젝트 속성을 설정합니다.

추가 정보: 프로젝트 속성

모든 집계된 프로젝트 문제 목록 보기

Snyk V1 API 엔드포인트 모든 집계된 문제 목록 보기는 각 취약점에 대해 ignoreReasons 배열을 반환합니다. 이는 CLI 및 API를 사용하여 구현된 무시가 경로 기반이며, 따라서 서로 다른 경로에 대해 서로 다른 ignoreReasons를 가질 수 있기 때문에 발생합니다. '모든 집계된 문제 목록 보기'는 모든 경로에 대해 하나의 문제만 반환하므로 전체 사유 세트가 반환됩니다. Snyk은 식별자별로 문제를 그룹화하므로, 이 엔드포인트의 한 응답은 여러 경로에 걸친 동일한 문제에 대응할 수 있습니다. 따라서 ignoredReason은 집계된 모든 문제에 걸쳐 있으며 해당 단일 그룹화된 문제에 적용됩니다.

추가 정보: 시나리오: 조직의 모든 프로젝트에서 Snyk Code 문제를 포함한 모든 문제 목록 보기

프로젝트 활성화

프로젝트

지정된 조직 ID를 가진 조직의 모든 프로젝트 목록 보기

유형(types)에 대한 쿼리 문자열 매개변수는 선택 사항입니다. 이 엔드포인트는 특정 프로젝트 유형을 강제하지 않으며, 요청된 프로젝트 유형과 일치하지 않는 문자열을 입력하면 no matching projects를 반환합니다. 프로젝트 유형 목록은 API의 프로젝트 유형 응답을 참조하십시오.

추가 정보: Slack 앱 (Jira 통합용) (사용 용도: 프로젝트 ID 찾기); Snyk 프로젝트; 프로젝트 정보; 프로젝트 속성; 시나리오: 취약점의 영향을 받는 모든 프로젝트 찾기; 시나리오: 조직의 모든 프로젝트에서 Snyk Code 문제를 포함한 모든 문제 목록 보기; 시나리오: 대량 문제 무시; 시나리오: Snyk의 모든 프로젝트에 태그 달기; 시나리오: 새로운 컨테이너 이미지 가져오기; 시나리오: 리포지토리에서 새로운 프로젝트를 감지하여 대상으로 가져오기

프로젝트 ID로 프로젝트 업데이트

추가 정보: 프로젝트 설정 보기 및 편집; 스캔 시작 (사용 용도: 테스트 빈도 설정)

프로젝트 ID로 프로젝트 가져오기

프로젝트 ID로 프로젝트 삭제

풀 리퀘스트 템플릿 (Pull request templates)

그룹의 풀 리퀘스트 템플릿 생성 또는 업데이트

추가 정보: API를 사용하여 사용자 정의 PR 템플릿 생성 및 관리

그룹의 풀 리퀘스트 템플릿 가져오기

그룹의 풀 리퀘스트 템플릿 삭제

Reporting API (v1)

V1 보고(Reporting) 엔드포인트는 최신 릴리스가 아닌 Snyk 레거시 보고만 지원합니다. 따라서 이러한 엔드포인트는 단일 테넌트 구현이나 멀티 테넌트 지역인 US-02, EU 및 AU에서는 사용할 수 없습니다. 해당 지역에서는 Issues REST API를 사용하십시오.

V1 보고 API는 Snyk 레거시 보고의 기반이 됩니다. V1 보고 API를 사용하면 조직에 몇 개의 문제가 있는지, 또는 지정된 기간 동안 몇 번의 테스트가 수행되었는지와 같은 질문에 대한 답을 찾을 수 있습니다.

속도 제한은 사용자당 분당 최대 70회 요청입니다. 한도를 초과하는 모든 요청에 대해 속도 제한 간격(1분) 동안 요청이 중단될 때까지 상태 코드 429: Too many requests 응답이 반환됩니다. 자세한 내용은 V1 API 속도 제한을 참조하십시오.

추가 정보: 레거시 보고서; 종속성 및 라이선스