setNotiConfig

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

File Filter를 사용한 분석 결과의 통보를 설정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /setNotiConfig

요청 헤더

File Safer API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 File Safer API 공통 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
notificationType String Required 분석 결과 통보 조건
  • OFF | MAL | MAE | ERR | ALL
    • OFF: 통보 안 함
    • MAL: 악성 코드 탐지 시 통보
    • MAE: 악성 코드 탐지 또는 조회 실패 시 통보
    • ERR: 조회 실패 시 통보
    • ALL: 모두 통보

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://filesafer.apigw.gov-ntruss.com/filefilter/v1/setNotiConfig' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--data '{
    "notificationType": "ALL"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
returnCode String Required 응답 코드
returnMessage String Required 응답 메시지

응답 상태 코드

File Safer API에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 File Safer 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "returnCode": "0",
    "returnMessage": "success"
}