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.
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, and validation_records is empty. Authorize Cloudflare, deploy to Prod, then repeat the same apply.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ohmyho.st","colors":{"primary":"#000000","light":"#FFFFFF","dark":"#000000"},"logo":{"light":"https://mintcdn.com/ohmyhost/-GyHWgaHhneGtZo_/logo/light.svg?fit=max\u0026auto=format\u0026n=-GyHWgaHhneGtZo_\u0026q=85\u0026s=13af4972252c9a884618d20beaf5a174","dark":"https://mintcdn.com/ohmyhost/-GyHWgaHhneGtZo_/logo/dark.svg?fit=max\u0026auto=format\u0026n=-GyHWgaHhneGtZo_\u0026q=85\u0026s=542486c4c29d8647feb1cef3906c2b9a","href":"https://ohmyho.st/"},"favicon":"https://mintcdn.com/ohmyhost/-GyHWgaHhneGtZo_/favicon.svg?fit=max\u0026auto=format\u0026n=-GyHWgaHhneGtZo_\u0026q=85\u0026s=126e1d59c2b4e9943170f00595a8d730","navbar":{"links":[{"href":"https://ohmyho.st/","label":"Back to website"}],"primary":{"type":"button","label":"Back to Home","href":"https://ohmyho.st/"}},"footer":{"socials":{"github":"https://github.com/amerged-org/ohmyhost-docs"},"links":[{"header":"ohmyho.st","items":[{"label":"Home","href":"https://ohmyho.st/"},{"label":"Brand","href":"https://ohmyho.st/brand"},{"label":"Support","href":"https://docs.ohmyho.st/support"},{"label":"Contact","href":"https://ohmyho.st/contact"},{"label":"Privacy","href":"https://ohmyho.st/privacy"},{"label":"Terms","href":"https://ohmyho.st/terms"},{"label":"DPA","href":"https://ohmyho.st/dpa"}]}]},"fonts":{"heading":{"family":"Space Grotesk","weight":600,"source":"fonts/space-grotesk-600.woff2","format":"woff2"},"body":{"family":"Space Grotesk","weight":400,"source":"fonts/space-grotesk-400.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode","download-spec"],"display":"header"},"markdown":{"instructions":"For account actions, read https://ohmyho.st/skills/ohmyhost-get-started/SKILL.md and use the authenticated ohmyho.st CLI, local product MCP or supported remote OAuth MCP. Read the current project source binding before choosing GitHub or managed versions. Mintlify search only reads documentation. Preserve the customer’s selected project, environment and authentication provider; keep private application values in the portal or local stdin flow."},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ohmyhost","hasAudioNarration":false,"actualSubdomain":"ohmyhost","customDomains":["docs.ohmyho.st"],"gitSource":{"type":"github","owner":"amerged-org","repo":"ohmyhost-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae219f89297755be1a029d4","collectionId":"ec8a2b31-b6f5-4b4e-91ee-612ca46930c3","liveDeploymentHistoryId":"6ae219f89297755be1a029d4","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae219f89297755be1a029d4","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API reference","count":125},{"language":"default","tag":"Endpoints","count":124},{"language":"default","tag":"API Reference","count":124},{"language":"default","tag":"Guides","count":45},{"language":"default","tag":"Operate","count":15},{"language":"default","tag":"Deploy","count":12},{"language":"default","tag":"Start","count":8},{"language":"default","tag":"Legal","count":6},{"language":"default","tag":"Agent reference","count":4},{"language":"default","tag":"Overview","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"brand-fonts.css","content":"@font-face{font-family:\"JetBrains Mono\";font-style:normal;font-weight:400;font-display:swap;src:url(/fonts/jetbrains-mono-400.woff2) format(\"woff2\")}:root{--font-family-mono-custom:\"JetBrains Mono\"}code,kbd,pre,samp{font-family:\"JetBrains Mono\",ui-monospace,SFMono-Regular,Menlo,monospace}"},{"filePath":"analytics.css","content":"#cookie-notice,#omh-cookie-dialog{--cookie-bg:#fff;--cookie-fg:#18181b;--cookie-muted:#71717a;--cookie-border:#e4e4e7;background:var(--cookie-bg);color:var(--cookie-fg);border:1px solid var(--cookie-border);font:13px/1.5 var(--sans,system-ui);box-sizing:border-box}#cookie-notice{position:fixed;bottom:16px;right:16px;z-index:9999;display:flex;align-items:center;gap:8px;padding:12px 14px;max-width:min(440px,calc(100% - 32px));border-radius:12px;box-shadow:0 4px 20px #0000000d}#cookie-notice[hidden]{display:none}#cookie-notice>span{flex:1;color:var(--cookie-muted);font-size:12px}#cookie-notice a{color:inherit;text-underline-offset:2px}#cookie-notice button,#omh-cookie-dialog button{border:1px solid var(--cookie-border);border-radius:7px;background:0 0;color:inherit;padding:8px 14px;font:inherit;cursor:pointer;white-space:nowrap}#cookie-notice #omh-analytics-accept,#omh-cookie-dialog #omh-analytics-save{background:var(--cookie-fg);border-color:var(--cookie-fg);color:var(--cookie-bg)}#omh-cookie-dialog{width:440px;max-width:calc(100% - 32px);max-height:calc(100% - 32px);margin:auto;padding:24px;border-radius:16px;box-shadow:0 16px 64px #0003;overflow:auto}#omh-cookie-dialog::backdrop{background:#0006}#omh-cookie-dialog h2{font:600 20px/1.3 var(--sans,system-ui);margin:0 32px 6px 0;color:inherit}#omh-cookie-dialog p{font:13px/1.5 var(--sans,system-ui);color:var(--cookie-muted);margin:0}#omh-cookie-dialog .omh-cookie-option{display:flex;align-items:center;justify-content:space-between;gap:20px;border-top:1px solid var(--cookie-border);padding:18px 0}#omh-cookie-dialog>.omh-cookie-option:first-of-type{margin-top:20px}#omh-cookie-dialog .omh-cookie-option label,#omh-cookie-dialog .omh-cookie-option strong{display:block;font-weight:600;color:var(--cookie-fg);margin-bottom:4px}#omh-cookie-dialog .omh-cookie-required{font-size:11px;white-space:nowrap;color:var(--cookie-muted)}#omh-analytics-toggle{appearance:none;-webkit-appearance:none;flex-shrink:0;width:38px;height:22px;margin:0;border:1px solid var(--cookie-border);border-radius:20px;background:var(--cookie-border);cursor:pointer;position:relative}#omh-analytics-toggle::before{content:\"\";position:absolute;left:3px;top:3px;width:14px;height:14px;border-radius:50%;background:var(--cookie-bg);transition:transform .15s}#omh-analytics-toggle:checked{background:var(--cookie-fg);border-color:var(--cookie-fg)}#omh-analytics-toggle:checked::before{transform:translateX(16px)}#omh-cookie-dialog .omh-cookie-actions{display:flex;gap:10px;margin-top:6px}#omh-cookie-dialog .omh-cookie-actions button{flex:1}#omh-cookie-dialog #omh-cookie-close{position:absolute;top:14px;right:14px;border:0;font-size:24px;line-height:1;padding:6px;background:0 0;color:var(--cookie-muted)}#omh-analytics-settings{display:inline-flex;align-items:center;justify-content:center;position:static;vertical-align:middle;width:32px;height:32px;margin:0 0 0 auto;padding:6px;border:0;border-radius:6px;background:0 0;color:#71717a;opacity:1;cursor:pointer;flex-shrink:0}#omh-analytics-settings:hover{background:#71717a15}#omh-analytics-settings svg{display:block;pointer-events:none}#cookie-notice button:focus-visible,#omh-analytics-settings:focus-visible,#omh-analytics-toggle:focus-visible,#omh-cookie-dialog button:focus-visible{outline:2px solid currentColor;outline-offset:3px}html.dark #cookie-notice,html.dark #omh-cookie-dialog,html[data-theme=dark] #cookie-notice,html[data-theme=dark] #omh-cookie-dialog{--cookie-bg:#0a0a0a;--cookie-fg:#f0f0f2;--cookie-muted:#a1a1aa;--cookie-border:#27272a}@media (max-width:420px){#cookie-notice{flex-wrap:wrap}#cookie-notice>span{flex-basis:100%;margin-bottom:2px}#cookie-notice button{flex:1}#omh-cookie-dialog{padding:20px}}@media (prefers-reduced-motion:reduce){#omh-analytics-toggle::before{transition:none}}@media print{#cookie-notice,#omh-analytics-settings,#omh-cookie-dialog{display:none!important}}"}],"page":{"pagePath":"api-reference/read-the-paid-customer-owned-hostname","slug":"/api-reference/read-the-paid-customer-owned-hostname","pageMetadata":{"title":"Read the Paid customer-owned hostname","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/paid-domain","href":"/api-reference/read-the-paid-customer-owned-hostname","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read the Paid customer-owned hostname","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/paid-domain","href":"/api-reference/read-the-paid-customer-owned-hostname","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ohmyhost/8ed1e082b4c23339/analytics.js"],"openApiReferenceData":{"operation":{"operationId":"getPaidProjectDomain","summary":"Read the Paid customer-owned hostname","parameters":["845bba44-9e77-44be-9392-b5c37021fae0","ff507a37-9193-4ced-952f-28cfef5287f2"],"responses":{"200":"9fe1efc0-52f1-4e5b-b3ed-526798a39b91","400":"a25c6c31-9c2b-4a59-8c43-5d6a4e8fe210","401":"fc20f629-25c3-4fd7-91ea-078bc0626cad","403":"dbd9090c-6608-4d66-b5df-c80181d1666e","404":"89d57a63-f8b7-4a49-bf8a-7eb5e41d65ea","429":"5a151828-688a-4f96-89f0-39128ec555e2","503":"6cca59c8-f5cd-42be-ba82-60ab002d85c4"},"x-ohmyhost-resource-disclosure":"indistinguishable-not-found","method":"get","type":"path","servers":["715b4e6d-6866-488f-88e3-771d6b51144b","7b41f9ac-740e-4c15-849b-83353288eb51"],"security":["45a9c511-6fc8-4cdb-ad84-0e7bb167deb6"],"path":"/v1/projects/{project_id}/paid-domain","baseUrlOptions":["https://app.ohmyho.st","https://dev.app.ohmyho.st"],"title":"Read the Paid customer-owned hostname","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"845bba44-9e77-44be-9392-b5c37021fae0":{"name":"X-Request-Id","in":"header","description":"Optional caller-provided correlation identifier.","required":false,"schema":{"type":"string","minLength":1,"maxLength":128,"isRequired":false,"description":"Optional caller-provided correlation identifier.","uniqueKey":"","typeLabel":"string"}},"ff507a37-9193-4ced-952f-28cfef5287f2":{"name":"project_id","in":"path","description":"Project identifier.","required":true,"schema":{"type":"string","pattern":"^[0-9A-HJKMNP-TV-Z]{26}$","isRequired":true,"description":"Project identifier.","uniqueKey":"","typeLabel":"string"}}},"responses":{"9fe1efc0-52f1-4e5b-b3ed-526798a39b91":{"description":"Current credential-free hostname, CNAME and certificate state.","content":{"application/json":{"schema":{"type":"object","description":"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, and validation_records is empty. Authorize Cloudflare, deploy to Prod, then repeat the same apply.","additionalProperties":false,"required":["status","suspension_reason","hostname","environment","cname_target","custom_hostname_status","ssl_status","validation_records","url"],"properties":{"status":{"type":"string","enum":["not_configured","awaiting_deployment","pending","active","reconciliation_required","deleted","suspended"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"suspension_reason":{"oneOf":[{"type":"string","enum":["paid_plan_required","insufficient_organization_credits","project_budget_exceeded",null],"description":"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.","isRequired":true,"uniqueKey":"suspension_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["paid_plan_required","insufficient_organization_credits","project_budget_exceeded",null],"description":"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.","isRequired":true,"uniqueKey":"suspension_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"suspension_reason","typeLabel":"enum\u003cstring> | null"},"hostname":{"oneOf":[{"type":"string","maxLength":253,"minLength":4,"isRequired":true,"uniqueKey":"hostname.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"hostname.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"hostname","typeLabel":"string | null"},"environment":{"type":"string","const":"prod","isRequired":true,"uniqueKey":"environment","typeLabel":"string"},"cname_target":{"type":"string","enum":["customers.omh.st","customers.ohmyho.st"],"isRequired":true,"uniqueKey":"cname_target","typeLabel":"enum\u003cstring>"},"custom_hostname_status":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"custom_hostname_status.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"custom_hostname_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"custom_hostname_status","typeLabel":"string | null"},"ssl_status":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"ssl_status.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"ssl_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ssl_status","typeLabel":"string | null"},"validation_records":{"type":"array","maxItems":16,"items":{"type":"object","additionalProperties":false,"required":["type","name","content","purpose"],"properties":{"type":{"type":"string","enum":["CNAME","TXT"],"isRequired":true,"uniqueKey":"validation_records.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","minLength":1,"maxLength":253,"isRequired":true,"uniqueKey":"validation_records.items.[INDEX].name","typeLabel":"string"},"content":{"type":"string","minLength":1,"maxLength":2048,"isRequired":true,"uniqueKey":"validation_records.items.[INDEX].content","typeLabel":"string"},"purpose":{"type":"string","enum":["traffic","ownership","ssl","dcv_delegation"],"isRequired":true,"uniqueKey":"validation_records.items.[INDEX].purpose","typeLabel":"enum\u003cstring>"}},"uniqueKey":"validation_records.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"validation_records","typeLabel":"object[]"},"url":{"oneOf":[{"type":"string","format":"uri","pattern":"^https://","isRequired":true,"uniqueKey":"url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","isRequired":true,"uniqueKey":"url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"not_configured","suspension_reason":"paid_plan_required","hostname":"\u003cstring>","environment":"prod","cname_target":"customers.omh.st","custom_hostname_status":"\u003cstring>","ssl_status":"\u003cstring>","validation_records":[{"type":"CNAME","name":"\u003cstring>","content":"\u003cstring>","purpose":"traffic"}],"url":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a25c6c31-9c2b-4a59-8c43-5d6a4e8fe210":{"description":"The request failed.","headers":{"X-Request-Id":{"description":"Correlates the request with operations, events, logs, and audit records.","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details extended with stable ohmyhost recovery fields.","additionalProperties":false,"required":["type","title","status","code","request_id","retryable","suggested_action"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","enum":["invalid_request","unauthenticated","forbidden","organization_required","resource_not_found","idempotency_key_reused","project_handle_unavailable","project_identity_unavailable","deployment_plan_expired","deployment_plan_incompatible","confirmation_expired","confirmation_invalid","etag_mismatch","promotion_source_stale","promotion_target_stale","promotion_invalid_target","mail_domain_conflict","mail_domain_required","mail_capacity_unavailable","storage_jurisdiction_conflict","shared_data_requires_promotion","production_deployment_required","framework_conversion_required","repository_configuration_missing","migration_filename_noncanonical","environment_secret_mutation_blocked","workers_runtime_incompatible","project_handle_invalid","project_handle_taken","project_handle_unchanged","project_rename_blocked","payload_too_large","rate_limited","insufficient_organization_credits","paid_plan_required","project_budget_exceeded","compute_performance_paid_required","compute_paid_required","compute_storage_shrink_requires_migration","compute_performance_unavailable","database_write_pending","database_access_limit","compute_change_pending","compute_change_conflict","billing_purchase_conflict","billing_recharge_conflict","github_connection_required","github_connection_revoked","repository_not_installed","cloudflare_zone_not_bound","cloudflare_authorization_closed","project_notes_conflict","project_export_not_ready","powered_by_flag_required","interactive_login_required","api_key_creation_uncertain","api_key_permissions_unavailable","reconciliation_exhausted","service_unavailable","source_commit_not_found","domain_hostname_taken","domain_dns_conflict","data_change_blocked","data_change_in_progress","data_change_not_applicable","rollback_target_data_changed","project_domain_delete_required"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"suggested_action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggested_action","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"retry_after_seconds":{"type":"integer","minimum":1,"maximum":86400,"description":"Optional machine-readable retry delay for a rate limit, matching Retry-After.","uniqueKey":"retry_after_seconds","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":499,"code":"invalid_request","request_id":"\u003cstring>","retryable":true,"suggested_action":"\u003cstring>","detail":"\u003cstring>","instance":"\u003cstring>","retry_after_seconds":43200}}},"exampleType":"generated"}},"exampleType":"generated"},"fc20f629-25c3-4fd7-91ea-078bc0626cad":{"description":"The request failed.","headers":{"X-Request-Id":{"description":"Correlates the request with operations, events, logs, and audit records.","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details extended with stable ohmyhost recovery fields.","additionalProperties":false,"required":["type","title","status","code","request_id","retryable","suggested_action"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","enum":["invalid_request","unauthenticated","forbidden","organization_required","resource_not_found","idempotency_key_reused","project_handle_unavailable","project_identity_unavailable","deployment_plan_expired","deployment_plan_incompatible","confirmation_expired","confirmation_invalid","etag_mismatch","promotion_source_stale","promotion_target_stale","promotion_invalid_target","mail_domain_conflict","mail_domain_required","mail_capacity_unavailable","storage_jurisdiction_conflict","shared_data_requires_promotion","production_deployment_required","framework_conversion_required","repository_configuration_missing","migration_filename_noncanonical","environment_secret_mutation_blocked","workers_runtime_incompatible","project_handle_invalid","project_handle_taken","project_handle_unchanged","project_rename_blocked","payload_too_large","rate_limited","insufficient_organization_credits","paid_plan_required","project_budget_exceeded","compute_performance_paid_required","compute_paid_required","compute_storage_shrink_requires_migration","compute_performance_unavailable","database_write_pending","database_access_limit","compute_change_pending","compute_change_conflict","billing_purchase_conflict","billing_recharge_conflict","github_connection_required","github_connection_revoked","repository_not_installed","cloudflare_zone_not_bound","cloudflare_authorization_closed","project_notes_conflict","project_export_not_ready","powered_by_flag_required","interactive_login_required","api_key_creation_uncertain","api_key_permissions_unavailable","reconciliation_exhausted","service_unavailable","source_commit_not_found","domain_hostname_taken","domain_dns_conflict","data_change_blocked","data_change_in_progress","data_change_not_applicable","rollback_target_data_changed","project_domain_delete_required"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"suggested_action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggested_action","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"retry_after_seconds":{"type":"integer","minimum":1,"maximum":86400,"description":"Optional machine-readable retry delay for a rate limit, matching Retry-After.","uniqueKey":"retry_after_seconds","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":499,"code":"invalid_request","request_id":"\u003cstring>","retryable":true,"suggested_action":"\u003cstring>","detail":"\u003cstring>","instance":"\u003cstring>","retry_after_seconds":43200}}},"exampleType":"generated"}},"exampleType":"generated"},"dbd9090c-6608-4d66-b5df-c80181d1666e":{"description":"The request failed.","headers":{"X-Request-Id":{"description":"Correlates the request with operations, events, logs, and audit records.","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details extended with stable ohmyhost recovery fields.","additionalProperties":false,"required":["type","title","status","code","request_id","retryable","suggested_action"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","enum":["invalid_request","unauthenticated","forbidden","organization_required","resource_not_found","idempotency_key_reused","project_handle_unavailable","project_identity_unavailable","deployment_plan_expired","deployment_plan_incompatible","confirmation_expired","confirmation_invalid","etag_mismatch","promotion_source_stale","promotion_target_stale","promotion_invalid_target","mail_domain_conflict","mail_domain_required","mail_capacity_unavailable","storage_jurisdiction_conflict","shared_data_requires_promotion","production_deployment_required","framework_conversion_required","repository_configuration_missing","migration_filename_noncanonical","environment_secret_mutation_blocked","workers_runtime_incompatible","project_handle_invalid","project_handle_taken","project_handle_unchanged","project_rename_blocked","payload_too_large","rate_limited","insufficient_organization_credits","paid_plan_required","project_budget_exceeded","compute_performance_paid_required","compute_paid_required","compute_storage_shrink_requires_migration","compute_performance_unavailable","database_write_pending","database_access_limit","compute_change_pending","compute_change_conflict","billing_purchase_conflict","billing_recharge_conflict","github_connection_required","github_connection_revoked","repository_not_installed","cloudflare_zone_not_bound","cloudflare_authorization_closed","project_notes_conflict","project_export_not_ready","powered_by_flag_required","interactive_login_required","api_key_creation_uncertain","api_key_permissions_unavailable","reconciliation_exhausted","service_unavailable","source_commit_not_found","domain_hostname_taken","domain_dns_conflict","data_change_blocked","data_change_in_progress","data_change_not_applicable","rollback_target_data_changed","project_domain_delete_required"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"suggested_action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggested_action","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"retry_after_seconds":{"type":"integer","minimum":1,"maximum":86400,"description":"Optional machine-readable retry delay for a rate limit, matching Retry-After.","uniqueKey":"retry_after_seconds","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":499,"code":"invalid_request","request_id":"\u003cstring>","retryable":true,"suggested_action":"\u003cstring>","detail":"\u003cstring>","instance":"\u003cstring>","retry_after_seconds":43200}}},"exampleType":"generated"}},"exampleType":"generated"},"89d57a63-f8b7-4a49-bf8a-7eb5e41d65ea":{"description":"The resource does not exist or is not visible to the authenticated principal.","headers":{"X-Request-Id":{"description":"Correlates the request with operations, events, logs, and audit records.","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details extended with stable ohmyhost recovery fields.","additionalProperties":false,"required":["type","title","status","code","request_id","retryable","suggested_action"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","enum":["invalid_request","unauthenticated","forbidden","organization_required","resource_not_found","idempotency_key_reused","project_handle_unavailable","project_identity_unavailable","deployment_plan_expired","deployment_plan_incompatible","confirmation_expired","confirmation_invalid","etag_mismatch","promotion_source_stale","promotion_target_stale","promotion_invalid_target","mail_domain_conflict","mail_domain_required","mail_capacity_unavailable","storage_jurisdiction_conflict","shared_data_requires_promotion","production_deployment_required","framework_conversion_required","repository_configuration_missing","migration_filename_noncanonical","environment_secret_mutation_blocked","workers_runtime_incompatible","project_handle_invalid","project_handle_taken","project_handle_unchanged","project_rename_blocked","payload_too_large","rate_limited","insufficient_organization_credits","paid_plan_required","project_budget_exceeded","compute_performance_paid_required","compute_paid_required","compute_storage_shrink_requires_migration","compute_performance_unavailable","database_write_pending","database_access_limit","compute_change_pending","compute_change_conflict","billing_purchase_conflict","billing_recharge_conflict","github_connection_required","github_connection_revoked","repository_not_installed","cloudflare_zone_not_bound","cloudflare_authorization_closed","project_notes_conflict","project_export_not_ready","powered_by_flag_required","interactive_login_required","api_key_creation_uncertain","api_key_permissions_unavailable","reconciliation_exhausted","service_unavailable","source_commit_not_found","domain_hostname_taken","domain_dns_conflict","data_change_blocked","data_change_in_progress","data_change_not_applicable","rollback_target_data_changed","project_domain_delete_required"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"suggested_action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggested_action","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"retry_after_seconds":{"type":"integer","minimum":1,"maximum":86400,"description":"Optional machine-readable retry delay for a rate limit, matching Retry-After.","uniqueKey":"retry_after_seconds","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"resourceNotFound":{"title":"resourceNotFound","value":{"type":"https://docs.ohmyho.st/errors/resource-not-found","title":"Resource not found","status":404,"code":"resource_not_found","request_id":"req_01J00000000000000000000000","retryable":false,"suggested_action":"Check the resource identifier and your access scope."}}},"exampleType":"examples"}},"exampleType":"examples"},"5a151828-688a-4f96-89f0-39128ec555e2":{"description":"The request failed.","headers":{"X-Request-Id":{"description":"Correlates the request with operations, events, logs, and audit records.","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details extended with stable ohmyhost recovery fields.","additionalProperties":false,"required":["type","title","status","code","request_id","retryable","suggested_action"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","enum":["invalid_request","unauthenticated","forbidden","organization_required","resource_not_found","idempotency_key_reused","project_handle_unavailable","project_identity_unavailable","deployment_plan_expired","deployment_plan_incompatible","confirmation_expired","confirmation_invalid","etag_mismatch","promotion_source_stale","promotion_target_stale","promotion_invalid_target","mail_domain_conflict","mail_domain_required","mail_capacity_unavailable","storage_jurisdiction_conflict","shared_data_requires_promotion","production_deployment_required","framework_conversion_required","repository_configuration_missing","migration_filename_noncanonical","environment_secret_mutation_blocked","workers_runtime_incompatible","project_handle_invalid","project_handle_taken","project_handle_unchanged","project_rename_blocked","payload_too_large","rate_limited","insufficient_organization_credits","paid_plan_required","project_budget_exceeded","compute_performance_paid_required","compute_paid_required","compute_storage_shrink_requires_migration","compute_performance_unavailable","database_write_pending","database_access_limit","compute_change_pending","compute_change_conflict","billing_purchase_conflict","billing_recharge_conflict","github_connection_required","github_connection_revoked","repository_not_installed","cloudflare_zone_not_bound","cloudflare_authorization_closed","project_notes_conflict","project_export_not_ready","powered_by_flag_required","interactive_login_required","api_key_creation_uncertain","api_key_permissions_unavailable","reconciliation_exhausted","service_unavailable","source_commit_not_found","domain_hostname_taken","domain_dns_conflict","data_change_blocked","data_change_in_progress","data_change_not_applicable","rollback_target_data_changed","project_domain_delete_required"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"suggested_action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggested_action","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"retry_after_seconds":{"type":"integer","minimum":1,"maximum":86400,"description":"Optional machine-readable retry delay for a rate limit, matching Retry-After.","uniqueKey":"retry_after_seconds","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":499,"code":"invalid_request","request_id":"\u003cstring>","retryable":true,"suggested_action":"\u003cstring>","detail":"\u003cstring>","instance":"\u003cstring>","retry_after_seconds":43200}}},"exampleType":"generated"}},"exampleType":"generated"},"6cca59c8-f5cd-42be-ba82-60ab002d85c4":{"description":"The request failed.","headers":{"X-Request-Id":{"description":"Correlates the request with operations, events, logs, and audit records.","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details extended with stable ohmyhost recovery fields.","additionalProperties":false,"required":["type","title","status","code","request_id","retryable","suggested_action"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","enum":["invalid_request","unauthenticated","forbidden","organization_required","resource_not_found","idempotency_key_reused","project_handle_unavailable","project_identity_unavailable","deployment_plan_expired","deployment_plan_incompatible","confirmation_expired","confirmation_invalid","etag_mismatch","promotion_source_stale","promotion_target_stale","promotion_invalid_target","mail_domain_conflict","mail_domain_required","mail_capacity_unavailable","storage_jurisdiction_conflict","shared_data_requires_promotion","production_deployment_required","framework_conversion_required","repository_configuration_missing","migration_filename_noncanonical","environment_secret_mutation_blocked","workers_runtime_incompatible","project_handle_invalid","project_handle_taken","project_handle_unchanged","project_rename_blocked","payload_too_large","rate_limited","insufficient_organization_credits","paid_plan_required","project_budget_exceeded","compute_performance_paid_required","compute_paid_required","compute_storage_shrink_requires_migration","compute_performance_unavailable","database_write_pending","database_access_limit","compute_change_pending","compute_change_conflict","billing_purchase_conflict","billing_recharge_conflict","github_connection_required","github_connection_revoked","repository_not_installed","cloudflare_zone_not_bound","cloudflare_authorization_closed","project_notes_conflict","project_export_not_ready","powered_by_flag_required","interactive_login_required","api_key_creation_uncertain","api_key_permissions_unavailable","reconciliation_exhausted","service_unavailable","source_commit_not_found","domain_hostname_taken","domain_dns_conflict","data_change_blocked","data_change_in_progress","data_change_not_applicable","rollback_target_data_changed","project_domain_delete_required"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"suggested_action":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggested_action","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"retry_after_seconds":{"type":"integer","minimum":1,"maximum":86400,"description":"Optional machine-readable retry delay for a rate limit, matching Retry-After.","uniqueKey":"retry_after_seconds","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":499,"code":"invalid_request","request_id":"\u003cstring>","retryable":true,"suggested_action":"\u003cstring>","detail":"\u003cstring>","instance":"\u003cstring>","retry_after_seconds":43200}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"45a9c511-6fc8-4cdb-ad84-0e7bb167deb6":{"BearerAuth":{"type":"http","scheme":"bearer","description":"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.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"715b4e6d-6866-488f-88e3-771d6b51144b":{"url":"https://app.ohmyho.st","description":"Production control API"},"7b41f9ac-740e-4c15-849b-83353288eb51":{"url":"https://dev.app.ohmyho.st","description":"Development control API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"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.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"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.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"ohmyhost","siteName":"ohmyho.st","title":"Read the Paid customer-owned hostname - ohmyho.st","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T15:52:21.698Z","originalFileLocation":"api-reference/read-the-paid-customer-owned-hostname.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"ohmyho.st\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read the Paid customer-owned hostname - ohmyho.st\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ohmyho.st\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ohmyhost.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Read+the+Paid+customer-owned+hostname\u0026amp;theme=60aedf46f280d0995405797e\u0026amp;signature=2e640656ef358f7009f3e1e85f4b000859bcea68ab11dab6d07499a1ac230533\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Read the Paid customer-owned hostname - ohmyho.st\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ohmyhost.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Read+the+Paid+customer-owned+hostname\u0026amp;theme=60aedf46f280d0995405797e\u0026amp;signature=2e640656ef358f7009f3e1e85f4b000859bcea68ab11dab6d07499a1ac230533\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ohmyhost/M042vB6Ys6BiOROh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ohmyho.st\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/read-the-paid-customer-owned-hostname.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ohmyho.st/#organization\",\"name\":\"ohmyho.st\",\"url\":\"https://docs.ohmyho.st\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ohmyhost/-GyHWgaHhneGtZo_/logo/light.svg?fit=max\u0026auto=format\u0026n=-GyHWgaHhneGtZo_\u0026q=85\u0026s=13af4972252c9a884618d20beaf5a174\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ohmyho.st#website\",\"name\":\"ohmyho.st\",\"url\":\"https://docs.ohmyho.st\",\"publisher\":{\"@id\":\"https://docs.ohmyho.st/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname#webpage\",\"url\":\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname\",\"name\":\"Read the Paid customer-owned hostname\",\"dateModified\":\"2026-10-28T15:52:21.698Z\",\"isPartOf\":{\"@id\":\"https://docs.ohmyho.st#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.ohmyho.st/api-reference/list-authorized-workspace-sending-domains\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.ohmyho.st/api-reference/list-authorized-workspace-sending-domains\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Read the Paid customer-owned hostname\",\"item\":\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname#apireference\",\"headline\":\"Read the Paid customer-owned hostname\",\"name\":\"Read the Paid customer-owned hostname\",\"url\":\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ohmyho.st/api-reference/read-the-paid-customer-owned-hostname#webpage\"},\"dateModified\":\"2026-10-28T15:52:21.698Z\",\"publisher\":{\"@id\":\"https://docs.ohmyho.st/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ohmyho.st#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ohmyho.st\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ohmyho.st","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api"}]},{"group":"Endpoints","pages":[{"group":"API Reference","pages":[{"title":"List authorized workspace sending domains","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/mail-domains","href":"/api-reference/list-authorized-workspace-sending-domains"},{"title":"Create a workspace sending domain","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organizations/{organization_id}/mail-domains","href":"/api-reference/create-a-workspace-sending-domain"},{"title":"Read one authorized workspace sending domain","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/mail-domains/{mail_domain_id}","href":"/api-reference/read-one-authorized-workspace-sending-domain"},{"title":"Retire an unused workspace mail domain","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organizations/{organization_id}/mail-domains/{mail_domain_id}","href":"/api-reference/retire-an-unused-workspace-mail-domain"},{"title":"Read sender-domain DNS authorization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/mail-domains/{mail_domain_id}/dns-authorization","href":"/api-reference/read-sender-domain-dns-authorization"},{"title":"Authorize exact sender-domain DNS management","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organizations/{organization_id}/mail-domains/{mail_domain_id}/dns-authorization","href":"/api-reference/authorize-exact-sender-domain-dns-management"},{"title":"Revoke workspace mail DNS management without changing sending","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organizations/{organization_id}/mail-domains/{mail_domain_id}/dns-authorization","href":"/api-reference/revoke-workspace-mail-dns-management-without-changing-sending"},{"title":"Read project sender settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding","href":"/api-reference/read-project-sender-settings"},{"title":"Attach or update a same-main-domain sender","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding","href":"/api-reference/attach-or-update-a-same-main-domain-sender"},{"title":"Detach only the selected project sender","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding","href":"/api-reference/detach-only-the-selected-project-sender"},{"title":"Read the intended application domain proof","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/application-domain-identity","href":"/api-reference/read-the-intended-application-domain-proof"},{"title":"Declare an intended application domain without switching traffic","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/application-domain-identity","href":"/api-reference/declare-an-intended-application-domain-without-switching-traffic"},{"title":"Revoke application domain proof and dependent shared sends","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/application-domain-identity","href":"/api-reference/revoke-application-domain-proof-and-dependent-shared-sends"},{"title":"Verify the current application DNS challenge","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/application-domain-identity/verify","href":"/api-reference/verify-the-current-application-dns-challenge"},{"title":"Read application proof DNS authorization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/application-domain-identity/dns-authorization","href":"/api-reference/read-application-proof-dns-authorization"},{"title":"Authorize only the frozen application TXT challenge","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/application-domain-identity/dns-authorization","href":"/api-reference/authorize-only-the-frozen-application-txt-challenge"},{"title":"Revoke application proof DNS management without switching traffic","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/application-domain-identity/dns-authorization","href":"/api-reference/revoke-application-proof-dns-management-without-switching-traffic"},{"title":"Read the current interactive user profile and signup attribution","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me/profile","href":"/api-reference/read-the-current-interactive-user-profile-and-signup-attribution"},{"title":"Record the authenticated user signup source once","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/me/signup-source","href":"/api-reference/record-the-authenticated-user-signup-source-once"},{"title":"Connect a GitHub installation to the workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organizations/{organization_id}/github:connect","href":"/api-reference/connect-a-github-installation-to-the-workspace"},{"title":"Read the workspace GitHub connection","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/github","href":"/api-reference/read-the-workspace-github-connection"},{"title":"Read the workspace's referral link","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/referral","href":"/api-reference/read-the-workspaces-referral-link"},{"title":"Read effective plan and monthly versus one-time credit balance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/account","href":"/api-reference/read-effective-plan-and-monthly-versus-one-time-credit-balance"},{"title":"Submit a contact or privacy question","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/contact-requests","href":"/api-reference/submit-a-contact-or-privacy-question"},{"title":"Read this anonymous browser's current roadmap votes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/site/feature-interests","href":"/api-reference/read-this-anonymous-browsers-current-roadmap-votes"},{"title":"Set or remove this anonymous browser's roadmap vote","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/site/feature-interests","href":"/api-reference/set-or-remove-this-anonymous-browsers-roadmap-vote"},{"title":"Read distinct active projects successfully deployed in the past seven days","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/site/stats","href":"/api-reference/read-distinct-active-projects-successfully-deployed-in-the-past-seven-days"},{"title":"List the current user's tokens in one organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/user-api-keys","href":"/api-reference/list-the-current-users-tokens-in-one-organization"},{"title":"Create a user-owned API token valid until revoked","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organizations/{organization_id}/user-api-keys","href":"/api-reference/create-a-user-owned-api-token-valid-until-revoked"},{"title":"Revoke one of the current user's API tokens","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/organizations/{organization_id}/user-api-keys/{key_id}","href":"/api-reference/revoke-one-of-the-current-users-api-tokens"},{"title":"Store a redacted customer-agent feedback report","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/feedback","href":"/api-reference/store-a-redacted-customer-agent-feedback-report"},{"title":"Read the status of one feedback receipt and ohmyho.st's replies","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/feedback/{feedback_id}","href":"/api-reference/read-the-status-of-one-feedback-receipt-and-ohmyhosts-replies"},{"title":"Complete the bound GitHub browser authorization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/github/oauth/callback","href":"/api-reference/complete-the-bound-github-browser-authorization"},{"title":"Complete one Cloudflare DNS authorization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cloudflare/oauth/callback","href":"/api-reference/complete-one-cloudflare-dns-authorization"},{"title":"Get the current authenticated identity","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me","href":"/api-reference/get-the-current-authenticated-identity"},{"title":"Revoke the current signed-in user session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/session:revoke","href":"/api-reference/revoke-the-current-signed-in-user-session"},{"title":"Create an organization for the signed-in user","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organizations","href":"/api-reference/create-an-organization-for-the-signed-in-user"},{"title":"Create or resume an owner's hosted Stripe Checkout","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organizations/{organization_id}/billing/checkouts","href":"/api-reference/create-or-resume-an-owners-hosted-stripe-checkout"},{"title":"Observe and reconcile an owner's original checkout","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/billing/checkouts/{checkout_id}","href":"/api-reference/observe-and-reconcile-an-owners-original-checkout"},{"title":"Open the owner's Stripe billing portal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/organizations/{organization_id}/billing/portal","href":"/api-reference/open-the-owners-stripe-billing-portal"},{"title":"Read auto-recharge and the current payment handoff","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/billing/recharge","href":"/api-reference/read-auto-recharge-and-the-current-payment-handoff"},{"title":"Enable or disable explicitly authorized auto-recharge","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organizations/{organization_id}/billing/recharge","href":"/api-reference/enable-or-disable-explicitly-authorized-auto-recharge"},{"title":"Read the owner's shared organization credit pool","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/credits","href":"/api-reference/read-the-owners-shared-organization-credit-pool"},{"title":"Read monthly measured usage by project and meter","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations/{organization_id}/credit-usage","href":"/api-reference/read-monthly-measured-usage-by-project-and-meter"},{"title":"Request an asynchronous password-encrypted SQL ZIP","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/exports","href":"/api-reference/request-an-asynchronous-password-encrypted-sql-zip"},{"title":"Read export progress and its verified 24-hour download capability","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/exports/{export_id}","href":"/api-reference/read-export-progress-and-its-verified-24-hour-download-capability"},{"title":"Read a project's optional monthly credit budget","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/credit-budget","href":"/api-reference/read-a-projects-optional-monthly-credit-budget"},{"title":"Set or clear the owner's project budget","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/credit-budget","href":"/api-reference/set-or-clear-the-owners-project-budget"},{"title":"List projects visible to the current authenticated identity","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects","href":"/api-reference/list-projects-visible-to-the-current-authenticated-identity"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects","href":"/api-reference/create-a-project"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}","href":"/api-reference/get-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}","href":"/api-reference/delete-a-project"},{"title":"Read current project context for an agent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/context","href":"/api-reference/read-current-project-context-for-an-agent"},{"title":"Replace bounded shared project notes without losing concurrent edits","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/context/notes","href":"/api-reference/replace-bounded-shared-project-notes-without-losing-concurrent-edits"},{"title":"Get the current project deployment status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/status","href":"/api-reference/get-the-current-project-deployment-status"},{"title":"Check whether a project handle is free","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/project-handles/{handle}","href":"/api-reference/check-whether-a-project-handle-is-free"},{"title":"Get or create the persistent Dev share link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/dev-share-link","href":"/api-reference/get-or-create-the-persistent-dev-share-link"},{"title":"Revoke the Dev share link and active sessions","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/dev-share-link","href":"/api-reference/revoke-the-dev-share-link-and-active-sessions"},{"title":"Rotate the persistent Dev share link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/dev-share-link:rotate","href":"/api-reference/rotate-the-persistent-dev-share-link"},{"title":"Select public or protected Dev access","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/dev-access-mode","href":"/api-reference/select-public-or-protected-dev-access"},{"title":"Read the \"Powered by ohmyho.st\" flag","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/powered-by-flag","href":"/api-reference/read-the-\"powered-by-ohmyhost\"-flag"},{"title":"Show or hide the \"Powered by ohmyho.st\" flag","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/powered-by-flag","href":"/api-reference/show-or-hide-the-\"powered-by-ohmyhost\"-flag"},{"title":"Create a single-use dev access ticket","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/dev-access-tickets","href":"/api-reference/create-a-single-use-dev-access-ticket"},{"title":"Plan project deletion","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}:delete-plan","href":"/api-reference/plan-project-deletion"},{"title":"Link a GitHub source repository","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/source:link","href":"/api-reference/link-a-github-source-repository"},{"title":"Get the linked source status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/source","href":"/api-reference/get-the-linked-source-status"},{"title":"Initialize a managed Cloudflare Git source","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/source:initialize","href":"/api-reference/initialize-a-managed-cloudflare-git-source"},{"title":"Read managed source files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/source/files","href":"/api-reference/read-managed-source-files"},{"title":"Read managed source version history","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/source/versions","href":"/api-reference/read-managed-source-version-history"},{"title":"Compare two managed source versions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/source/diff","href":"/api-reference/compare-two-managed-source-versions"},{"title":"Save an atomic managed source file batch","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/source/changes","href":"/api-reference/save-an-atomic-managed-source-file-batch"},{"title":"Restore an earlier file tree as a new version","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/source:restore","href":"/api-reference/restore-an-earlier-file-tree-as-a-new-version"},{"title":"Start a stable managed source snapshot upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/source/uploads","href":"/api-reference/start-a-stable-managed-source-snapshot-upload"},{"title":"Read a managed source upload receipt","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/source/uploads/{operation_id}","href":"/api-reference/read-a-managed-source-upload-receipt"},{"title":"Upload one source file with its content hash","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/source/uploads/{operation_id}/files","href":"/api-reference/upload-one-source-file-with-its-content-hash"},{"title":"Commit one complete uploaded source snapshot","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/source/uploads/{operation_id}:commit","href":"/api-reference/commit-one-complete-uploaded-source-snapshot"},{"title":"Switch an existing GitHub project to a prepared managed source","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/source:switch","href":"/api-reference/switch-an-existing-github-project-to-a-prepared-managed-source"},{"title":"Get automatic GitHub push deployment status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/source/auto-deploy","href":"/api-reference/get-automatic-github-push-deployment-status"},{"title":"Configure automatic GitHub push deployment","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/source/auto-deploy","href":"/api-reference/configure-automatic-github-push-deployment"},{"title":"Start project-scoped Cloudflare DNS authorization","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/cloudflare-dns/authorization","href":"/api-reference/start-project-scoped-cloudflare-dns-authorization"},{"title":"Get project-scoped Cloudflare DNS authorization status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/cloudflare-dns","href":"/api-reference/get-project-scoped-cloudflare-dns-authorization-status"},{"title":"Move a project to a chosen address","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/handle","href":"/api-reference/move-a-project-to-a-chosen-address"},{"title":"Apply the server-derived project domains","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/domains","href":"/api-reference/apply-the-server-derived-project-domains"},{"title":"Plan one Paid customer-owned hostname","description":"Plan the customer's requested hostname before or after the first Prod deployment. This read-only plan explains declaration, Cloudflare consent and activation; it does not claim the hostname, create provider resources or change DNS.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/paid-domain:plan","href":"/api-reference/plan-one-paid-customer-owned-hostname"},{"title":"Read the Paid customer-owned hostname","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/paid-domain","href":"/api-reference/read-the-paid-customer-owned-hostname"},{"title":"Apply one Paid customer-owned hostname","description":"Requires Paid access (a Stripe period or a grant) or, for a Free workspace, a project that currently shows the powered-by flag, and no expired credit-exhaustion grace. Returns paid_plan_required otherwise, or insufficient_organization_credits after seven days with no available credits, without provider mutation. Top-ups lift a credit-exhaustion block but never start or extend Paid access. Without an active Prod deployment, apply declares the hostname as awaiting_deployment, enabling Cloudflare consent without provider resources, DNS changes or domain charges. After a successful Prod deployment, replay the same hostname and idempotency key to activate it. A changed request under a used key returns idempotency_key_reused (409).","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/paid-domain","href":"/api-reference/apply-one-paid-customer-owned-hostname"},{"title":"Delete one exact Paid customer-owned hostname","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/paid-domain","href":"/api-reference/delete-one-exact-paid-customer-owned-hostname"},{"title":"Plan a deployment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/deployments:plan","href":"/api-reference/plan-a-deployment"},{"title":"List deployments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/deployments","href":"/api-reference/list-deployments"},{"title":"Create a deployment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/deployments","href":"/api-reference/create-a-deployment"},{"title":"Get deployment status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/deployments/{deployment_id}","href":"/api-reference/get-deployment-status"},{"title":"List normalized deployment diagnostics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/deployments/{deployment_id}/logs","href":"/api-reference/list-normalized-deployment-diagnostics"},{"title":"Stream normalized deployment diagnostics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/deployments/{deployment_id}/logs/events","href":"/api-reference/stream-normalized-deployment-diagnostics"},{"title":"Read actual managed database compute configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/database/compute","href":"/api-reference/read-actual-managed-database-compute-configuration"},{"title":"Select database memory and included storage","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/database/compute","href":"/api-reference/select-database-memory-and-included-storage"},{"title":"Execute one bounded database write in Dev or Prod","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/database/write","href":"/api-reference/execute-one-bounded-database-write-in-dev-or-prod"},{"title":"Run one bounded read-only Dev or Prod database query","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/database/query","href":"/api-reference/run-one-bounded-read-only-dev-or-prod-database-query"},{"title":"List the project's issued database credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/database/access","href":"/api-reference/list-the-projects-issued-database-credentials"},{"title":"Issue one time-bound PostgreSQL credential for Dev or Prod","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/database/access","href":"/api-reference/issue-one-time-bound-postgresql-credential-for-dev-or-prod"},{"title":"Revoke one issued database credential","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/database/access/{access_id}","href":"/api-reference/revoke-one-issued-database-credential"},{"title":"Plan a deployment rollback","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/deployments/{target_deployment_id}:rollback-plan","href":"/api-reference/plan-a-deployment-rollback"},{"title":"Roll back to an immutable deployment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/deployments/{target_deployment_id}:rollback","href":"/api-reference/roll-back-to-an-immutable-deployment"},{"title":"Plan promotion of the current dev deployment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/deployments/{source_deployment_id}:promote-plan","href":"/api-reference/plan-promotion-of-the-current-dev-deployment"},{"title":"Promote a verified dev artifact to prod","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/deployments/{source_deployment_id}:promote","href":"/api-reference/promote-a-verified-dev-artifact-to-prod"},{"title":"List environment secret metadata","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/environments/{environment_id}/secrets","href":"/api-reference/list-environment-secret-metadata"},{"title":"List the newest scheduled function runs of an environment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/environments/{environment_id}/function-runs","href":"/api-reference/list-the-newest-scheduled-function-runs-of-an-environment"},{"title":"Create or rotate an environment secret","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/environments/{environment_id}/secrets/{secret_name}","href":"/api-reference/create-or-rotate-an-environment-secret"},{"title":"Delete an environment secret","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/environments/{environment_id}/secrets/{secret_name}","href":"/api-reference/delete-an-environment-secret"},{"title":"Get an operation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/operations/{operation_id}","href":"/api-reference/get-an-operation"},{"title":"Reconcile an uncertain platform delivery or provider mutation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/operations/{operation_id}:reconcile","href":"/api-reference/reconcile-an-uncertain-platform-delivery-or-provider-mutation"},{"title":"Stream operation events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/operations/{operation_id}/events","href":"/api-reference/stream-operation-events"},{"title":"List audit events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/audit-events","href":"/api-reference/list-audit-events"},{"title":"Read independent sending and receiving readiness","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/environments/{environment_id}/mail-domain","href":"/api-reference/read-independent-sending-and-receiving-readiness"},{"title":"Configure sending and receiving on a selected mail domain","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/environments/{environment_id}/mail-domain","href":"/api-reference/configure-sending-and-receiving-on-a-selected-mail-domain"},{"title":"Retire the project's mail domain while the project stays active","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/environments/{environment_id}/mail-domain","href":"/api-reference/retire-the-projects-mail-domain-while-the-project-stays-active"},{"title":"Prepare a required customer webhook and return its signing secret","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/projects/{project_id}/environments/{environment_id}/mail-webhook","href":"/api-reference/prepare-a-required-customer-webhook-and-return-its-signing-secret"},{"title":"Disable receiving and remove the customer webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/projects/{project_id}/environments/{environment_id}/mail-webhook","href":"/api-reference/disable-receiving-and-remove-the-customer-webhook"},{"title":"Verify the customer endpoint and enable receiving","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/environments/{environment_id}/mail-webhook/verify","href":"/api-reference/verify-the-customer-endpoint-and-enable-receiving"},{"title":"List mail handoff metadata within the 72 hour window","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/environments/{environment_id}/mail/messages","href":"/api-reference/list-mail-handoff-metadata-within-the-72-hour-window"},{"title":"Retrieve owned mail content before expiry","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/environments/{environment_id}/mail/messages/{message_id}","href":"/api-reference/retrieve-owned-mail-content-before-expiry"},{"title":"Retry within the shared maximum of three retries","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/environments/{environment_id}/mail/messages/{message_id}/retry","href":"/api-reference/retry-within-the-shared-maximum-of-three-retries"},{"title":"Download an owned attachment before expiry","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/environments/{environment_id}/mail/messages/{message_id}/attachments/{attachment_id}","href":"/api-reference/download-an-owned-attachment-before-expiry"},{"title":"Plan a Dev and Prod data assignment change","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/data-changes:plan","href":"/api-reference/plan-a-dev-and-prod-data-assignment-change"},{"title":"Execute a confirmed Dev and Prod data assignment change","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/projects/{project_id}/data-changes","href":"/api-reference/execute-a-confirmed-dev-and-prod-data-assignment-change"}]}]}]}]},"title":"Read the Paid customer-owned hostname - ohmyho.st","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}