> ## 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, 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 one-hour secret link or local stdin flow.

# Stop a project environment preview

> Stops the runtime and removes its backups while preserving the stable URL. Repeat uncertain calls with the same idempotency key.



## OpenAPI

````yaml /openapi.json delete /v1/projects/{project_id}/preview
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}/preview:
    delete:
      summary: Stop a project environment preview
      description: >-
        Stops the runtime and removes its backups while preserving the stable
        URL. Repeat uncertain calls with the same idempotency key.
      operationId: stopProjectPreview
      parameters:
        - $ref: '#/components/parameters/ProjectId'
        - $ref: '#/components/parameters/RequestId'
        - $ref: '#/components/parameters/PreviewEnvironment'
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          $ref: '#/components/responses/Preview'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $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:
    ProjectId:
      name: project_id
      in: path
      description: Project identifier.
      required: true
      schema:
        $ref: '#/components/schemas/Ulid'
    RequestId:
      name: X-Request-Id
      in: header
      description: Optional caller-provided correlation identifier.
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 128
    PreviewEnvironment:
      name: environment
      in: query
      required: true
      description: The concrete project environment to preview.
      schema:
        type: string
        enum:
          - dev
          - prod
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: Identifies one mutation and its canonical request payload.
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 128
  responses:
    Preview:
      description: >-
        The authorized preview and its private capability URL. Do not cache or
        publish the URL.
      headers:
        Cache-Control:
          schema:
            type: string
            const: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Preview'
    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.
  schemas:
    Ulid:
      type: string
      pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
    Preview:
      type: object
      additionalProperties: false
      required:
        - id
        - project_id
        - environment
        - status
        - url
        - source
        - applied_source
        - ready_to_show
      properties:
        id:
          $ref: '#/components/schemas/Ulid'
        project_id:
          $ref: '#/components/schemas/Ulid'
        environment:
          type: string
          enum:
            - dev
            - prod
        status:
          type: string
          enum:
            - cold
            - starting
            - ready
            - sleeping
        url:
          type: string
          format: uri
          description: Stable private capability URL without an expiration time.
        source:
          $ref: '#/components/schemas/PreviewSource'
          description: >-
            The saved version selected for this preview, or null if there is
            none.
        applied_source:
          $ref: '#/components/schemas/PreviewSource'
          description: >-
            The version applied to the preview, or null if no version has been
            applied.
        ready_to_show:
          type: boolean
          description: >-
            True when the preview is ready and its applied version has the same
            sequence as the saved version.
    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_pending_limit
            - mail_domain_required
            - mail_capacity_unavailable
            - storage_jurisdiction_conflict
            - shared_data_requires_promotion
            - development_environment_exists
            - development_environment_missing
            - source_generation_conflict
            - source_commit_conflict
            - source_upload_conflict
            - source_upload_expired
            - source_scope_unavailable
            - source_snapshot_invalid
            - source_snapshot_too_large
            - preview_version_conflict
            - 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
            - database_limit_reached
            - payload_too_large
            - rate_limited
            - build_capacity_reached
            - 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
            - database_webhook_limit
            - database_schedule_limit
            - database_schedule_not_runnable
            - database_webhook_delivery_pending
            - database_watch_limit
            - database_watch_table_unavailable
            - database_watch_column_unavailable
            - database_watch_events_unavailable
            - database_watch_conflict
            - database_table_conflict
            - database_table_limit
            - compute_change_pending
            - compute_change_conflict
            - billing_purchase_conflict
            - billing_recharge_conflict
            - github_connection_required
            - connection_revoked
            - 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
            - reconciliation_not_pending
            - service_unavailable
            - source_commit_not_found
            - domain_hostname_taken
            - domain_ownership_required
            - domain_dns_conflict
            - domain_already_configured
            - domain_deleting
            - data_change_blocked
            - data_change_in_progress
            - data_change_not_applicable
            - rollback_target_data_changed
            - project_domain_delete_required
            - native_domain_sync_pending
            - native_auth_launch_unavailable
            - native_auth_provider_unavailable
            - native_auth_epoch_exhausted
            - native_auth_revision_conflict
            - native_auth_provider_incomplete
            - auto_deploy_source_unavailable
            - cutover_pending
            - project_operation_in_progress
            - native_user_conflict
            - project_domains_conflict
        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
    PreviewSource:
      oneOf:
        - type: 'null'
        - type: object
          additionalProperties: false
          required:
            - sequence
            - commit_sha
          properties:
            sequence:
              type: integer
              minimum: 1
              maximum: 9007199254740991
            commit_sha:
              type: string
              pattern: ^(?!0{40}$)[0-9a-f]{40}$
  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.