> ## Documentation Index > Fetch the complete documentation index at: https://docs.ohmyho.st/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For account actions, read https://ohmyho.st/skills/ohmyhost-get-started/SKILL.md and use the authenticated ohmyho.st CLI or local product MCP. Mintlify search only reads documentation. Preserve the customer’s selected project, environment and authentication provider. # Apply one Paid customer-owned hostname > 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). ## OpenAPI ````yaml /openapi.json put /v1/projects/{project_id}/paid-domain openapi: 3.1.2 info: title: ohmyho.st API version: 0.0.0 description: >- Public REST API for ohmyho.st hosting, projects, domains, email, credits and exports. servers: - url: https://app.ohmyho.st description: Production control API - url: https://dev.app.ohmyho.st description: Development control API security: - BearerAuth: [] paths: /v1/projects/{project_id}/paid-domain: put: summary: 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). operationId: applyPaidProjectDomain parameters: - $ref: '#/components/parameters/RequestId' - $ref: '#/components/parameters/ProjectId' - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PaidDomainRequest' responses: '200': description: >- Declared hostname or current Cloudflare for SaaS hostname and certificate state. content: application/json: schema: $ref: '#/components/schemas/PaidDomain' '400': $ref: '#/components/responses/Problem' '401': $ref: '#/components/responses/Problem' '402': $ref: '#/components/responses/Problem' '403': $ref: '#/components/responses/Problem' '404': $ref: '#/components/responses/ResourceNotFound' '409': $ref: '#/components/responses/Problem' '429': $ref: '#/components/responses/Problem' '503': $ref: '#/components/responses/Problem' components: parameters: RequestId: name: X-Request-Id in: header description: Optional caller-provided correlation identifier. required: false schema: type: string minLength: 1 maxLength: 128 ProjectId: name: project_id in: path description: Project identifier. required: true schema: $ref: '#/components/schemas/Ulid' IdempotencyKey: name: Idempotency-Key in: header description: Identifies one mutation and its canonical request payload. required: true schema: type: string minLength: 1 maxLength: 128 schemas: PaidDomainRequest: type: object additionalProperties: false required: - hostname properties: hostname: type: string minLength: 4 maxLength: 253 pattern: >- ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$ PaidDomain: 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 suspension_reason: type: - string - '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. hostname: oneOf: - type: string minLength: 4 maxLength: 253 - type: 'null' environment: type: string const: prod cname_target: type: string enum: - customers.omh.st - customers.ohmyho.st custom_hostname_status: type: - string - 'null' ssl_status: type: - 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 name: type: string minLength: 1 maxLength: 253 content: type: string minLength: 1 maxLength: 2048 purpose: type: string enum: - traffic - ownership - ssl - dcv_delegation url: oneOf: - type: string format: uri pattern: ^https:// - type: 'null' Ulid: type: string pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ ProblemDetails: 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 title: type: string minLength: 1 status: type: integer minimum: 400 maximum: 599 detail: type: string instance: type: string format: uri-reference 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_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 request_id: type: string minLength: 1 maxLength: 128 retryable: type: boolean retry_after_seconds: type: integer minimum: 1 maximum: 86400 description: >- Optional machine-readable retry delay for a rate limit, matching Retry-After. suggested_action: type: string minLength: 1 responses: Problem: description: The request failed. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' ResourceNotFound: description: >- The resource does not exist or is not visible to the authenticated principal. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' examples: 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. headers: XRequestId: description: Correlates the request with operations, events, logs, and audit records. required: true schema: type: string minLength: 1 maxLength: 128 securitySchemes: 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.