대화식 API 문서 페이지에 액세스

대화식 API 문서 페이지에서 RESTful API에 대한 기술적 세부사항에 액세스하고 서버에 대한 API 요청 작성을 시험합니다.

이 태스크에 대한 정보

API 문서 사용자 인터페이스는 설명 및 다음 REST API 인터페이스를 사용하는 기능을 제공합니다.
표 1. REST API 인터페이스
휴식 (REST API) 설명
/api/analytics 룰에 대한 사용자 정의 조치를 작성하고 업데이트하고 제거합니다.
/api/ariel 이벤트와 플로우 특성을 보고 이벤트와 플로우 검색을 작성하고 검색을 관리합니다.
/api/asset_model 모델에 있는 모든 자산의 목록을 리턴합니다. 사용 가능한 모든 자산 특성 유형 및 저장된 검색을 나열하고 자산을 업데이트할 수도 있습니다.

버전 24.0 의 ` UP11 `에서 자산을 생성할 수도 있습니다.

버전 26.0 의 UP13 에서 제품 세부 정보가 포함된 자산 목록을 조회하고 자산을 삭제할 수 있습니다.

/api/auth 로그아웃하고 현재 세션을 유효성 검증합니다.
/api/config 테넌트, 도메인 및 QRadar 확장을 보고 관리합니다.
/api/data_classification 모든 상위 및 하위 레벨 카테고리, QRadar ID (QID) 레코드 및 이벤트 맵핑을 봅니다. QID 레코드 및 맵핑을 작성하거나 편집할 수도 있습니다.
/api/forensics 캡처 복구 및 케이스를 관리합니다.
/api/gui_app_framework GUI 애플리케이션 프레임워크 소프트웨어 개발 킷을 사용하여 작성된 애플리케이션을 설치하고 관리합니다.
/api/help API 기능 목록을 리턴합니다.
/api/qrm QRM 저장된 검색 그룹, 질문 그룹, 시뮬레이션 그룹, 토폴로지 저장된 검색 그룹 및 모델 그룹을 관리합니다.
/api/qvm 자산, 취약성, 네트워크, 오픈 서비스. 네트워크 및 필터를 검색합니다. 개선 티켓을 작성하거나 업데이트할 수도 있습니다.
/api/reference_data 참조 데이터 콜렉션을 보고 관리합니다.
/api/scanner 스캔 프로파일과 관련된 원격 스캔을 보거나 작성 또는 시작합니다.
중요: IBM QRadar Vulnerability Manager 스캐너는 7.5.0 업데이트 패키지 6의 수명 종료 (EOL) 이며 IBM QRadar의 모든 버전에서 더 이상 지원되지 않습니다. 자세한 내용은 QRadar Vulnerability Manager: 서비스 종료 제품 알림 ( https://www.ibm.com/support/pages/node/6853425 )을 참조하십시오.
/api/services WHOIS 검색, 포트 스캔 검색, DNS 검색 및 DIG 검색과 같은 태스크를 수행합니다. IP 또는 IP 주소 세트에 대한 위치 정보 데이터를 검색할 수도 있습니다.
/api/siem 오펜스를 보고 업데이트하고 닫습니다. 또한 참고를 추가하고 오펜스 닫기 이유를 관리할 수 있습니다.
/api/staged_config 사용자, 호스트, 알림, 원격 네트워크 및 원격 서비스에 대한 스테이징된 구성을 검색합니다. 배치 조치 상태를 초기화하거나 볼 수 있으며 Yara 룰을 업데이트하고 삭제할 수도 있습니다.
/api/system 서버 호스트, 네트워크 인터페이스 및 방화벽 룰을 관리합니다.

프로시저

  1. 대화형 API 문서 인터페이스에 액세스하려면 웹 브라우저에 다음을 입력하십시오. URL https://ConsoleIPaddress/api_doc/.
  2. 목록에서 사용할 API 버전을 선택하십시오.
  3. 액세스할 엔드포인트로 이동하십시오.
  4. 엔드포인트 문서를 읽고 요청 매개변수를 완성하십시오.
  5. 클릭하여 API 요청을 콘솔로 보내고 올바른 형식의 HTTPS 응답을 받으십시오.
    주: 시험 사용을 클릭하면 QRadar 시스템에서 조치가 수행됩니다. 일부 조치는 되돌릴 수 없습니다. 예를 들어, 오펜스를 종료한 후에 다시 열 수 없습니다.
  6. QRadar와 통합하는 데 필요한 정보를 검토하고 수집하십시오.