Local API V2 – Runtime Interface

Get Service Status

Endpoint

GET /openapi/v2/status

Checks whether the Local API service is available and returns the current service port, version, and host type.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "service": "dicloak-local-api",
    "status": "ok",
    "api_version": "2.0.0",
    "client_version": "2.9.11",
    "port": 52100,
    "auth_required": true,
    "host": "desktop"
  },
  "next": null
}

Get Version Information

Endpoint

GET /openapi/v2/version

Returns the Local API version, client version, system platform, and versions of locally installed browser kernels.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "api_version": "2.0.0",
    "client_version": "2.9.11",
    "platform": "darwin",
    "arch": "arm64",
    "kernel": {
      "installed": ["142.0.7444.60"]
    },
    "host": "desktop"
  },
  "next": null
}

Get Capabilities

Endpoint

GET /openapi/v2/capabilities

Returns the capabilities supported by the current Local API. Callers can use this endpoint at runtime to determine whether endpoints for Profiles, Proxies, Cookies, Fingerprints, Bookmarks, Extensions, Tags, Profile Groups, Member permissions, runtime status, and kernel queries are available.

The response fields are Boolean values. true means that the current Local API host supports the capability. false means that the capability is recognized as optional but is not currently available.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "profiles": true,
    "cookies": true,
    "proxies": true,
    "fingerprints": true,
    "bookmarks": true,
    "extensions": true,
    "tags": true,
    "profile_groups": true,
    "members": true,
    "member_groups": true,
    "permissions": true,
    "start_stop": true,
    "stop_all": true,
    "sessions": true,
    "kernels": true,
    "kernel_actions": false,
    "tabs": false,
    "host": "desktop"
  },
  "next": null
}

Get Health Status

Endpoint

GET /openapi/v2/health

Returns the current health status of the Local API, including the availability of authentication, runtime queries, API service connectivity, and the kernel data source.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "status": "ok",
    "checks": {
      "local_api": "ok",
      "auth": "ok",
      "runtime_bridge": "ok",
      "backend_forwarder": "configured",
      "kernel_provider": "ok"
    },
    "host": "desktop"
  },
  "next": null
}

Get Rate Limit Information

Endpoint

GET /openapi/v2/rate-limits

Returns information about the local and server-side rate limits that may apply to Local API requests.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "local": {
      "enabled": true,
      "strategy": "koa-ratelimit",
      "limit": 60,
      "window_ms": 6000
    },
    "backend": {
      "enabled": true,
      "strategy": "backend-managed"
    },
    "host": "desktop"
  },
  "next": null
}

List Running Profiles

Endpoint

GET /openapi/v2/sessions

Returns the Profiles currently running on this device, including runtime information such as process IDs, debugging ports, and WebSocket URLs.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "session_id": "desktop:1876881021063852034:12345",
        "profile_id": "1876881021063852034",
        "serial_no": 166,
        "name": "facebook-01",
        "status": "running",
        "pid": "12345",
        "debug_port": 17539,
        "web_socket_url": "ws://127.0.0.1:17539/devtools/browser/xxx",
        "started_at": null,
        "host": "desktop"
      }
    ]
  },
  "next": null
}

Stop All Running Profiles

Endpoint

POST /openapi/v2/sessions/stop-all

Stops all Profiles currently running on this device. By default, every Profile is processed through the full shutdown flow, including post-shutdown data synchronization.

Request Parameters

The request body is optional. If it is omitted, the default full shutdown flow is used.

Name	Type	Required	Description
skip_cookie_sync_after_close	boolean	No	Whether to skip Cookie sync after stopping.
skip_data_sync_after_close	boolean	No	Whether to skip data sync after stopping.
skip_extension_sync_after_close	boolean	No	Whether to skip Extension data sync after stopping.

Request Example

{
  "skip_cookie_sync_after_close": false,
  "skip_data_sync_after_close": false,
  "skip_extension_sync_after_close": false
}

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "requested": 2,
    "closed": ["1876881021063852034"],
    "forced": [],
    "failed": []
  },
  "next": null
}

Get Profile Runtime Status

Endpoint

GET /openapi/v2/profiles/{profileId}/session

Returns the runtime status of a specified Profile on the current device. If the Profile is not running, the request still succeeds and data.status is stopped.

Path Parameters

Name	Type	Required	Description
profileId	string	Yes	Profile ID.

Response Example for a Stopped Profile

{
  "code": 0,
  "msg": "success",
  "data": {
    "session_id": null,
    "profile_id": "1876881021063852034",
    "serial_no": null,
    "name": null,
    "status": "stopped",
    "pid": null,
    "debug_port": null,
    "web_socket_url": null,
    "started_at": null,
    "host": "desktop"
  },
  "next": null
}

List Installed Kernels

Endpoint

GET /openapi/v2/kernels

Returns the browser kernels installed on the current device.

Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "kernel_version": "142.0.7444.60",
        "name": "Chromium 142.0.7444.60",
        "status": "loaded",
        "installed": true,
        "loaded": true,
        "platform": "darwin",
        "arch": "arm64",
        "progress_percent": null,
        "host": "desktop"
      }
    ]
  },
  "next": null
}