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

# Plan project deletion

> Produces a non-mutating project deletion plan and a ten-minute action-bound confirmation token.



## OpenAPI

````yaml /openapi.json post /v1/projects/{project_id}:delete-plan
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}:delete-plan:
    post:
      summary: Plan project deletion
      description: >-
        Produces a non-mutating project deletion plan and a ten-minute
        action-bound confirmation token.
      operationId: planProjectDeletion
      parameters:
        - $ref: '#/components/parameters/RequestId'
        - $ref: '#/components/parameters/ProjectId'
      responses:
        '200':
          description: A non-mutating project deletion plan.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardedActionPlan'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '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'
  headers:
    XRequestId:
      description: Correlates the request with operations, events, logs, and audit records.
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 128
  schemas:
    GuardedActionPlan:
      type: object
      description: >-
        Non-mutating guarded-action plan with a confirmation token that expires
        exactly ten minutes after creation.
      additionalProperties: false
      x-ohmyhost-ttl-seconds: 600
      required:
        - action
        - project_id
        - resource_etag
        - effects
        - risks
        - confirmation_token
        - created_at
        - expires_at
      properties:
        action:
          type: string
          enum:
            - rollback
            - promote
            - delete
        project_id:
          $ref: '#/components/schemas/Ulid'
        target_deployment_id:
          $ref: '#/components/schemas/Ulid'
        target_artifact_digest:
          $ref: '#/components/schemas/Sha256Digest'
        source_deployment_id:
          $ref: '#/components/schemas/Ulid'
        source_artifact_digest:
          $ref: '#/components/schemas/Sha256Digest'
        source_environment:
          type: string
          const: dev
        target_environment:
          type: string
          const: prod
        resource_etag:
          type: string
          minLength: 3
          maxLength: 128
        effects:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 512
        risks:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 512
        confirmation_token:
          $ref: '#/components/schemas/ConfirmationToken'
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
      oneOf:
        - properties:
            action:
              const: rollback
          required:
            - target_deployment_id
            - target_artifact_digest
        - properties:
            action:
              const: promote
          required:
            - source_deployment_id
            - source_artifact_digest
            - source_environment
            - target_environment
        - properties:
            action:
              const: delete
          not:
            anyOf:
              - required:
                  - target_deployment_id
              - required:
                  - target_artifact_digest
              - required:
                  - source_deployment_id
              - required:
                  - source_artifact_digest
              - required:
                  - source_environment
              - required:
                  - target_environment
    Ulid:
      type: string
      pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
    Sha256Digest:
      type: string
      pattern: ^sha256:[0-9a-f]{64}$
    ConfirmationToken:
      type: string
      description: >-
        Opaque, single-action token bound to the planned action, project, target
        resource, and resource ETag.
      minLength: 32
      maxLength: 4096
      pattern: ^[A-Za-z0-9._~-]+$
    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
            - 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
            - framework_conversion_required
            - migration_filename_noncanonical
            - environment_secret_mutation_blocked
            - container_runtime_required
            - payload_too_large
            - rate_limited
            - insufficient_organization_credits
            - paid_plan_required
            - project_budget_exceeded
            - compute_performance_paid_required
            - compute_performance_unavailable
            - compute_change_pending
            - compute_change_conflict
            - billing_purchase_conflict
            - 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
  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.

````