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

# Move a project to a chosen address

> Starts a durable operation that re-publishes the project's Dev and Prod gateways at the chosen address and stores it only once both serve it. The previous address stops answering and returns to the pool for any project to claim. Ask GET /v1/project-handles/{handle} first; a taken, unusable or unchanged address is refused before any gateway moves, and a project with an operation in flight is refused until it finishes.



## OpenAPI

````yaml /openapi.json put /v1/projects/{project_id}/handle
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}/handle:
    put:
      summary: Move a project to a chosen address
      description: >-
        Starts a durable operation that re-publishes the project's Dev and Prod
        gateways at the chosen address and stores it only once both serve it.
        The previous address stops answering and returns to the pool for any
        project to claim. Ask GET /v1/project-handles/{handle} first; a taken,
        unusable or unchanged address is refused before any gateway moves, and a
        project with an operation in flight is refused until it finishes.
      operationId: changeProjectHandle
      parameters:
        - $ref: '#/components/parameters/RequestId'
        - $ref: '#/components/parameters/ProjectId'
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/IfMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - handle
              properties:
                handle:
                  type: string
                  minLength: 3
                  maxLength: 59
                  pattern: ^[a-z0-9]+(?:-[a-z0-9]+){0,4}$
                  description: One to five lowercase words of letters and digits.
      responses:
        '202':
          $ref: '#/components/responses/AcceptedOperation'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '409':
          $ref: '#/components/responses/IdempotencyConflict'
        '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
    IfMatch:
      name: If-Match
      in: header
      description: Exact ETag returned for the current project or deployment state.
      required: true
      schema:
        type: string
        minLength: 3
        maxLength: 128
  responses:
    AcceptedOperation:
      description: The mutation was accepted for asynchronous processing.
      headers:
        Location:
          description: Relative URL of the durable operation resource.
          required: true
          schema:
            type: string
            pattern: ^/v1/operations/[0-9A-HJKMNP-TV-Z]{26}$
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Operation'
    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.
    IdempotencyConflict:
      description: The idempotency key was already used with a different canonical request.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/IdempotencyConflictProblem'
          examples:
            reusedKey:
              value:
                type: https://docs.ohmyho.st/errors/idempotency-key-reused
                title: Idempotency key reused
                status: 409
                code: idempotency_key_reused
                request_id: req_01J00000000000000000000000
                retryable: false
                suggested_action: Retry with a new idempotency key.
  schemas:
    Ulid:
      type: string
      pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
    Operation:
      type: object
      description: >-
        Durable record returned for an accepted asynchronous mutation. Optional
        reconciliation is a current observation for queued/running work,
        separate from immutable terminal state. A completed reconciliation
        attempt alone does not mean the operation succeeded.
      additionalProperties: false
      required:
        - id
        - state
        - created_at
        - updated_at
      properties:
        blocking_operation_id:
          $ref: '#/components/schemas/Ulid'
          description: >-
            The active operation holding this queued operation's project
            mutation claim.
        id:
          $ref: '#/components/schemas/Ulid'
        state:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - failed
            - cancelled
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        result:
          type: object
          additionalProperties: true
        error:
          $ref: '#/components/schemas/OperationFailure'
        progress:
          $ref: '#/components/schemas/OperationDeploymentProgress'
        reconciliation:
          $ref: '#/components/schemas/OperationReconciliation'
    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
            - storage_jurisdiction_conflict
            - 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
            - interactive_login_required
            - api_key_creation_uncertain
            - api_key_permissions_unavailable
            - reconciliation_exhausted
            - service_unavailable
        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
    IdempotencyConflictProblem:
      allOf:
        - $ref: '#/components/schemas/ProblemDetails'
        - type: object
          properties:
            code:
              const: idempotency_key_reused
    OperationFailure:
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - retryable
        - suggested_action
      properties:
        code:
          type: string
          enum:
            - operation_failed
            - operation_abandoned
            - 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
            - paid_plan_required
            - runtime_candidate_failed
            - runtime_candidate_rejected
            - storage_jurisdiction_conflict
            - provider_state_absent
        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
    OperationDeploymentProgress:
      type: object
      additionalProperties: false
      description: >-
        Current deployment dependency observation, separate from immutable
        operation history. Poll the same operation; mail readiness does not mean
        application activation.
      required:
        - phase
        - project_id
        - deployment_id
        - observed_at
        - next_poll_after_seconds
        - suggested_action
      properties:
        build_completed_at:
          type: string
          format: date-time
          description: >-
            Actual successful build completion time when this operation ran a
            build; omitted for reused artifacts without a current build.
        phase:
          type: string
          enum:
            - queued
            - building
            - publishing
            - waiting_for_mail
            - mail_status_unavailable
        project_id:
          $ref: '#/components/schemas/Ulid'
        deployment_id:
          $ref: '#/components/schemas/Ulid'
        observed_at:
          type: string
          format: date-time
        next_poll_after_seconds:
          type: integer
          const: 60
        suggested_action:
          type: string
          minLength: 1
          maxLength: 500
    OperationReconciliation:
      type: object
      additionalProperties: false
      required:
        - state
        - attempt_id
        - observed_at
        - suggested_action
      properties:
        state:
          type: string
          enum:
            - required
            - pending
        attempt_id:
          oneOf:
            - $ref: '#/components/schemas/Ulid'
            - type: 'null'
          description: >-
            Active attempt for pending reconciliation; null when a new confirmed
            reconciliation is required.
        observed_at:
          type: string
          format: date-time
        suggested_action:
          type: string
          minLength: 1
          maxLength: 500
  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.

````