API 엔드포인트 인덱스 및 팁

이 문서의 인덱스 및 노트 섹션은 이 인덱스 외에도 특정 유스 케이스에 대한 해결책 및 Snyk APIs 사용 시나리오, 그리고 다음과 같은 Snyk API 엔드포인트 사용에 대한 상세 정보 페이지를 제공합니다:

특정 API에 대한 자세한 내용은 다음 섹션을 참조하십시오:

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

이 인덱스에는 REST GA 및 beta 및 V1 API 엔드포인트의 범주 및 이름이 포함되어 있으며, 각 엔드포인트에 대한 참조 문서의 URL 및 사용 가능한 경우 관련 정보로의 링크가 함께 제공됩니다. REST는 기본값이며 GA는 beta가 명시되지 않는 한 상태입니다. V1 API는 해당되는 경우에 지정됩니다. 이 인덱스는 진행 중인 작업이며, 지속적으로 추가 정보가 추가됩니다.

AccessRequests (beta)

액세스 요청 가져오기

Apps

추가 정보: Snyk 앱

귀하를 대신하여 작동하는 앱 목록 가져오기

앱 취소하기

앱에 대한 활성 OAuth 세션 목록 가져오기

활성 사용자 앱 세션 취소하기

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

설치 ID별로 앱의 액세스 취소하기

대체: 오류 발생 앱 권한 취소

오류 발생 조직을 위한 새로운 앱 생성

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

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

조직에 의해 생성된 앱 목록 가져오기

대체: 조직에 의해 생성된 앱 목록 가져오기

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

오류 발생 앱 속성 업데이트(이름, 리다이렉션 URI 및 액세스 토큰 유지 시간)

대체: App ID를 사용하여 이름, 리다이렉션 URI 및 액세스 토큰 유지 시간과 같은 앱 생성 속성 업데이트하기

오류 발생 클라이언트 ID별 앱 가져오기

대체: App ID로 Snyk 앱 가져오기

오류 발생 앱 삭제

대체: App ID로 Snyk 앱 삭제

오류 발생 앱을 위한 클라이언트 비밀 관리

대체: 상호 작용하지 않는 Snyk 앱 설치의 클라이언트 비밀 관리

이 조직에 Snyk 앱 설치하기

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

대체: 조직에 승인된 앱 봇 목록 가져오기

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

Snyk 조직에 대한 앱 권한 취소하기

참고: 설치 ID로 Snyk 그룹에 대한 앱 권한 취소하기

상호작용하지 않는 Snyk 앱 설치용 클라이언트 비밀 관리

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

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

대체: 조직을 위해 새로운 앱 생성하기

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

오류 발생 조직에 의해 생성된 앱 목록 가져오기

대체: 조직에 의해 생성된 앱 목록 가져오기

앱 ID를 사용하여 이름, 리다이렉션 URI 및 액세스 토큰 유지 시간 업데이트하기

대체: 이름, 리다이렉션 URI 및 액세스 토큰 유지 시간과 같은 앱 속성 업데이트하기

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

App ID로 Snyk 앱 가져오기

대체: 클라이언트 ID로 앱 가져오기

App ID로 앱 삭제하기

대체: App ID로 앱 삭제하기

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

Snyk 앱의 클라이언트 비밀 관리

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

오류 발생 조직에 승인된 앱 봇 목록 가져오기

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

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

오류 발생 앱 봇 권한 취소하기

대체: 설치 ID로 Snyk 그룹에 대한 앱 권한 취소하기

참고: 앱을 위한 액세스 취소

이 그룹에 Snyk 앱 설치하기

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

그룹에 설치된 앱에 대한 권한 취소

상호작용하지 않는 Snyk 앱 설치용 클라이언트 비밀 관리

대체: 앱용 클라이언트 비밀 관리

감사 로그

추가 정보: 조직이나 그룹을 위한 API로 사용자가 시작한 활동의 감사 로그 검색하기; AWS CloudTrail Lake

조직의 감사 로그 검색

추가 정보: 조직이나 그룹을 위한 API로 사용자가 시작한 활동의 감사 로그 검색하기, AWS CloudTrail Lake

그룹의 감사 로그 검색

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

감사 로그 (v1)

그룹 수준 감사 로그

그룹의 감사 로그 검색 사용

조직 수준 감사 로그

조직의 감사 로그 검색 사용

