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). Sets expires_at on the entry.

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

Cap on CONCURRENT sessions held on this key, counted live at connect. Not a lifetime quota: a key does not spend itself and never becomes exhausted. Omit for unlimited.

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
purpose
enum<string>

What the page behind the link does: relogin = sign the LinkedIn session back in and re-bind the browser on confirm (default); share = drive the browser, no sign-in step; recruiter_relogin = the relogin flow aimed at LinkedIn Recruiter (2026-09-15): the cloud browser opens on linkedin.com/talent so the seat holder signs the Recruiter session back in, and the confirmed restart re-checks the account's recruiter_status.

Available options:
relogin,
recruiter_relogin,
share
send_to_email
string<email>

Also email the link to this address, typically the person who holds the LinkedIn password and has no account on the platform. The mail is queued after the key is committed; result.sent_to_email echoes the address. A malformed address is 422 and mints nothing.

Maximum string length: 255

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