Skip to main content
Connect to a ready Tool environment

Authorizations

Authorization
string
header
required

Opaque control credential

Headers

Idempotency-Key
string
required
Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
environmentId
string
required
Pattern: ^env_[0-9a-z]{12,32}$

Body

application/json
actorId
string
required
Required string length: 1 - 96
Pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
expectedRuntimeVersion
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
expectedLeaseGeneration
integer
required
Required range: 0 < x <= 9007199254740991
actorInstanceId
string
Required string length: 1 - 96
Pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
ttlMs
integer
Required range: 0 < x <= 3600000

Response

Exact environment selection and scoped connection lease

schemaVersion
enum<number>
required
Available options:
1
selection
object
required
access
object
required
replayed
boolean
required