Rename Browser Session

PATCH

/api/v1/cloud-browser/sessions/{sessionId}

Requires a login JWT; API keys are not accepted. Changes only the display name, trimmed to 1-100 characters. Does not change proxy, fingerprint, duration or recording settings.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful operation. Business data is in data; err, code and msg remain in the envelope. Inspect the response for state and availability.

Headers

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

🟠410

🟠413

🟠422

🟠429

🟠470

🔴500

🔴503

⚪default

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v1/cloud-browser/sessions/' \
--header 'x-team-id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "renamed-session"
}'

Response Example

200 - Example 1

{
    "data": {
        "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
        "name": "string",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    },
    "err": false,
    "code": 200,
    "msg": "SUCCESS"
}

Modified at 2026-10-28 10:42:27

Get Session Details and Status

Stop Browser Session