Open Docs
  1. API Usage Guide
Open Docs
  • Developer Guide
    • Introduction
    • Beginner's Guide
    • Integration Guide
  • API Usage Guide
    • Create Browser Fingerprint
    • Query All Launched Browsers
    • Query Browser Fingerprint
    • Start Browser (POST)
    • Start Browser (GET)
    • Stop All Browsers
    • Query API Status
  1. API Usage Guide

Query API Status

API Description#

Function: Query the status of API services
Protocol: HTTP
Method: GET
URI: http://localhost:50213/status

Request Parameters#

ParameterDescriptionTypeRequiredOptional ValuesDefault
serviceService name to querystringNoall
detailedWhether to return detailed statusbooleanNotrue, falsefalse

Response Data#

ParameterDescriptionTypeOptional ValuesDefault
codeStatus codeint0: success, -1: error
msgStatus messagestring
dataStatus dataobject

Data Structure#

ParameterDescriptionTypeOptional ValuesDefault
serviceService namestring
statusService statusstringrunning, stopped, error
uptimeService uptime in secondsnumber
versionService versionstring

Example Request#

GET http://127.0.0.1:*/status?service=browser&detailed=true

Example Response#

Success:
{
  "code": 0,
  "msg": "success",
  "data": {
    "service": "browser",
    "status": "running",
    "uptime": 3600,
    "version": "1.0.1"
  }
}
Failure:
{
  "code": -1,
  "msg": "service not found",
  "data": null
}

Status Codes#

CodeDescription
0Success
-1Service error
-2Service not found
Modified at 2025-07-07 08:15:21
Previous
Stop All Browsers
Built with