Skip to main content
POST
Connect a BYO machine

Authorizations

Authorization
string
header
required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID
string
required
Pattern: ^org_[a-z2-7]{26}$

Body

application/json
display_name
string
required

Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.

Required string length: 1 - 64
description
string
cwd
string
env
object
secret_env
object
metadata
object

User-supplied metadata stored on a machine, provided directly or copied from the machine pool that provisions it. A restriction of Metadata that leaves room for one reserved pair - Omnara sets observed_platform on the machine to the platform reported by its daemon, so the key is reserved and at most 15 user pairs are accepted.

project_ids
string[]
Maximum array length: 100
Pattern: ^proj_[a-z2-7]{26}$
token_name
string

Optional daemon token name. Omitted values default to daemon.

Required string length: 1 - 64

Response

Machine, daemon token, and selected project grants created.

machine
object
required
token
string
required

Opaque bearer credential.

Minimum string length: 1
token_record
object
required
project_grants
object[]
required