IP Control API

Manager 관리콘솔 접근 없이 IP를 Bypass/Block 하는 API에 대한 설명서 입니다.
해당 API는 DeepFinder와 연동된 SIEM 또는 SOAR에서 분석된 탐지로그를 바탕으로 신속한 대응을 위해 만들어진 API입니다.

• 일반사용자 계정으로 이용 시 필요 권한
  [환경관리] - [사용자관리] 내
  [1]정책관리>정책조회
  [2]정책관리>정책설정
  

WhiteIP/BlackIP 추가

• API: apply_white_black_ip
  특정 보안정책에 한해 특정 IP를 Blacklist/Whitelist로 등록
  

API 호출로 등록되는 블랙리스트는 IP그룹 [API]_BLACK_LIST [ "도메인 그룹 ID" ]에 등록
API 호출로 등록되는 화이트리스트는 IP그룹 [API]_WHITE_LIST [ "도메인 그룹 ID" ]에 등록

[Parameter]

key :  API를 호출하는 계정의 API키

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

start_ip :  시작 IP 
    - 1.1.1.1 ~ 1.1.1.3 를 등록 하는 경우 -> 1.1.1.1

end_ip : 종료 IP 
    - 1.1.1.1 ~ 1.1.1.3 를 등록 하는 경우 -> 1.1.1.3
    - 단일IP를 등록 하는경우 end_ip는 보내지 않아도 됨

domaingid : 적용 할 도메인그룹  
expired_date : IP그룹에 등록된 IP의 만료시간 (만료시간이 되면 해당 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 등록 및 정책 설정 / 만료시간 O
- 화이트리스트 등록 : 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범위 등록 및 정책 설정 / 만료시간 X
- 화이트리스트 등록 : 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=white&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 호출로 [API]_BLACK_LIST [ "도메인 그룹 ID" ]에 등록되어 있는 IP를 삭제

[Parameter]

    key :  API를 호출하는 계정의 API키
    type : 예외처리 종류 (블랙리스트 등록 / 화이트리스트 등록 )
        화이트리스트 IP 삭제 : white
        블랙리스트 IP 삭제  : black
    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 삭제
    - 화이트리스트 IP 삭제 : http://[매니저 IP]/api/del_white_black_ip?key=[관리자 API Key]&type=white&domaingid=4&start_ip=1.1.1.1&end_ip=2.2.2.2
    - 블랙리스트 IP 삭제 : http://[매니저 IP]/api/del_white_black_ip?key=[관리자 API Key]&type=black&domaingid=4&start_ip=1.1.1.1&end_ip=2.2.2.2

[Response]

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