> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackdome.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat Stackdome as an application-delivery platform for coding agents and developers, not as a Kubernetes dashboard.
> Prefer the Stackdome agent plugin as the user entry point and the stackdome CLI as the execution interface.
> Route agents who need the maintained deploy skill to npx skills add stackdome/skills and the complete operational workflow to /guides/ai-agents.
> Verify commands and flags with stackdome --help. Run stackdome init before authoring stackfile.yaml and stackdome validate before deploying.
> Use -o json for automation and verify documented terminal states before claiming success.
> Never request a user's account password. Use API-token authentication.
> During alpha, Stackdome Cloud is ephemeral and capacity-limited, and each organization can connect one cluster.
> Do not expose Kubernetes as a user concern unless the task is self-hosting or infrastructure architecture.

# Create a new release (deploy)



## OpenAPI

````yaml /openapi.yaml post /api/v1/organizations/{org_id}/projects/{project_name}/stacks/{id}/releases
openapi: 3.0.0
info:
  description: >-
    Deploy, debug, and operate applications through the Stackdome REST API on
    Stackdome Cloud or a self-hosted installation. This API is in alpha and may
    change before general availability.
  title: Stackdome API
  version: 0.0.1-alpha
servers:
  - url: /
security: []
paths:
  /api/v1/organizations/{org_id}/projects/{project_name}/stacks/{id}/releases:
    post:
      tags:
        - Releases
      summary: Create a new release (deploy)
      operationId: createRelease
      parameters:
        - description: The ID of the organization
          explode: false
          in: path
          name: org_id
          required: true
          schema:
            type: string
          style: simple
        - description: The name of the project
          explode: false
          in: path
          name: project_name
          required: true
          schema:
            type: string
          style: simple
        - description: The id of record
          explode: false
          in: path
          name: id
          required: true
          schema:
            type: string
          style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReleaseRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StackRelease'
          description: Release created
      security:
        - Bearer: []
