# API 제공(On-premise 전용)

{% hint style="info" %}
제공하는 API로 가공하여 원하는 정보를 얻을 수 있습니다. 

On-premise 환경에서만 이용 가능합니다.
{% endhint %}

### 1. API 인증키 설정 <a href="#id-1" id="id-1"></a>

* 그룹관리 > 연동설정 메뉴에서 설정할 수 있습니다.
* 발급하기 버튼을 누르면 다음과 같이 API 인증키가 발급됩니다.<br>

  <figure><img src="https://qubitsec.github.io/docs/images/Manual/siem/api/1.png" alt=""><figcaption></figcaption></figure>

### 2. 제공되는 정보 <a href="#id-2" id="id-2"></a>

* 발급받은 인증키를 사용하여 Rest API 방식을 이용하여 조회 작업을 하실 수 있습니다.
* 로그의 정보는 제공하지 않습니다.
* 다음의 정보들이 제공됩니다.

> - 탐지로그 건수 : 상관분석, 호스트로그, 웹로그, 네트워크로그, 계정탈취공격
> - 전체로그 건수 : 운영체제, 호스트 IP주소, 호스트명, 발생시간
> - 호스트별 전체로그 및 탐지 대상 건수
> - 컴플라이언스 메뉴별 탐지 건수
> - 전체로그, 탐지로그 티켓 발급 건수
> - 로그 유입량(시/일/주/월)
> - 에이전트 설치 서버 수 및 전체로그 및 웹로그 수집여부, 호스트로그 수집여부
> - 호스트별 정보(에이전트 정상 동작 상태, 등록정보 등)
> - 웹방화벽 차단 아이피 대량 등록
> - 탐지로그 위험도 기준 탐지 수 제공


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.plura.io/ko/fn/comm/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.