Skip to main content
POST
Create a host join token

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environment_name
string
required
Pattern: ^[a-z0-9][a-z0-9-]{0,62}$

Body

application/json
ttl_seconds
integer
default:3600

How long the token may be used to register a host.

Required range: 1 <= x <= 86400

Response

The join token.

join_token
string
required

The single-use token. It is shown in this answer only; the platform stores its hash.

expires_at
string<date-time>
required
environment
string
required
Pattern: ^[a-z0-9][a-z0-9-]{0,62}$