Skip to main content
GET
Read the 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}$

Response

Current credential-free hostname, CNAME and certificate state.

awaiting_deployment means the requested hostname is declared but not provisioned. Its hostname is present, suspension_reason, custom_hostname_status, ssl_status and url are null. validation_records holds only the _omh-project TXT ownership record while the hostname is not yet proven, and is empty once it is proven. Publish that record, authorize Cloudflare, deploy to Prod, then repeat the same apply.

status
enum<string>
required
Available options:
not_configured,
awaiting_deployment,
pending,
active,
reconciliation_required,
deleted,
suspended
suspension_reason
enum<string> | null
required

Non-null only while suspended by the same Paid, credit-grace or stop-budget policy used by the gateway. DNS/TLS receipts remain intact; url is null while suspended.

Available options:
paid_plan_required,
insufficient_organization_credits,
project_budget_exceeded,
null
hostname
string | null
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
custom_hostname_status
string | null
required
ssl_status
string | null
required
validation_records
object[]
required
Maximum array length: 16
url
string<uri> | null
required
Pattern: ^https://