IP Control API

Manager 관리 콘솔에 직접 접근하지 않고 IP를 허용(Whitelist)하거나 차단(Blacklist)하는 API 가이드입니다.
이 API는 DeepFinder와 연동된 SIEM 또는 SOAR에서 탐지된 위협 로그를 기반으로, 신속하게 대응할 수 있도록 지원합니다.

필요 권한 (일반 사용자 계정)
[환경관리] - [사용자관리] 내
[1]정책관리>정책조회
[2]정책관리>정책설정

화이트리스트/블랙리스트 IP 추가

API: apply_white_black_ip
지정한 보안 정책의 화이트리스트 또는 블랙리스트에 특정 IP를 추가합니다.

블랙리스트 IP: [API]_BLACK_LIST ["도메인 그룹 ID"] IP 그룹에 추가됩니다.

화이트리스트 IP: [API]_WHITE_LIST ["도메인 그룹 ID"] IP 그룹에 추가됩니다.

[Parameter]

key :  (필수): API 호출에 필요한 사용자 계정의 고유 API 키

type : 정책 종류 (블랙리스트 등록 / 화이트리스트 등록)
    화이트리스트 등록 : white
    블랙리스트 등록 : black

start_ip : (필수): 등록할 IP 주소 또는 IP 대역의 시작 주소
    - 1.1.1.1 ~ 1.1.1.3 를 등록 하는 경우 -> 1.1.1.1

end_ip : (선택): IP 대역의 마지막 주소. 단일 IP 등록 시에는 생략 가능합니다.
    - 1.1.1.1 ~ 1.1.1.3 를 등록 하는 경우 -> 1.1.1.3
    - 단일IP를 등록 하는경우 end_ip는 보내지 않아도 됨

domaingid : (필수): 정책을 적용할 도메인 그룹의 ID  
expired_date : (선택): IP의 만료 시간을 지정합니다. (YYYY-MM-DDTHH:MM:SS 형식)
              지정한 시간이 지나면 해당 IP는 IP 그룹에서 자동으로 삭제됩니다.

[Sample URL]

http://[매니저 IP]/api/apply_white_black_ip?key=[관리자 API Key]&type=black&start_ip=2.2.2.2&domaingid=4&expired_date=2023-08-26T12:38:00

[Response]
- 성공 : Completed
- 실패 : 실패 메시지

[Example]

 단일 IP 등록 (만료 시간 지정)
- 화이트리스트 등록 : http://[매니저 IP]/api/apply_white_black_ip?key=abcde&type=white&start_ip=1.1.1.1&domaingid=4&expired_date=2023-12-31T12:30:00
- 블랙리스트 등록 : http://[매니저 IP]/api/apply_white_black_ip?key=abcde&type=white&start_ip=1.1.1.1&domaingid=4&expired_date=2023-12-31T12:30:00

IP 대역 등록 (만료 시간 미지정)
- 화이트리스트 등록 : http://[매니저 IP]/api/apply_white_black_ip?key=abcde&type=white&start_ip=1.1.1.1&end_ip=2.2.2.2&domaingid=4
- 블랙리스트 등록 : http://[매니저 IP]/api/apply_white_black_ip?key=abcde&type=black&start_ip=1.1.1.1&end_ip=2.2.2.2&domaingid=4

화이트리스트/블랙리스트 IP 조회

API: get_white_black_ip
API를 통해 특정 도메인 그룹에 설정된 화이트/블랙리스트 정책 및 IP 목록을 조회합니다.

[Parameter]

key :  API를 호출하는 계정의 API키
type : 조회할 정책 종류 (블랙리스트 등록 / 화이트리스트 등록 )
domaingid : 조회 할 도메인그룹

[Sample URL]

화이트리스트 조회
- http://[매니저 IP]/api/get_white_black_ip?key=[관리자 API Key]&type=white&domaingid=4
블랙리스트 조회
- http://[매니저 IP]/api/get_white_black_ip?key=[관리자 API Key]&type=black&domaingid=4

[Response]

Json 배열
    [
      {
        "groupname": "[API]_BLACK_LIST [ 4 ]",
        "igid": "1006",
        "type": "user",
        "atype": "black",
        "iplist": [
          {
            "endip": "10.3.3.3",
            "igid": "1006",
            "ipid": "500011",
            "expired_date": null,
            "startip": "10.3.3.3"
          },
          {
            "endip": "1.1.1.1",
            "igid": "1006",
            "ipid": "500021",
            "expired_date": "2023-08-26T12:38:00",
            "startip": "1.1.1.1"
          },
          {
            "endip": "2.2.2.2",
            "igid": "1006",
            "ipid": "500022",
            "expired_date": "2023-08-26T12:38:00",
            "startip": "2.2.2.2"
          }
        ],
        "log": "FULL",
        "domaingid": "4"
      }
    ]

IP 삭제

API: del_white_black_ip
API를 통해 추가된 화이트리스트 또는 블랙리스트 IP 그룹에서 특정 IP를 삭제합니다.

[Parameter]

key :  API를 호출하는 계정의 API키
type : (필수) 삭제할 정책 종류
  white: 화이트리스트에서 IP 삭제
  black: 블랙리스트에서 IP 삭제
start_ip :  시작 IP 
  - 1.1.1.1 ~1.1.1.1 를 삭제 하는 경우 -> 1.1.1.1
end_ip : 종료 IP 
  - 1.1.1.1 ~1.1.1.3 를 삭제처리 하는 경우  -> 1.1.1.3
  - 단일IP를 삭제 하는경우 end_ip는 보내지 않아도 됨
domaingid : 적용 할 도메인그룹

[Sample URL]

단일 IP 삭제
    - 화이트리스트 IP 삭제 : http://[매니저 IP]/api/del_white_black_ip?key=[관리자 API Key]&job=del&type=white&domaingid=4&start_ip=1.1.1.1
    - 블랙리스트 IP 삭제 : http://[매니저 IP]/api/del_white_black_ip?key=[관리자 API Key]&job=del&type=black&domaingid=4&start_ip=1.1.1.1

  IP 대역 삭제
    화이트리스트: http://[매니저 IP]/api/del_white_black_ip?key=[API 키]&type=white&domaingid=4&start_ip=1.1.1.1&end_ip=2.2.2.2
    블랙리스트: http://[매니저 IP]/api/del_white_black_ip?key=[API 키]&type=black&domaingid=4&start_ip=1.1.1.1&end_ip=2.2.2.2

[Response]

String
  - 성공 : Completed
  - 실패 : 실패 메시지