Create cookie config API in Website Scanner

Use this API to create a reusable cookie configuration for your website scans. After you create a cookie configuration, reference it by ID when you create a scan.

create cookie config

POST /api/website-scanner/v1/cookie_configs

If Geo Region Restriction (GRR) is enabled for your account, add your region code to the host name: api-accessibility-<region>.browserstack.com. See Geo Region Restriction endpoints for the region codes and examples.

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
     -X POST "https://api-accessibility.browserstack.com/api/website-scanner/v1/cookie_configs" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "consent_config_1",
       "domain": "example.com",
       "cookies": "consent=accepted; region=uk"
     }'

Response attributes 201 Created JSON

Response

{
    "success": true,
    "data": {
        "id": 24,
        "name": "consent_config_1",
        "domain": "example.com",
        "cookies": "consent=accepted; region=uk",
        "createdAt": "2026-10-09T10:00:00Z"
    },
    "error": null
}

Error responses 422 Unprocessable Entity

The API returns a 422 status code when validation fails. The following validation errors can occur:

• Name is required
• A cookie configuration named '<name>' already exists
• Domain is required
• '<domain>' is not a valid domain. Send the domain only, without https:// or a path
• Cookies are required
• Cookie '<entry>' must be in name=value format
• Duplicate cookie name '<name>'
• Cookie name '<name>' is longer than 255 characters
• Cookie '<name>' has a value longer than 4096 characters
• A configuration can hold at most 50 cookies
• An account can hold at most 200 cookie configurations