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

# Rotate an installed platform key

> Replaces the value of an installed platform key (OHMYHOST_AI_KEY, OHMYHOST_BROWSER_KEY, OHMYHOST_MAIL_KEY, OHMYHOST_STORAGE_KEY or BETTER_AUTH_SECRET) with a value the platform generates. The request has no body and the value is never returned. The earlier value stops authorizing at once, and the new value reaches the running environment without a deployment. Other names answer 400; an installed key the environment does not hold answers 404. Repeating the same idempotency key replays the stored metadata.



## OpenAPI

````yaml /openapi.json post /v1/projects/{project_id}/environments/{environment_id}/secrets/{secret_name}/rotate
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}/environments/{environment_id}/secrets/{secret_name}/rotate:
    post:
      summary: Rotate an installed platform key
      description: >-
        Replaces the value of an installed platform key (OHMYHOST_AI_KEY,
        OHMYHOST_BROWSER_KEY, OHMYHOST_MAIL_KEY, OHMYHOST_STORAGE_KEY or
        BETTER_AUTH_SECRET) with a value the platform generates. The request has
        no body and the value is never returned. The earlier value stops
        authorizing at once, and the new value reaches the running environment
        without a deployment. Other names answer 400; an installed key the
        environment does not hold answers 404. Repeating the same idempotency
        key replays the stored metadata.
      operationId: rotateEnvironmentSecret
      parameters:
        - $ref: '#/components/parameters/RequestId'
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/ProjectId'
        - $ref: '#/components/parameters/EnvironmentId'
        - $ref: '#/components/parameters/SecretName'
      responses:
        '200':
          description: Rotated secret metadata. The value is never returned.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentSecret'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $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
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: Identifies one mutation and its canonical request payload.
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 128
    ProjectId:
      name: project_id
      in: path
      description: Project identifier.
      required: true
      schema:
        $ref: '#/components/schemas/Ulid'
    EnvironmentId:
      name: environment_id
      in: path
      description: Environment identifier.
      required: true
      schema:
        $ref: '#/components/schemas/Ulid'
    SecretName:
      name: secret_name
      in: path
      description: >-
        Uppercase environment-variable name. Set refuses a name starting with
        OHMYHOST_ and the platform names BETTER_AUTH_SECRET, BETTER_AUTH_URL,
        DATABASE_URL, HYPERDRIVE, ASSETS, FILES, IMAGES and STORAGE with a 400
        whose detail is "Secret name is reserved.". Delete refuses the installed
        platform keys OHMYHOST_AI_KEY, OHMYHOST_MAIL_KEY, OHMYHOST_STORAGE_KEY,
        OHMYHOST_BROWSER_KEY and BETTER_AUTH_SECRET with the same detail.
      required: true
      schema:
        type: string
        pattern: ^[A-Z][A-Z0-9_]{0,127}$
  headers:
    XRequestId:
      description: Correlates the request with operations, events, logs, and audit records.
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 128
  schemas:
    EnvironmentSecret:
      type: object
      description: >-
        Environment secret metadata. The plaintext and ciphertext are never
        returned.
      additionalProperties: false
      required:
        - name
        - revision
        - key_version
        - created_at
        - updated_at
        - desired_generation
        - applied_generation
        - delivery_state
        - runtime_provider
        - applied_secret_count
        - last_error
      properties:
        name:
          type: string
          pattern: ^[A-Z][A-Z0-9_]{0,127}$
        revision:
          type: integer
          minimum: 1
        key_version:
          type: integer
          minimum: 1
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        desired_generation:
          type: integer
          minimum: 0
        applied_generation:
          type: integer
          minimum: 0
        delivery_state:
          type: string
          enum:
            - not_deployed
            - pending
            - ready
            - failed
        runtime_provider:
          type:
            - string
            - 'null'
          enum:
            - wfp
            - null
        applied_secret_count:
          type: integer
          minimum: 0
          maximum: 100
        last_error:
          type:
            - string
            - 'null'
          pattern: ^[A-Z][A-Z0-9_]{0,63}$
    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_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
  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.
  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.