> For the complete documentation index, see [llms.txt](https://openapi-docs.exosp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://openapi-docs.exosp.com/guide/agent/agent-install.md).

# 에이전트 현황

<mark style="background-color:green;">GET</mark> `https://openapi.exosp.com/status/v3/agent/install`

에이전트 현황을 조회하는 API 입니다.

* 조회대상(departmentType)은 선택사항입니다. 미제공 시 전체(필터 미적용) 기준으로 조회됩니다.
* 조회대상을 지정하면 해당 타입별 조건을 반드시 만족해야 합니다.
  * 조회대상을 **department**로 조회하는 경우, **departmentFull**은 **필수**입니다.
  * 조회대상을 **member**로 조회하는 경우, **email**과 **name**을 반드시 포함해야 합니다.

### Query Parameters

<table><thead><tr><th width="167">항목</th><th width="112">타입</th><th>설명</th></tr></thead><tbody><tr><td>departmentType</td><td>string</td><td><strong>조회대상</strong><br>department : 그룹 , member : 사용자</td></tr><tr><td>departmentFull<mark style="color:blue;">*</mark></td><td>string</td><td><strong>그룹 전체 경로</strong></td></tr><tr><td>email<mark style="color:blue;">*</mark></td><td>string</td><td><strong>사용자 메일</strong></td></tr><tr><td>name<mark style="color:blue;">*</mark></td><td>string</td><td><strong>사용자 이름</strong> </td></tr><tr><td>search</td><td>string</td><td><p><strong>검색어</strong></p><p>검색 대상 : 사용자 이름, 그룹 이름, OS 계정, 컴퓨터 이름<strong>,</strong> 이메일,</p><p>online : 온라인 , offline : 오프라인, offline_7days : 7일 이상 오프라인</p><p>기본값 : 빈값</p></td></tr><tr><td>sortField</td><td>string</td><td><strong>정렬을 원하는 컬럼명</strong><br>user_name : 이름, department_name : 그룹, product_os_user: OS 계정, computer_name: 컴퓨터 이름, time_install: 설치 시각, time_access: 마지막 통신 시각, product_os_type: OS 종류</td></tr><tr><td>sortType</td><td>string</td><td><strong>응답 데이터 정렬 유형 (제어 시각 기준)</strong><br>ASC : 오름차순, DESC : 내림차순</td></tr><tr><td>offset<mark style="color:red;">*</mark></td><td>int</td><td><strong>((현재 페이지 번호 -1)*tableSize)</strong><br>현재 페이지의 첫 번째 데이터가 위치한 인덱스를 나타냅니다.</td></tr><tr><td>tableSize<mark style="color:red;">*</mark></td><td>int</td><td><strong>페이지 사이즈</strong></td></tr><tr><td>timezone</td><td>string</td><td><p><strong>응답 데이터 타임존</strong><a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a> 에서 TZ identifier 참고</p><p>기본값 : UTC</p></td></tr></tbody></table>

### Response Schema

<table><thead><tr><th width="162">항목</th><th width="115">타입</th><th>설명</th></tr></thead><tbody><tr><td>code</td><td>int</td><td><p><strong>응답 처리 결과 코드</strong> </p><p>0 : 성공, 1 : 실패</p></td></tr><tr><td>message</td><td>string</td><td><p><strong>응답 처리 결과 메세지</strong></p><p>success : 성공, 그 외 : 실패</p></td></tr><tr><td>body</td><td>object</td><td><a data-mention href="#body">#body</a></td></tr></tbody></table>

#### **body 상세**

<table><thead><tr><th width="164">항목</th><th width="115">타입</th><th>설명</th></tr></thead><tbody><tr><td>data</td><td>array</td><td><a data-mention href="#data">#data</a></td></tr><tr><td>total</td><td>int</td><td><strong>전체 레코드 수</strong></td></tr><tr><td>offset</td><td>int</td><td><strong>((현재 페이지 번호 -1)*tableSize)</strong> 현재 페이지의 첫 번째 데이터가 위치한 인덱스를 나타냅니다.</td></tr><tr><td>tableSize</td><td>int</td><td><strong>페이지 사이즈</strong></td></tr></tbody></table>

#### data **상세**

<table><thead><tr><th width="181">항목</th><th width="110">타입</th><th>설명</th></tr></thead><tbody><tr><td>name</td><td>string</td><td><strong>사용자 이름</strong></td></tr><tr><td>email</td><td>string</td><td><strong>사용자 메일</strong></td></tr><tr><td>departmentFull</td><td>string</td><td><strong>그룹 전체 경로</strong></td></tr><tr><td>departmentName</td><td>string</td><td><strong>그룹 이름</strong></td></tr><tr><td>computerName</td><td>string</td><td><strong>컴퓨터 이름</strong></td></tr><tr><td>osType</td><td>string</td><td><strong>OS 유형</strong><br>windows : 윈도우 , macos : 맥</td></tr><tr><td>osDescription</td><td>string</td><td><strong>OS 버전</strong></td></tr><tr><td>osUserName</td><td>string</td><td><strong>OS 계정</strong></td></tr><tr><td>computerIP</td><td>string</td><td><strong>컴퓨터 IP</strong></td></tr><tr><td>macAddressList</td><td>string</td><td><strong>컴퓨터 MAC 주소</strong></td></tr><tr><td>agentVersion</td><td>string</td><td><strong>프로그램 버전</strong></td></tr><tr><td>installTimeUTC</td><td>string</td><td><strong>설치 시각( PC 기준 )</strong><br>UTC 기준, ISO 8601포맷</td></tr><tr><td>installTime</td><td>string</td><td><strong>설치 시각( 사용자 기준 )</strong><br>요청 타임존 기준,  ISO 8601포맷</td></tr><tr><td>dateOfAccessUTC</td><td>string</td><td><strong>마지막 통신 시각( PC 기준 )</strong><br>UTC 기준, ISO 8601포맷</td></tr><tr><td>dateOfAccess</td><td>string</td><td><strong>마지막 통신 시각( 사용자 기준 )</strong><br>요청 타임존 기준,  ISO 8601포맷</td></tr><tr><td>unAuth</td><td>string</td><td><strong>오프라인 여부</strong></td></tr><tr><td>isOnline</td><td>string</td><td><strong>온라인 여부</strong></td></tr><tr><td>isDeleted</td><td>string</td><td><strong>삭제 여부</strong></td></tr><tr><td>latestVersion</td><td>string</td><td><strong>에이전트 버전</strong></td></tr><tr><td>latestVersionLabel</td><td>string</td><td><strong>버전 종류</strong><br>standard : 정식, temp_patch : 커스텀</td></tr><tr><td>versionStatus</td><td>string</td><td><strong>업데이트 상태</strong><br>latest : 최신, outdated : 이전, unknown : 버전 없음·비교 불가, fetch_failed : 조회 실패</td></tr></tbody></table>

### Example

{% tabs %}
{% tab title="200 Success" %}

```javascript
curl -X 'GET' \
  'https://openapi.exosp.com/status/v3/agent/install?offset=0&tableSize=1000&timezone=Asia%2FSeoul' \
  -H 'accept: application/json' \
  -H 'x-exosp-access: YOUR_ACCESS_KEY' \
  -H 'x-exosp-secret: YOUR_ACCESS_SECRET' 

{
  "code": 0,
  "message": "success",
  "body": {
    "total": 1,
    "offset": 0,
    "tableSize": 1000,
    "data": [
      {
        "name": "test",
        "email": "test@exosp.com",
        "departmentFull": "어벤져스 > 제품",
        "departmentName": "제품",
        "computerName": "DESKTOP-GSEV8JK",
        "osType": "windows",
        "osDescription": "Windows 10 Pro 64bit",
        "osUserName": "sunghun",
        "computerIP": "192.168.0.11",
        "macAddressList": "00:11:22:33:44:55, AA:BB:CC:DD:EE:FF",
        "agentVersion": "3.2.1.0",
        "installTimeUTC": "2024-02-15T02:26:20+00:00",
        "installTime": "2024-02-15T11:26:20+09:00",
        "dateOfAccessUTC": "2024-02-15T02:26:20+00:00",
        "dateOfAccess": "2024-02-15T11:26:20+09:00",
        "unAuth": "N",
        "isOnline": "Y",
        "latestVersion": "3.2.2.0",
        "latestVersionLabel": "standard",
        "versionStatus": "latest"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}