Cloud (beta)

환경 목록

새로운 환경 생성

환경 삭제

환경 업데이트

클라우드 제공자 권한 생성

리소스 목록

Snyk IaC (사용: IaC 및 클라우드 리소스의 인벤토리 보기)

스캔 목록

스캔 생성

스캔 가져오기

컬렉션

이 API를 사용하려면 프로젝트 히스토리 보기 권한이 필요합니다.

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

컬렉션 생성

컬렉션 가져오기

컬렉션 편집

컬렉션 가져오기

컬렉션 삭제

컬렉션에 프로젝트 추가

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

컬렉션에서 프로젝트 제거

ContainerImage

컨테이너 이미지의 인스턴스 목록

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

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

사용자 지정 기본 이미지

추가 정보: 사용자 지정 기본 이미지 권장사항 사용

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

추가 정보: 사용자 지정 기본 이미지 권장사항 사용, 섹션 [생성된 프로젝트를 사용자 지정 기본 이미지로 표시](../../scan프로젝트에서 API를 사용하여 조직 및 그룹 식별

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

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

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

추가 정보: API를 사용하여 그룹 및 조직에서 회원 삭제; API를 사용하여 조직 또는 그룹의 사용자 주도 활동에 대한 감사 로그 검색

그룹 (v1)

그룹 내 모든 태그 나열

추가 정보: 프로젝트 태그

그룹에서 태그 삭제

추가 정보: 프로젝트 태그

그룹 설정 업데이트

그룹 설정 보기

그룹 내 모든 역할 나열

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

그룹 내 모든 조직 나열

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

그룹 내 조직에 구성원 추가

그룹 내 모든 구성원 나열

추가 정보: API를 사용하여 그룹 및 조직에서 회원 삭제; 시나리오: 주어진 목록의 모든 사용자를 회사가 소유한 조직(그룹의 모든 조직)에 할당합니다

그룹

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

사용자에게 역할이 있는 그룹 멤버십 생성

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

그룹 멤버십에서 역할 업데이트

그룹에서 멤버십 삭제

IacSettings

조직을 위한 설정 업데이트

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

조직을 위한 설정 가져오기

그룹을 위한 설정 업데이트

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

그룹을 위한 설정 가져오기

Ignor...

그하 세부연락## 토큰 프로비저닝

더 많은 정보: 설정에 필요한 토큰 얻기 (Snyk Broker Code Agent)

초대

사용자를 조직으로 초대

조직으로의 보류 중인 사용자 초대 목록

조직으로의 보류 중인 사용자 초대 취소

이슈

패키지에 대한 이슈 목록

더 많은 정보: Dart 및 Flutter; Rust: 페이지를 위한 Snyk for C++ 지침, 대체 테스트 옵션 섹션; Java 및 Kotlin을 위한 지침; JavaScript 및 Node.js를 위한 지침, 비관리 JavaScript 섹션; 패키지에 대한 이슈 목록 페이지

특정 집합의 패키지에 대한 이슈 목록 (모든 고객에게 제공되지 않음)

Org ID별 이슈 조회

더 많은 정보: 시나리오: 이슈 대량 무시; 조직 내 모든 프로젝트에서 의 모든 이슈 포함 목록

이슈 확인 (조직용)

그룹 ID별 이슈 조회

참고: 해결책은 응답에 포함되어 있지 않습니다.

추가 정보: Reachability

이슈 확인 (그룹용)

Jira (v1)

모든 Jira 이슈 목록

더 많은 정보: Jira 통합; CI/CD 통합에서 Snyk} 테스트 및 snyk monitor

Jira 이슈 생성

더 많은 정보: Jira 통합; CI/CD 통합에서 Snyk} 테스트 및 snyk monitor

라이선스 (v1)

모든 라이선스 목록

모니터 (v1)

모니터 Dep Graph

더 많은 정보: Dep Graph API (Bazel)

조직 (v1)

더 많은 정보: 웹훅 이벤트 및 페이로드

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

더 많은 정보: API를 사용하여 프로젝트의 조직 및 그룹 식별; 시나리오: 어떤 이유로든 Broker 토큰 회전 또는 변경

새 조직 생성

더 많은 정보: 가시성 설정 및 조직 템플릿 구성 (엔터프라이즈 구현 가이드 Phase 2, 계정 구성); api-import: Snyk에서 조직 생성; 시나리오: 특정 그룹에 동일한 설정을 갖는 여러 개의 새 조직 생성

