알림 템플릿 설정

지정한 유형의 알림 템플릿 내용을 로케일별로 설정합니다. 현재 설정된 값은 알림 템플릿 조회 API로 확인할 수 있습니다.

필요 권한

클러스터 관리자 권한이 필요합니다.

HTTP 요청

POST /api/sonar/push-templates/:type

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d 'template=[$category] 소명 요청 안내' \
     -d 'locale=ko' \
     -X POST \
     https://HOSTNAME/api/sonar/push-templates/mail_explain_req_subject

요청 매개변수

경로 매개변수

키	타입	설명	비고
type	문자열	템플릿 유형	아래 유형 코드 중 하나

type에는 아래의 유형 코드 중 하나를 지정합니다.

유형 코드	설명
explanation_domain	소명 작성 웹페이지 도메인 주소
mail_explain_req_subject	소명 요청 메일 제목
mail_explain_req_body	소명 요청 메일 본문
mail_explain_review_req_subject	검토 요청 메일 제목
mail_explain_review_req_body	검토 요청 메일 본문
sms_explain_req_msg	소명 요청 SMS 본문
sms_explain_review_req_msg	검토 요청 SMS 본문
mail_explain_complete_subject	소명 완료 메일 제목
mail_explain_complete_body	소명 완료 메일 본문
mail_user_verification_subject	MFA 인증 코드 발송 메일 제목
mail_user_verification_body	MFA 인증 코드 발송 메일 본문
mail_report_subject	보고서 메일 제목
mail_report_body	보고서 메일 본문
mail_default_body	기본 메일 본문(sonar-sendmail 명령어의 본문 템플릿, 플레이북 메일 본문 미설정 시 대체값으로도 사용)
mail_playbook_body	플레이북 메일 본문
mail_ticket_alarm_subject	티켓 알람 메일 제목
mail_ticket_alarm_body	티켓 알람 메일 본문

요청 본문 매개변수

키	필수	타입	설명	비고
template	X	문자열	템플릿 내용	`_body`로 끝나는 유형(`mail_ticket_alarm_body`는 제외)은 HTML 정제 후 저장, 그 외 유형은 정제 없이 그대로 저장. 일부 유형은 매크로 치환을 지원(하단 참고)
locale	X	문자열	로케일	`en`, `ko`, `ja`, `zh` 중 하나. 미지정 시 기본 템플릿

Note

explanation_domain 유형을 제외한 나머지 유형은 로케일별로 개별 저장되며, locale을 지정하지 않으면 기본 템플릿에 저장됩니다.

template에 사용할 수 있는 매크로는 알림 템플릿 목록 조회 API 문서를 참고하세요.

정상 응답

{}

오류 응답

권한이 없는 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}

type가 지원되는 유형 코드가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "type should be one of explanation_domain, mail_explain_req_subject, mail_explain_req_body, mail_explain_review_req_subject, mail_explain_review_req_body, sms_explain_req_msg, sms_explain_review_req_msg, mail_explain_complete_subject, mail_explain_complete_body, mail_user_verification_subject, mail_user_verification_body, mail_report_subject, mail_report_body, mail_default_body, mail_playbook_body, mail_ticket_alarm_subject, mail_ticket_alarm_body."
}

locale가 지원되지 않는 값인 경우

HTTP 상태 코드 500 응답

{
  "error_code": "illegal-state",
  "error_msg": "'de' is unsupported locale."
}