Update a robot's cookies

curl --location --request PATCH 'http://dev-cn.your-api-server.com/robots/c3689adb-50aa-44af-b265-a7e0d4e5846e/cookies' \ --header 'authorization: Bearer YOUR_SECRET_API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '[ { "name": "ACCOUNT_CHOOSER", "value": 12341234, "domain": ".example.com", "expirationDate": 1723659417, "path": "/products/", "secure": true, "httpOnly": true, "hostOnly": true } ]'

{ "statusCode": 200, "messageCode": "success", "cookies": [ { "name": "ACCOUNT_CHOOSER", "value": 12341234, "domain": ".example.com", "expirationDate": 1723659417, "path": "/products/", "secure": true, "httpOnly": true, "hostOnly": true } ] }

请求参数

Path 参数

robotId

string

必需

Unique robot ID

You can find a robot's ID by opening it on the dashboard and copying its ID in the browser address bar.

示例值:

c3689adb-50aa-44af-b265-a7e0d4e5846e

Header 参数

authorization

string

必需

You can generate a new API key on your dashboard if you do not have one.

示例值:

Bearer YOUR_SECRET_API_KEY

Body 参数application/json

array of:

name

string

必需

The name of the cookie.

示例值:

ACCOUNT_CHOOSER

value

string

必需

The value of the cookie.

示例值:

12341234

domain

string

可选

The domain associated with the cookie. Specifies the domains to which the cookie should be sent.

示例值:

.example.com

expirationDate

number <int64>

可选

The expiration date of the cookie in seconds since the UNIX epoch (e.g., POSIX time). If not provided, the cookie will be treated as a session cookie.

示例值:

1723659417

path

string

可选

The URL path to which the cookie should be sent. If not provided, it defaults to the current path of the document location.

示例值:

/products/

secure

boolean

可选

Indicates whether the cookie should only be sent over secure (HTTPS) connections. If true, the cookie will not be sent over unencrypted HTTP connections.

示例值:

true

httpOnly

boolean

可选

If true, the cookie is accessible only through the HTTP(S) protocol and cannot be accessed through JavaScript or other client-side scripts.

示例值:

true

hostOnly

boolean

可选

If true, the cookie is only sent to the exact domain specified in the "domain" property. If false, the cookie is sent to subdomains as well, provided that the "domain" property allows it.

示例值:

true

示例

返回响应

🟢200A JSON object containing the updated monitor.

application/json

Body

statusCode

enum<number>

必需

枚举值:

200

messageCode

enum<string>

必需

枚举值:

success

array[object (RobotCookie) {8}]

可选

name

string

必需

The name of the cookie.

示例值:

ACCOUNT_CHOOSER

value

string

必需

The value of the cookie.

示例值:

12341234

domain

string

可选

The domain associated with the cookie. Specifies the domains to which the cookie should be sent.

示例值:

.example.com

expirationDate

number <int64>

可选

The expiration date of the cookie in seconds since the UNIX epoch (e.g., POSIX time). If not provided, the cookie will be treated as a session cookie.

示例值:

1723659417

path

string

可选

The URL path to which the cookie should be sent. If not provided, it defaults to the current path of the document location.

示例值:

/products/

secure

boolean

可选

Indicates whether the cookie should only be sent over secure (HTTPS) connections. If true, the cookie will not be sent over unencrypted HTTP connections.

示例值:

true

httpOnly

boolean

可选

If true, the cookie is accessible only through the HTTP(S) protocol and cannot be accessed through JavaScript or other client-side scripts.

示例值:

true

hostOnly

boolean

可选

If true, the cookie is only sent to the exact domain specified in the "domain" property. If false, the cookie is sent to subdomains as well, provided that the "domain" property allows it.

示例值:

true

🟠400A JSON containing error attributes. This will happen if any of the parameters are not valid.

🟠401The request is not authorized

🟠404The resource is not found

🔴500There was an error on the server