Read the Paid customer-owned hostname

get/v1/projects/{project_id}/paid-domain

Request

  • Base URL: https://app.ohmyho.st
  • URL: https://app.ohmyho.st/v1/projects/{project_id}/paid-domain
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project identifier.

Headers

X-Request-Idstring

Optional caller-provided correlation identifier.

Response

Current credential-free hostname, CNAME and certificate state.

status'not_configured' | 'awaiting_deployment' | 'pending' | 'active' | 'reconciliation_required' | 'deleted' | 'suspended' required
suspension_reason'paid_plan_required' | 'insufficient_organization_credits' | 'project_budget_exceeded' | 'null' nullable 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.

hostnamestring nullable required
environment'prod' required
cname_target'customers.omh.st' | 'customers.ohmyho.st' required
custom_hostname_statusstring nullable required
ssl_statusstring nullable required
urlstring uri nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.