> ## 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.

# Read encrypted database export status

> Owner-only, including at zero credits. Poll queued/running jobs after next_poll_after_seconds. A verified SQL ZIP is retained seven days. This read never signs a download URL, so download_url and download_expires_at are always null here. Request a link with POST download-links. Neither the password nor any permanent storage credential can be retrieved. Generic operation reads never contain a download capability.



## OpenAPI

````yaml /openapi.json get /v1/projects/{project_id}/exports/{export_id}
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}/exports/{export_id}:
    get:
      summary: Read encrypted database export status
      description: >-
        Owner-only, including at zero credits. Poll queued/running jobs after
        next_poll_after_seconds. A verified SQL ZIP is retained seven days. This
        read never signs a download URL, so download_url and download_expires_at
        are always null here. Request a link with POST download-links. Neither
        the password nor any permanent storage credential can be retrieved.
        Generic operation reads never contain a download capability.
      operationId: getProjectExport
      parameters:
        - $ref: '#/components/parameters/ProjectId'
        - $ref: '#/components/parameters/RequestId'
        - name: export_id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Ulid'
      responses:
        '200':
          description: >-
            Current export status and archive metadata. Download fields are
            always null.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectExport'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '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
  schemas:
    Ulid:
      type: string
      pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
    ProjectExport:
      type: object
      additionalProperties: false
      required:
        - id
        - project_id
        - state
        - requested_at
        - next_request_at
        - next_poll_after_seconds
        - error
        - archive
      properties:
        id:
          $ref: '#/components/schemas/Ulid'
        project_id:
          $ref: '#/components/schemas/Ulid'
        state:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - failed
            - cancelled
        requested_at:
          type: string
          format: date-time
        next_request_at:
          type: string
          format: date-time
        next_poll_after_seconds:
          type:
            - integer
            - 'null'
          enum:
            - 5
            - null
        error:
          oneOf:
            - $ref: '#/components/schemas/OperationFailure'
            - type: 'null'
        archive:
          oneOf:
            - $ref: '#/components/schemas/ProjectExportArchive'
            - type: 'null'
    OperationFailure:
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - retryable
        - suggested_action
      properties:
        migration:
          $ref: '#/components/schemas/MigrationFailureDiagnostic'
        code:
          type: string
          enum:
            - operation_failed
            - operation_abandoned
            - native_auth_launch_unavailable
            - authorization_changed
            - source_commit_conflict
            - source_snapshot_invalid
            - source_upload_expired
            - recovery_dispatch_failed
            - recovery_job_failed
            - recovery_input_expired
            - recovery_database_unavailable
            - recovery_checksum_mismatch
            - recovery_scope_unavailable
            - recovery_archive_too_large
            - build_not_started
            - build_failed
            - database_write_rejected
            - database_write_unavailable
            - database_write_outcome_unknown
            - database_compute_failed
            - database_compute_plan_changed
            - database_compute_rejected
            - database_migration_failed
            - insufficient_organization_credits
            - project_budget_exceeded
            - paid_plan_required
            - runtime_candidate_failed
            - runtime_candidate_rejected
            - storage_jurisdiction_conflict
            - provider_state_absent
            - auto_deploy_plan_rejected
            - auto_deploy_repository_renamed
            - promotion_source_stale
            - promotion_target_stale
            - project_handle_taken
            - managed_source_dispatch_failed
        message:
          type: string
          minLength: 1
          maxLength: 512
        retryable:
          type: boolean
          const: false
          description: >-
            A terminal operation cannot be retried in place; follow
            suggested_action.
        suggested_action:
          type: string
          minLength: 1
          maxLength: 500
        detail:
          type: string
          minLength: 1
          maxLength: 2000
          description: >-
            Present only on auto_deploy_plan_rejected when planning the pushed
            commit returned a typed refusal. It is the same fixed catalog
            sentence that the planning 409 problem returns as detail, naming the
            file, the rule and the required change.
    ProjectExportArchive:
      type: object
      additionalProperties: false
      required:
        - bytes
        - sha256
        - sql_files
        - captured_at
        - expires_at
        - download_url
        - download_expires_at
      properties:
        bytes:
          type: integer
          minimum: 1
          maximum: 536870912
        sha256:
          type: string
          pattern: ^sha256:[a-f0-9]{64}$
        sql_files:
          type: array
          items:
            type: string
            enum:
              - dev.sql
              - prod.sql
              - shared.sql
              - auth.sql
          minItems: 1
          maxItems: 3
          uniqueItems: true
          enum:
            - - dev.sql
            - - prod.sql
            - - dev.sql
              - prod.sql
            - - shared.sql
            - - auth.sql
            - - dev.sql
              - auth.sql
            - - prod.sql
              - auth.sql
            - - dev.sql
              - prod.sql
              - auth.sql
            - - shared.sql
              - auth.sql
          description: >-
            dev.sql and/or prod.sql for isolated data, or shared.sql for shared
            data; auth.sql may accompany either or stand alone.
        captured_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        download_url:
          type:
            - string
            - 'null'
          format: uri
        download_expires_at:
          type:
            - string
            - 'null'
          format: date-time
    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
    MigrationFailureDiagnostic:
      type: object
      additionalProperties: false
      required:
        - reason
        - file
      description: >-
        Validated migration metadata only; contains no SQL, values or PostgreSQL
        message. Statement index is one-based and is present only for a failed
        customer statement.
      properties:
        reason:
          type: string
          enum:
            - catalog_changed
            - execution_failed
            - ledger_conflict
            - not_admitted
        file:
          oneOf:
            - type: string
              maxLength: 512
            - type: 'null'
        statement_index:
          type: integer
          minimum: 1
          maximum: 9007199254740991
        sqlstate:
          type: string
          pattern: ^[0-9A-Z]{5}$
  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.