Skip to main content
POST
Plan one Paid customer-owned hostname

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
hostname
string
required
Required string length: 4 - 253
Pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$

Response

Manual CNAME instructions and exact provider effects.

status
string
required
Allowed value: "planned"
hostname
string
required
Required string length: 4 - 253
environment
string
required
Allowed value: "prod"
cname_target
enum<string>
required
Available options:
customers.omh.st,
customers.ohmyho.st
effects
string[]
required
Required array length: 1 - 8 elements
Required string length: 1 - 512
risks
string[]
required
Required array length: 1 - 8 elements
Required string length: 1 - 512