Skip to main content
POST
Redeem an enrollment code and register a device public key

Authorizations

overlay_session
string
cookie
required

Signed httpOnly browser session cookie.

Body

application/json
code
string
required
Required string length: 16 - 512
name
string
required
Required string length: 1 - 200
publicKey
string
required
Required string length: 64 - 8192
hostVersion
string
required
Required string length: 1 - 100
platform
string
required
Required string length: 1 - 200
capabilities
object
required
kind
enum<string>
default:local
Available options:
local,
vps,
overlay_cloud,
external

Response

Successful response. Stable response schemas are documented in workflow guides when available.

Response shape is route-specific and may be backed by @overlay/app-core contracts.