V1 API
V1 API에 대하여
Snyk API는 엔터프라이즈(Enterprise) 플랜에서만 사용할 수 있습니다.
자세한 내용은 플랜 및 가격 책정(Plans and pricing)을 참조하십시오.
Snyk의 향후 개발은 REST API에 집중될 예정이므로 V1 API는 결국 지원이 중단(Deprecated)될 예정입니다.
V1 API를 사용하면 Snyk에서 정의한 방식에 따라 패키지의 문제를 테스트하고, Snyk 프로세스를 자동화하여 특정 워크플로우를 완수할 수 있습니다. 고객과 파트너는 다음과 같은 기능을 수행할 수 있습니다.
취약점 데이터 액세스
프로젝트(Project) 및 애플리케이션 스캔
조치(Remediation) 권고 사항 수신
사용자 데이터를 확인하여 맞춤형 보안 솔루션 구축
V1 API 엔드포인트는 참조(Reference)에서 확인할 수 있습니다.
API URL
Snyk은 다음 지역(Region)에서 호스팅됩니다. 각 지역에는 고유한 기본 URL이 있습니다.
SNYK-US-01
https://api.snyk.io/v1/
SNYK-US-02
https://api.us.snyk.io/v1/
SNYK-EU-01
https://api.eu.snyk.io/v1/
SNYK-AU-01
https://api.au.snyk.io/v1/
이 API는 HTTPS를 통해서만 사용할 수 있습니다. HTTP를 통해 API를 호출하면 모든 요청에 대해 404 응답이 반환됩니다.
인증
이 API를 사용하려면 Snyk에서 토큰을 가져와야 합니다. Snyk에 등록하고 로그인한 후 개인 계정 설정(Personal account settings)에서 토큰을 찾을 수 있습니다. 자세한 내용은 API 인증(Authentication for API)을 참조하십시오.
Authorization 헤더에 token 뒤에 토큰을 입력하여 제공하십시오.
그렇지 않으면 401 "Unauthorized" 응답이 반환됩니다.
속도 제한
Snyk은 고객에게 안정적인 경험을 제공하기 위해 V1 API에 대한 요청을 제한합니다.
V1 API의 기본 속도 제한은 분당 2,000회 요청이지만, 일부 특정 엔드포인트는 더 낮은 제한을 가집니다. 각 엔드포인트의 속도 제한을 확인하려면 참조 문서를 확인하십시오.
속도 제한을 초과하면 429 오류 응답을 받게 됩니다.
오류
V1 API는 오류 응답에 표준 HTTP 오류 코드를 사용합니다.
오류 참조 정보는 서버 응답의 x-error-reference 헤더에도 제공됩니다.
500 응답 예시:
Last updated