Docs
API 1.39
Status
Jobs

Open a live browser session on a parked job

POST /v1/jobs/{id}/takeover: Open a live browser session on a parked job

POST /v1/jobs/{id}/takeover
Operation idtakeoverJob
Key scoperun: keys that run jobs (and admin keys)
SectionJobs

#Parameters

NameInTypeRequiredDescription
idpathstringyespattern ^job_[0-9a-hjkmnp-tv-z]{26}$

#Example request

curl -X POST "https://api.kaab.ist/v1/jobs/{id}/takeover" \
  -H "Authorization: Bearer $KAAB_API_KEY"

#Responses

#201

Live session

FieldTypeRequiredDescription
live_urlstring (uri)yes
tokenstringyes
expires_inintegeryes≥ 1

#Errors

Every error answers with the error envelope; its code is one of the error codes.

StatusWhen
400request_invalid: request validation failed
401Missing or invalid API key
402insufficient_credits: top up to continue
403The key's scope does not cover this operation
404Resource not found
409Conflicting state (see error.code)
422Semantically invalid request (see error.code)
429Rate limited; see Retry-After
500internal: unexpected server error

Was this page helpful?