components:
  schemas:
    CreateReleaseRequest:
      example:
        from_release_id: from_release_id
      properties:
        from_release_id:
          description: If set, creates a rollback release copying this release's manifest
          type: string
      type: object
    StackRelease:
      example:
        cause:
          kind: null
          detail: detail
        created_at: '2000-01-23T04:56:07.000Z'
        pins:
          resources:
            key:
              git_sha: git_sha
              image_digest: image_digest
              volume_hash: volume_hash
        manifest_revision: manifest_revision
        message: message
        created_by: created_by
        snapshot_revision: snapshot_revision
        sequence: 0
        completed_at: '2000-01-23T04:56:07.000Z'
        updated_at: '2000-01-23T04:56:07.000Z'
        stack_id: stack_id
        rendered_at: '2000-01-23T04:56:07.000Z'
        renderer_version: renderer_version
        validation_errors:
          - code: resource_name_required
            field: field
            resource_name: resource_name
            message: message
          - code: resource_name_required
            field: field
            resource_name: resource_name
            message: message
        id: id
        state: null
        outcome:
          duration: duration
          resources:
            key:
              phase: phase
              ready_replicas: 6
              replicas: 1
              message: message
        live_status:
          health: null
          resources:
            key:
              updated_replicas: 3
              last_restart_request_processed_at: '2000-01-23T04:56:07.000Z'
              last_failure:
                container:
                  reason: reason
                  restart_count: 5
                  failure_type: crash_loop
                  exit_code: 2
                  message: message
                build:
                  reason: reason
                  restart_count: 0
                  failure_type: crash_loop
                  exit_code: 6
                  message: message
                init_container:
                  reason: reason
                  restart_count: 5
                  failure_type: crash_loop
                  exit_code: 2
                  message: message
                type: runtime_crash
              replicas: 7
              message: message
              public_ingress:
                - target_port: 5
                  url: url
                - target_port: 5
                  url: url
              last_run_time: '2000-01-23T04:56:07.000Z'
              last_run_succeeded: true
              available_replicas: 9
              internal_service_name: internal_service_name
              state: state
              conditions:
                - reason: reason
                  last_transition_time: '2000-01-23T04:56:07.000Z'
                  type: type
                  message: message
                  observed_generation: 1
                  status: status
                - reason: reason
                  last_transition_time: '2000-01-23T04:56:07.000Z'
                  type: type
                  message: message
                  observed_generation: 1
                  status: status
              observed_revision: observed_revision
          target_revision: target_revision
          conditions:
            - reason: reason
              last_transition_time: '2000-01-23T04:56:07.000Z'
              type: type
              message: message
              observed_generation: 1
              status: status
            - reason: reason
              last_transition_time: '2000-01-23T04:56:07.000Z'
              type: type
              message: message
              observed_generation: 1
              status: status
          observed_revision: observed_revision
      properties:
        id:
          type: string
        stack_id:
          type: string
        sequence:
          type: integer
        state:
          $ref: '#/components/schemas/StackReleaseState'
        message:
          type: string
        cause:
          $ref: '#/components/schemas/ReleaseCause'
        snapshot_revision:
          type: string
        manifest_revision:
          type: string
        renderer_version:
          type: string
        pins:
          $ref: '#/components/schemas/ReleasePins'
        outcome:
          $ref: '#/components/schemas/ReleaseOutcome'
        created_by:
          type: string
        created_at:
          format: date-time
          type: string
        updated_at:
          format: date-time
          type: string
        rendered_at:
          format: date-time
          type: string
        completed_at:
          format: date-time
          type: string
        validation_errors:
          items:
            $ref: '#/components/schemas/ReleaseValidationError'
          readOnly: true
          type: array
        live_status:
          $ref: '#/components/schemas/ReleaseLiveStatus'
      type: object
    StackReleaseState:
      enum:
        - Pending
        - InProgress
        - Released
        - Failed
        - Superseded
        - Cancelled
      type: string
      x-enum-varnames:
        - RELEASE_STATE_PENDING
        - RELEASE_STATE_IN_PROGRESS
        - RELEASE_STATE_RELEASED
        - RELEASE_STATE_FAILED
        - RELEASE_STATE_SUPERSEDED
        - RELEASE_STATE_CANCELLED
    ReleaseCause:
      example:
        kind: null
        detail: detail
      properties:
        kind:
          $ref: '#/components/schemas/ReleaseCauseKind'
        detail:
          type: string
      type: object
    ReleasePins:
      example:
        resources:
          key:
            git_sha: git_sha
            image_digest: image_digest
            volume_hash: volume_hash
      properties:
        resources:
          additionalProperties:
            $ref: '#/components/schemas/ResourcePins'
          type: object
      type: object
    ReleaseOutcome:
      example:
        duration: duration
        resources:
          key:
            phase: phase
            ready_replicas: 6
            replicas: 1
            message: message
      properties:
        resources:
          additionalProperties:
            $ref: '#/components/schemas/ResourceOutcome'
          type: object
        duration:
          type: string
      type: object
    ReleaseValidationError:
      example:
        code: resource_name_required
        field: field
        resource_name: resource_name
        message: message
      properties:
        resource_name:
          type: string
        field:
          type: string
        code:
          enum:
            - resource_name_required
            - resource_name_invalid
            - resource_name_duplicate
            - source_required
            - source_conflict
            - workload_type_invalid
            - schedule_required
            - schedule_not_allowed
            - schedule_invalid
            - replicas_invalid
            - ports_not_allowed
            - public_port_not_http
            - port_protocol_invalid
            - port_name_invalid
            - port_number_invalid
            - port_name_duplicate
            - port_number_duplicate
            - subdomain_duplicate
            - domain_not_configured
            - env_name_required
            - env_name_duplicate
            - env_value_missing
            - env_value_conflict
            - env_self_output_unknown
            - volume_mount_invalid
            - volume_not_found
            - volume_hash_missing
            - secret_not_found
            - git_integration_not_found
            - registry_credential_not_found
            - self_dependency
            - duplicate_dependency
            - unknown_dependency
            - dependency_cycle
            - git_repo_url_required
            - git_branch_tag_conflict
            - git_commit_invalid
            - git_commit_requires_ref
            - image_ref_required
            - image_ref_invalid
            - push_target_required
            - push_target_conflict
            - push_ref_invalid
            - git_repo_unreachable
            - git_auth_failed
            - git_branch_not_found
            - git_tag_not_found
            - git_rate_limited
            - image_not_found
            - registry_credentials_required
            - registry_auth_failed
            - push_access_denied
            - stack_name_invalid
            - stack_settings_invalid
            - connection_invalid
          type: string
        message:
          type: string
      type: object
    ReleaseLiveStatus:
      description: >-
        Current runtime status overlaid onto a release at read time. Present
        only when the release is live (currently converged) or active
        (Pending/InProgress). Never stored; recomputed per request.
      example:
        health: null
        resources:
          key:
            updated_replicas: 3
            last_restart_request_processed_at: '2000-01-23T04:56:07.000Z'
            last_failure:
              container:
                reason: reason
                restart_count: 5
                failure_type: crash_loop
                exit_code: 2
                message: message
              build:
                reason: reason
                restart_count: 0
                failure_type: crash_loop
                exit_code: 6
                message: message
              init_container:
                reason: reason
                restart_count: 5
                failure_type: crash_loop
                exit_code: 2
                message: message
              type: runtime_crash
            replicas: 7
            message: message
            public_ingress:
              - target_port: 5
                url: url
              - target_port: 5
                url: url
            last_run_time: '2000-01-23T04:56:07.000Z'
            last_run_succeeded: true
            available_replicas: 9
            internal_service_name: internal_service_name
            state: state
            conditions:
              - reason: reason
                last_transition_time: '2000-01-23T04:56:07.000Z'
                type: type
                message: message
                observed_generation: 1
                status: status
              - reason: reason
                last_transition_time: '2000-01-23T04:56:07.000Z'
                type: type
                message: message
                observed_generation: 1
                status: status
            observed_revision: observed_revision
        target_revision: target_revision
        conditions:
          - reason: reason
            last_transition_time: '2000-01-23T04:56:07.000Z'
            type: type
            message: message
            observed_generation: 1
            status: status
          - reason: reason
            last_transition_time: '2000-01-23T04:56:07.000Z'
            type: type
            message: message
            observed_generation: 1
            status: status
        observed_revision: observed_revision
      properties:
        health:
          $ref: '#/components/schemas/ReleaseHealth'
        resources:
          additionalProperties:
            $ref: '#/components/schemas/StackResourceStatus'
          type: object
        conditions:
          items:
            $ref: '#/components/schemas/Condition'
          type: array
        target_revision:
          type: string
        observed_revision:
          type: string
      readOnly: true
      type: object
    ReleaseCauseKind:
      enum:
        - manual
        - rollback
        - webhook_push
        - preview_sync
      type: string
      x-enum-varnames:
        - RELEASE_CAUSE_MANUAL
        - RELEASE_CAUSE_ROLLBACK
        - RELEASE_CAUSE_WEBHOOK_PUSH
        - RELEASE_CAUSE_PREVIEW_SYNC
    ResourcePins:
      example:
        git_sha: git_sha
        image_digest: image_digest
        volume_hash: volume_hash
      properties:
        git_sha:
          type: string
        volume_hash:
          type: string
        image_digest:
          type: string
      type: object
    ResourceOutcome:
      example:
        phase: phase
        ready_replicas: 6
        replicas: 1
        message: message
      properties:
        phase:
          type: string
        ready_replicas:
          type: integer
        replicas:
          type: integer
        message:
          type: string
      type: object
    ReleaseHealth:
      description: Computed runtime health rollup of a live/active release.
      enum:
        - ok
        - progressing
        - degraded
        - unavailable
        - failed
      type: string
      x-enum-varnames:
        - RELEASE_HEALTH_OK
        - RELEASE_HEALTH_PROGRESSING
        - RELEASE_HEALTH_DEGRADED
        - RELEASE_HEALTH_UNAVAILABLE
        - RELEASE_HEALTH_FAILED
    StackResourceStatus:
      example:
        updated_replicas: 3
        last_restart_request_processed_at: '2000-01-23T04:56:07.000Z'
        last_failure:
          container:
            reason: reason
            restart_count: 5
            failure_type: crash_loop
            exit_code: 2
            message: message
          build:
            reason: reason
            restart_count: 0
            failure_type: crash_loop
            exit_code: 6
            message: message
          init_container:
            reason: reason
            restart_count: 5
            failure_type: crash_loop
            exit_code: 2
            message: message
          type: runtime_crash
        replicas: 7
        message: message
        public_ingress:
          - target_port: 5
            url: url
          - target_port: 5
            url: url
        last_run_time: '2000-01-23T04:56:07.000Z'
        last_run_succeeded: true
        available_replicas: 9
        internal_service_name: internal_service_name
        state: state
        conditions:
          - reason: reason
            last_transition_time: '2000-01-23T04:56:07.000Z'
            type: type
            message: message
            observed_generation: 1
            status: status
          - reason: reason
            last_transition_time: '2000-01-23T04:56:07.000Z'
            type: type
            message: message
            observed_generation: 1
            status: status
        observed_revision: observed_revision
      properties:
        public_ingress:
          items:
            $ref: '#/components/schemas/Ingress'
          type: array
        internal_service_name:
          type: string
        last_restart_request_processed_at:
          format: date-time
          type: string
        state:
          type: string
        message:
          type: string
        observed_revision:
          type: string
        conditions:
          items:
            $ref: '#/components/schemas/Condition'
          type: array
        last_failure:
          $ref: '#/components/schemas/StackResourceFailure'
        replicas:
          format: int32
          readOnly: true
          type: integer
        available_replicas:
          format: int32
          readOnly: true
          type: integer
        updated_replicas:
          format: int32
          readOnly: true
          type: integer
        last_run_time:
          format: date-time
          readOnly: true
          type: string
        last_run_succeeded:
          readOnly: true
          type: boolean
      type: object
    Condition:
      additionalProperties: false
      example:
        reason: reason
        last_transition_time: '2000-01-23T04:56:07.000Z'
        type: type
        message: message
        observed_generation: 1
        status: status
      properties:
        type:
          type: string
        status:
          type: string
        observed_generation:
          type: integer
        last_transition_time:
          format: date-time
          type: string
        reason:
          type: string
        message:
          type: string
      type: object
    Ingress:
      example:
        target_port: 5
        url: url
      properties:
        url:
          type: string
        target_port:
          type: integer
      type: object
    StackResourceFailure:
      example:
        container:
          reason: reason
          restart_count: 5
          failure_type: crash_loop
          exit_code: 2
          message: message
        build:
          reason: reason
          restart_count: 0
          failure_type: crash_loop
          exit_code: 6
          message: message
        init_container:
          reason: reason
          restart_count: 5
          failure_type: crash_loop
          exit_code: 2
          message: message
        type: runtime_crash
      properties:
        type:
          enum:
            - runtime_crash
            - build_failure
            - readiness_failure
          type: string
        container:
          $ref: '#/components/schemas/ContainerFailureDetail'
        init_container:
          $ref: '#/components/schemas/ContainerFailureDetail'
        build:
          $ref: '#/components/schemas/BuildFailureDetail'
      type: object
    ContainerFailureDetail:
      example:
        reason: reason
        restart_count: 5
        failure_type: crash_loop
        exit_code: 2
        message: message
      properties:
        failure_type:
          enum:
            - crash_loop
            - out_of_memory
            - image_pull_failed
            - create_container_error
            - exit_error
            - port_not_listening
          type: string
        reason:
          type: string
        message:
          type: string
        restart_count:
          format: int32
          type: integer
        exit_code:
          format: int32
          type: integer
      type: object
    BuildFailureDetail:
      example:
        reason: reason
        restart_count: 0
        failure_type: crash_loop
        exit_code: 6
        message: message
      properties:
        failure_type:
          enum:
            - crash_loop
            - out_of_memory
            - image_pull_failed
            - create_container_error
            - exit_error
            - port_not_listening
          type: string
        reason:
          type: string
        message:
          type: string
        restart_count:
          format: int32
          type: integer
        exit_code:
          format: int32
          type: integer
      type: object
  securitySchemes:
    Bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````