> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/server-status-monitoring.md).

# Server Status Monitoring

## Retrieve Server Status

> \## Function Description\
> \* Aggregates and returns the status of the API server, database, Redis, disk, and batch status.\
> \---\
> \## Status Codes\
> \* \*\*UP\*\* : Normal\
> \* \*\*DOWN\*\* : Failure\
> \* \*\*DEGRADED\*\* : Partial service issue (includes UNKNOWN)\
> \* \*\*UNKNOWN\*\* : Unable to collect information<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServerStatusResponse":{"type":"object","description":"Server Status Response DTO","properties":{"overallStatus":{"type":"string","description":"Overall Status (UP / DOWN / DEGRADED)"},"checkedAt":{"type":"integer","format":"int64","description":"Last Check Time (epoch ms)"},"services":{"type":"array","description":"Service Health List","items":{"$ref":"#/components/schemas/ServiceStatusInfo"}},"batch":{"$ref":"#/components/schemas/BatchSummary","description":"Batch Status"}}},"ServiceStatusInfo":{"type":"object","description":"Individual Service Status","properties":{"name":{"type":"string","description":"Service Name"},"key":{"type":"string","description":"Service Key (db / redis / disk / api)"},"status":{"type":"string","description":"Status (UP / DOWN / UNKNOWN)"},"detail":{"type":"string","description":"Detail Information (e.g. free space, etc.)"},"responseTimeMs":{"type":"integer","format":"int64","description":"Response Time (ms)"}}},"BatchSummary":{"type":"object","description":"Batch Status Summary","properties":{"runningCount":{"type":"integer","format":"int32","description":"Batches Running Today"},"failedCount":{"type":"integer","format":"int32","description":"Batches Failed Today"},"completedCount":{"type":"integer","format":"int32","description":"Batches Completed Today"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/server-status":{"get":{"tags":["Server Status Monitoring"],"summary":"Retrieve Server Status","description":"## Function Description\n* Aggregates and returns the status of the API server, database, Redis, disk, and batch status.\n---\n## Status Codes\n* **UP** : Normal\n* **DOWN** : Failure\n* **DEGRADED** : Partial service issue (includes UNKNOWN)\n* **UNKNOWN** : Unable to collect information\n","operationId":"getServerStatus","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServerStatusResponse"}}}},"900":{"description":"Business Processing Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Batch Execution List (Drill-down)

> \## Function Description\
> \* Retrieves the list of batches executed today by status (latest 50 items).\
> \* Used in the dropdown of the batch status card.\
> \---\
> \## status Parameter\
> \* \*\*RUNNING\*\* : Running (STARTED / STARTING)\
> \* \*\*COMPLETED\*\* : Completed\
> \* \*\*FAILED\*\* : Failed<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"BatchExecutionInfo":{"type":"object","description":"Batch Execution Detail (Drill-down List Item)","properties":{"jobName":{"type":"string","description":"Batch Job Name"},"status":{"type":"string","description":"Status (STARTED / STARTING / COMPLETED / FAILED, etc.)"},"startTime":{"type":"integer","format":"int64","description":"Start Time (epoch ms, null if not started)"},"endTime":{"type":"integer","format":"int64","description":"End Time (epoch ms, null if not ended)"},"durationMs":{"type":"integer","format":"int64","description":"Duration (ms, null if not calculable)"},"exitMessage":{"type":"string","description":"End Message (failure reason, etc.; null if none)"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/server-status/batches":{"get":{"tags":["Server Status Monitoring"],"summary":"Retrieve Batch Execution List (Drill-down)","description":"## Function Description\n* Retrieves the list of batches executed today by status (latest 50 items).\n* Used in the dropdown of the batch status card.\n---\n## status Parameter\n* **RUNNING** : Running (STARTED / STARTING)\n* **COMPLETED** : Completed\n* **FAILED** : Failed\n","operationId":"getBatchExecutions","parameters":[{"name":"status","in":"query","description":"Query Status (RUNNING / COMPLETED / FAILED)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BatchExecutionInfo"}}}}},"900":{"description":"Business Processing Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Server Status AI Insight

> \## Function Description\
> \* Returns an AI insight on the current server status via the xgen SERVER\_STATUS\_ANALYSIS workflow.\
> \---\
> \## Response Description\
> \* \*\*available=false\*\*: xgen disabled or ST025 code not registered — no insight\
> \* \*\*available=true\*\*: xgen analysis complete — Korean text insight in the insight field\
> \---\
> \## ST025 Registration Required\
> \* You must register the xgen workflow\_id in common code group \*\*ST025\*\*, code \*\*08\*\*, ref1Val.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServerStatusAiInsightResponse":{"type":"object","description":"Server Status AI Insight Response","properties":{"available":{"type":"boolean","description":"AI Analysis Availability (false if xgen is disabled or code is not registered)"},"insight":{"type":"string","description":"AI Insight Text (null if available=false)"},"analyzedAt":{"type":"integer","format":"int64","description":"Analysis Time (epoch ms)"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/server-status/ai-insight":{"get":{"tags":["Server Status Monitoring"],"summary":"Retrieve Server Status AI Insight","description":"## Function Description\n* Returns an AI insight on the current server status via the xgen SERVER_STATUS_ANALYSIS workflow.\n---\n## Response Description\n* **available=false**: xgen disabled or ST025 code not registered — no insight\n* **available=true**: xgen analysis complete — Korean text insight in the insight field\n---\n## ST025 Registration Required\n* You must register the xgen workflow_id in common code group **ST025**, code **08**, ref1Val.\n","operationId":"getServerStatusAiInsight","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServerStatusAiInsightResponse"}}}},"900":{"description":"Business Processing Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```