Web Security Checker

참고

네이버 클라우드 플랫폼의 상품 사용 방법을 보다 상세하게 제공하고, 다양한 API의 활용을 돕기 위해 [설명서][API 참조서]를 구분하여 제공하고 있습니다.

Web Security Checker API 참조서 바로가기 >>
Web Security Checker 설명서 바로가기 >>

개요

Web Security Checker API는 RETSTful 형태로 제공되며, 제공되는 API를 호출하기 위해서는 Sub Account (서브 계정) 생성 및 Access Key 가 필요합니다.

공통 설정

API

Service API Method Request URI
Web Security Checker getJobs GET https://wsc.apigw.ntruss.com/api/v1/jobs
Web Security Checker searchJobs POST https://wsc.apigw.ntruss.com/api/v1/jobs/search
Web Security Checker cancelJob PATCH https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/cancel
Web Security Checker stopJob PATCH https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/stop
Web Security Checker getReport GET https://wsc.apigw.ntruss.com/api/v1/jobs/report

요청 헤더

IAM 인증을 위한 요청 헤더입니다.

헤더명 설명
x-ncp-apigw-timestamp 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것입니다.
API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주합니다.
x-ncp-iam-access-key 네이버 클라우드 플랫폼에서 IAM 에서 발급받은 AccessKey 입니다.
x-ncp-apigw-signature-v2 요청 경로 및 헤더를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명으로
HMAC 암호화 알고리즘은 HmacSHA256 을 사용합니다.

공통 오류

HTTP 응답 코드 ErrorCode ErrorMessage
400 100 Bad Request Exception
401 200 Authentication Failed
401 210 Permission Denied
404 300 Not Found Exception
429 400 Quota Exceeded
429 410 Throttle Limited
429 420 Rate Limited
413 430 Request Entity Too Large
503 500 Endpoint Error
504 510 Endpoint Timeout
500 900 Unexpected Error

상품 오류

HTTP 응답 코드 errorCode message 설명
200 0 success 성공
200 901 API Call Fail 일시적으로 사용이 원활하지 않습니다. 오류가 계속될 경우 고객센터에 문의하세요.
200 169201 Auth Check Error 사용 권한이 없습니다
200 169202 User Check Error 고객님 계정정보 확인에 실패하였습니다. 확인을 위해 고객문의 부탁 드립니다.
200 160331 ActionURL Check Error Action URL 에 http, https 를 입력해 주세요
200 160332 Param Check Error 입력값에 허용되지 않는 값이 있습니다. ID param / PW param 값에는 특수문자 사용이 제한 됩니다.
200 160351 Login_Check_Fail 로그인 과정에서 오류가 발생하였습니다. 로그인 정보를 다시 확인하여 재시도 해주시거나, Cookie 를 직접 입력해 주세요.
200 160353 URL Connection Error 입력하신 Action URL 연결에 실패하였습니다
200 160431 Param Check Error 입력값에 허용되지 않는 값이 있습니다
200 160432 Param Check Null 입력값에 누락이 있습니다
200 160433 Param Value Not Define 입력값에 정의되지 않은 값이 있습니다
200 160441 DB Execute Query Error 스캔 작업 등록 처리과정에서 에러가 발생되었습니다. 잠시후 다시 시도하여 주시기 바랍니다
200 160451 Assets_Check_Fail 고객님의 NCP 서버가 아닙니다. 고객님 소유의 NCP 자산만 진단 가능 합니다
200 160452 Queue_Full 선택하신 일정은 예약이 꽉 찼습니다. 다른 일정으로 선택해 주세요.
200 160453 Already_Exists 하나의 대상에 대해서 취약점 진단을 동시에 수행할 수 없습니다. 현재 설정한 진단 대상은 진단 대기중 이오니, 페이지 상단에 있는“Scan Status / Results” 메뉴에서 확인 부탁 드립니다.
200 160454 TooMany_Insert 작업 대기중인 리스트가 너무 많습니다. 스캔 진행 후 추가해 주세요
200 160455 ReScan Create failed 재진단 등록 조건이 맞지 않습니다. 대상의 도메인 및 IP 가 최초 진단과 같아야하며, 첫 진단 종료로부터 60일 내에 3번만 가능합니다.
200 160456 Managed Service agree chk failed 타사 웹서버 진단에 대한 동의 정보를 확인 할 수 없습니다. 동의하신 후 이용 가능합니다.
200 160457 Managed Service file chk failed 타사 웹서버 진단에 필요한 파일체크에 실패 하였습니다. 타사 웹서버 진단 안내 팝업의 2번 항목을 진행해주시기 바랍니다.
200 160701 Open period expired 진단결과 리포트의 열람 가능 기간은 1년 입니다.
200 160842 DB Matcing Data 0 취소할 대상이 없습니다. 일괄 취소는 예약 및 대기 상태의 작업만 취소 가능합니다.
200 165244 DB Data Record CNT Not Matching 요청된 intacneNo 리스트와 DB조회 레코드 수가 다릅니다.

오퍼 레이션