Skip to content

獲取瀏覽器環境列表 ​

查詢環境列表;使用 POST 請求體可按分組篩選。

介面定義:ApiFox GET · ApiFox POST · 核對日期:2026-10-21。

請求 ​

http
GET /api/getBrowserList
POST /api/getBrowserList

使用客戶端 API 頁面顯示的服務地址和 api-key。示例埠 9000 僅作演示,必須替換為實際埠;認證說明見 概述。

JSON 請求體 ​

欄位按 ApiFox 示例整理,可選行為見呼叫說明。

引數型別必填說明
groupstring否分組篩選值;使用 POST JSON 請求體

當前客戶端補充引數 ​

以下引數未列入 ApiFox 的欄位 Schema,來自當前客戶端實現;使用舊客戶端時請確認版本是否支援。

引數位置說明
namePOST JSON按名稱精確匹配
remarkPOST JSON按備註精確匹配
pageGET Query / POST JSON頁碼,從 1 開始
pageSizeGET Query / POST JSON每頁數量,當前上限 1000

同時傳 page 和 pageSize 才執行分頁;均不傳則返回全部結果。組合篩選條件取交集,響應的頂層 total 為篩選後、分頁前的總數。

cURL 示例 ​

bash
curl --request GET 'http://127.0.0.1:9000/api/getBrowserList' \
  --header 'api-key: YOUR_API_KEY'
bash
curl --request POST 'http://127.0.0.1:9000/api/getBrowserList' \
  --header 'api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "group": "group1"
}'

響應示例 ​

結構示例:ApiFox 未定義響應欄位。當前客戶端還可能返回頂層 total。

json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Profile-1",
      "group": "group1",
      "proxy": {
        "mode": 0
      },
      "homepage": {
        "mode": 0,
        "value": ""
      },
      "cookie": {
        "jsonStr": "[]"
      }
    }
  ]
}

呼叫說明 ​

  • GET 無需請求體;POST 使用 JSON 請求體,例如 { "group": "group1" }。不要把篩選物件寫入 GET 請求體。
  • ApiFox 的 POST 示例只列出 group。當前客戶端另支援 name、remark 精確匹配,以及 page/pageSize 分頁;這些屬於客戶端補充能力,舊版請先確認支援情況。

請求失敗時同時檢查 HTTP 狀態碼與響應中的錯誤資訊,見 錯誤碼與排查。