Skip to main content
POST
Generate cloud-browser access key

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of generate_cloud_browser_access_key.

sid
string
required

Antidetect browser sid (ab_br_…).

Required string length: 18
Pattern: ^ab_br_
ttl_hours
integer

Key lifetime in hours (default 8; the link is a bearer secret, keep it short).

Required range: 1 <= x <= 720
max_connects
integer

Max connect count before the key is spent.

Required range: 1 <= x <= 1000
allowed_ips
string[]

IP allow-list checked at connect time.

Maximum string length: 45
allowed_countries
string[]

ISO country allow-list checked at connect time.

Required string length: 2

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required
credits
object