API Request Parameter Examples

This article provides examples and explanations of API request parameters to help developers understand how to correctly construct API call requests.

CosLogin Local API Documentation

Updated: 2026-06-18

General Instructions

  • Listening address: 127.0.0.1
  • Default port: 54345
  • Request method: Only supports POST
  • Request body: JSON body
  • Authentication header: X-Cos-Local-Token: <local access token>
  • Client status: Must be logged in, otherwise returns 401 client not logged in

Recommended request headers:

Content-Type: application/json
X-Cos-Local-Token: <local access token>

Uniform response structure:

{
  "code": 0,
  "msg": "success",
  "data": {}
}

Overview of Open APIs

CategoryLocal API PathDescription
WindowPOST /browser/openOpen browser window
WindowPOST /browser/closeClose browser window
WindowPOST /browser/updateCreate or edit window
WindowPOST /browser/create/batchBatch create windows
WindowPOST /browser/batch-createBatch create window alias
WindowPOST /browser/createBatchBatch create window alias
WindowPOST /browser/update/partialPartial/batch update windows
WindowPOST /browser/listQuery window list
WindowPOST /browser/detailQuery window details
WindowPOST /browser/deleteDelete window
WindowPOST /browser/delete/idsBatch delete windows
WindowPOST /browser/group/updateBatch modify window groups
WindowPOST /browser/remark/updateBatch modify window remarks
WindowPOST /browser/proxy/updateBatch modify window proxies
GroupPOST /group/listQuery group list
GroupPOST /group/addAdd group
GroupPOST /group/editEdit group
GroupPOST /group/deleteDelete group
GroupPOST /group/detailQuery group details
TagPOST /browserTag/listQuery tag list
TagPOST /browserTag/createCreate tag
TagPOST /browserTag/updateEdit tag
TagPOST /browserTag/deleteDelete tag
TagPOST /browserTag/updateRelationUpdate window tag relationship

Key Updates in This Release

  • Added windowPlatform/window_platform to window creation and batch window creation.
  • Added currentPlatform/current_platform to existing window operations.
  • Added a new batch window creation endpoint POST /browser/create/batch, while retaining the compatible paths POST /browser/batch-create and POST /browser/createBatch.
  • Group and tag documentation have been separated into independent pages to facilitate synchronization with the three current online documentations.

Last modified: 2026-06-22