조직 삭제

조직 설정 업데이트

조직 설정의 유일한 편집 가능한 속성은 requestAccess입니다.

더 많은 정보: 특정 그룹에 동일한 설정을 갖는 여러 개의 새 조직 생성

조직 설정 보기

더 많은 정보: 특정 그룹에 동일한 설정을 갖는 여러 개의 새 조직 생성

조직에 사용자 프로비저닝

더 많은 정보: API를 사용하여 조직에 사용자 프로비저닝: 시나리오: 첫 로그인 이전에 규모에 맞게 사용자를 조직에 추가

보류 중인 사용자 프로비저닝 목록

더 많은 정보: API를 사용하여 조직에 사용자 프로비저닝

보류 중인 사용자 프로비저닝 삭제

더 많은 정보: API를 사용하여 조직에 사용자 프로비저닝

알림 설정

더 많은 정보: 가져오기 대상 데이터 생성을 위한 API; 도구: snyk-api-import

조직 알림 설정 가져오기

모든 구성원 목록

더 많은 정보: API를 사용하여 구성원 역할 업데이트; API를 사용하여 그룹 및 조직에서 구성원 삭제

조직 내 구성원 업데이트

더 많은 정보: 사용자 역할 관리

조직에서 구성원 제거

더 많은 정보: API를 사용하여 그룹 및 조직에서 구성원 삭제; 사용자 역할 관리

조직에서 구성원 역할 업데이트

더 많은 정보: 사용자 역할 관리; API를 사용하여 구성원 역할 업데이트

사용자 초대

더 많은 정보: API를 사용하여 구성원 역할 업데이트; 시나리오: 회사의 모든 조직(그룹 내 모든 조직)에 특정 목록의 모든 사용자 할당

Orgs (GA 및 beta)

접근 가능한 모든 조직 목록

더 많은 정보: Snyk 앱 사전 요구 사항; API를 사용하여 프로젝트의 조직 및 그룹 식별

조직 업데이트

역할을 갖는 사용자를 위한 사용자의 org 멤버십 생성

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

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

그룹 내 모든 조직 목록

ORG 가져오기 (beta)

더 많은 정보: 프로젝트를 위한 Org 및 그룹 식별

프로젝트 (v1)

더 많은 정보: API에서 프로젝트 유형 응답; 웹훅 이벤트 및 페이로드

프로젝트 업데이트

단일 프로젝트 검색

더 많은 정보: API에서 프로젝트 유형 응답

프로젝트 삭제

더 많은 정보: 어노테이티드 가져오기 (Kubernetes 통합 섹션); API에서 프로젝트 유형 응답; 시나리오: 새 컨테이너 이미지 가져오기

프로젝트에 태그 추가

더 많은 정보: 프로젝트 태그; 인사이트 설정: , Code, 그리고 Container Projects 연관 설정; 시나리오: 어떤 이유로든 Broker 토큰 회전 또는 변경

더 많은 정보: 프로젝트 태그

더 많은 정보: 시나리오: 프로젝트를 다른 조직으로 이동

프로젝트 이슈 경로 목록

더 많은 정보: 프로젝트 이슈 경로 API 엔드포인트

프로젝트 종속성 그래프 가져오기

비활성화 (프로젝트)

적용 중(프로젝트) 속성

API 엔드포인트인 속성 적용을 사용하여 프로젝트가 생성된 후 비즈니스 중요도, 라이프사이클 단계 및 환경을 포함한 Snyk 프로젝트에 속성을 설정할 수 있습니다. 다음과 같이 진행합니다:

가져오기 대상 API 엔드포인트를 사용하여 프로젝트 가져오기
[가져오기 대상](../reference/import-projects-v1.md#org-orgid이유를 그룹화합니다. Snyk 는 문제를 식별자별로 그룹화하여 List all aggregated issues endpoint에 대한 한 응답은 여러 경로를 통해 동일한 문제에 해당할 수 있습니다. 따라서 ignoredReason은 집계된 모든 문제에 걸쳐 적용되며 해당 단일 그룹화된 문제에 적용됩니다.

추가 정보: 시나리오: 조직 내 모든 프로젝트에 포함된 Snyk Code 이슈를 포함한 모든 이슈 나열