실시간 탐지 명령어 템플릿 목록 조회

모든 실시간 탐지 명령어 템플릿 목록을 조회합니다.

필요 권한

사용자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/stream-rule-command-templates

정상 응답

아래는 전체 실시간 탐지 명령어 템플릿 목록 중 일부입니다.

{
  "templates": [
    {
      "id": 2,
      "name": "IP 주소 일치",
      "field_type": "IP",
      "description": null,
      "config_specs": [
        {
          "name": "ip",
          "type": "string",
          "subtype": "ip",
          "display_name": "비교 IP",
          "description": "비교 대상 IP를 입력합니다."
        }
      ],
      "query": "search $field$ == ip($ip$)",
      "query2": "search $field$ != ip($ip$)"
    },
    {
      "id": 3,
      "name": "IP 주소가 네트워크 대역에 포함",
      "field_type": "IP",
      "description": null,
      "config_specs": [
        {
          "name": "subnet",
          "type": "string",
          "subtype": "subnet",
          "display_name": "비교 네트워크 대역",
          "description": "비교 대상 네트워크 그룹을 선택합니다."
        }
      ],
      "query": "matchnet field=$field$ guid=$subnet$ verify=f",
      "query2": "matchnet invert=t field=$field$ guid=$subnet$ verify=f"
    }
  ]
}

• templates (배열): 모든 실시간 탐지 명령어 템플릿 목록
  • id (32비트 정수): 템플릿 고유 식별자
  • name (문자열): 템플릿 이름
  • field_type (문자열): 적용 대상 필드 유형. DATE, IP, PORT, STRING, SHORT, INT, LONG, MD5, URL 중 하나.
  • description (문자열): 템플릿 설명
  • config_specs (배열): 템플릿 변수 명세 목록
    • name (문자열): 변수 이름
    • type (문자열): 변수 타입. string, number, array
    • subtype (문자열): UI 렌더링 힌트. ip, date, country, port_group 등 자동완성 및 유효성 검사를 지원하는 컴포넌트 선택을 지원하는 용도.
    • display_name (문자열): 로케일 적용된 변수 이름
    • description (문자열): 로케일 적용된 변수 설명
  • query (문자열): AND 조건에서 적용할 쿼리 문자열
  • query2 (문자열): NOT 조건에서 적용할 쿼리 문자열

오류 응답

관리 권한이 없는 경우

HTTP 상태 코드 500 응답.

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