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

# List deployment history

> List deployment history through the Towbar REST API.

Required permissions: deployment.read. Personal keys are capped by their owner’s current team role.

See [request conventions](/docs/api/overview) and [automation workflows](/docs/api/workflows). MCP clients use the task-oriented [tool catalogue](/docs/api/mcp-tools).


## OpenAPI

````yaml api-reference/openapi.json GET /deployments/history
openapi: 3.1.0
info:
  title: Towbar API
  version: 2.0.0
  description: >-
    Manage your Towbar control plane with a bearer API key. Keys inherit current
    workspace permissions.
servers:
  - url: https://api.example.com/v1/api
security: []
paths:
  /deployments/history:
    get:
      tags:
        - Deployments / Overview
      summary: List deployment history
      description: >-
        Required permissions: deployment.read. Personal keys are capped by the
        current member role; team keys use explicit grants.
      operationId: get_deployments_history
      parameters:
        - name: page
          in: query
          required: false
          schema:
            default: 1
            type: integer
            minimum: 1
            maximum: 1000000
        - name: limit
          in: query
          required: false
          schema:
            default: 10
            type: integer
            minimum: 1
            maximum: 100
        - name: environment
          in: query
          required: false
          schema:
            type: string
            enum:
              - production
              - preview
        - name: targetEnvironment
          in: query
          required: false
          schema:
            type: string
            pattern: ^[a-z][a-z0-9-]{0,62}$
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - app
              - resource
        - name: state
          in: query
          required: false
          schema:
            type: string
            enum:
              - queued
              - waiting_for_server
              - preparing
              - validating_credentials
              - checking_server
              - fetching_source
              - resolving_secrets
              - transferring
              - building
              - running_pre_deploy
              - starting_candidate
              - checking_health
              - configuring_routing
              - provisioning_tls
              - checking_public_endpoint
              - switching_traffic
              - running_post_deploy
              - cleaning_up
              - succeeded
              - succeeded_with_warnings
              - skipped
              - failed
              - cancelled
        - name: trigger
          in: query
          required: false
          schema:
            type: string
            enum:
              - auto_deploy
              - manual
              - rollback
        - name: serverId
          in: query
          required: false
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        - name: sort
          in: query
          required: false
          schema:
            default: newest
            type: string
            enum:
              - newest
              - oldest
              - name_asc
              - name_desc
      responses:
        '200':
          description: Deployment history and pagination metadata.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Response_254'
                  - type: object
                    properties:
                      localization:
                        $schema: https://json-schema.org/draft/2020-12/schema
                        type: object
                        properties:
                          dateFormat:
                            type: string
                            enum:
                              - day-short-month-year
                              - short-month-day-year
                              - year-month-day
                              - day-month-year
                              - month-day-year
                          timeFormat:
                            type: string
                            enum:
                              - 24-hour
                              - 12-hour
                              - 24-hour-seconds
                              - 12-hour-seconds
                          timeZone:
                            type: string
                          timestamps:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: object
                              properties:
                                date:
                                  type: string
                                time:
                                  type:
                                    - string
                                    - 'null'
                                dateTime:
                                  type:
                                    - string
                                    - 'null'
                                timeZone:
                                  type: string
                                zoneLabel:
                                  type: string
                                epochMilliseconds:
                                  type: number
                                inputDateTime:
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - date
                                - time
                                - dateTime
                                - timeZone
                                - zoneLabel
                                - epochMilliseconds
                                - inputDateTime
                              additionalProperties: false
                        required:
                          - dateFormat
                          - timeFormat
                          - timeZone
                          - timestamps
                        additionalProperties: false
                    required:
                      - localization
        '400':
          $ref: '#/components/responses/ApiError'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '404':
          $ref: '#/components/responses/ApiError'
        '409':
          $ref: '#/components/responses/ApiError'
        '413':
          $ref: '#/components/responses/ApiError'
        '422':
          $ref: '#/components/responses/ApiError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ApiError'
      security:
        - bearerAuth: []
components:
  schemas:
    Response_254:
      type: object
      properties:
        environments:
          type: array
          items:
            type: string
        deployments:
          type: array
          items:
            $ref: '#/components/schemas/Response_255'
        pagination:
          $ref: '#/components/schemas/Response_256'
      required:
        - environments
        - deployments
        - pagination
    Response_255:
      type: object
      properties:
        deployableName:
          type: string
        appId:
          type: string
        targetEnvironment:
          $ref: '#/components/schemas/Response_99'
        commitSha:
          type: string
        deployableKind:
          anyOf:
            - type: string
              const: app
            - type: string
              const: compose
            - type: string
              const: image
            - type: string
              const: postgres
            - type: string
              const: mysql
            - type: string
              const: mariadb
            - type: string
              const: mongodb
            - type: string
              const: redis
            - type: string
              const: dragonfly
            - type: string
              const: keydb
            - type: string
              const: clickhouse
        environment:
          anyOf:
            - type: string
              const: production
            - type: string
              const: preview
        createdAt:
          type: string
          format: date-time
        errorCode:
          anyOf:
            - type: 'null'
            - type: string
        errorMessage:
          anyOf:
            - type: 'null'
            - type: string
        finishedAt:
          anyOf:
            - type: 'null'
            - type: string
              format: date-time
        id:
          type: string
        gitRef:
          anyOf:
            - type: 'null'
            - type: string
        githubDeploymentId:
          anyOf:
            - type: 'null'
            - type: string
        hostname:
          anyOf:
            - type: 'null'
            - type: string
        imageDigest:
          anyOf:
            - type: 'null'
            - type: string
        imagePlatform:
          anyOf:
            - type: 'null'
            - type: string
        kind:
          anyOf:
            - type: string
              const: deploy
            - type: string
              const: rollback
        manifestDigest:
          type: string
        sourceInputDigest:
          anyOf:
            - type: 'null'
            - type: string
        serverId:
          type: string
        sourceId:
          type: string
        startedAt:
          anyOf:
            - type: 'null'
            - type: string
              format: date-time
        state:
          anyOf:
            - type: string
              const: queued
            - type: string
              const: waiting_for_server
            - type: string
              const: preparing
            - type: string
              const: validating_credentials
            - type: string
              const: checking_server
            - type: string
              const: fetching_source
            - type: string
              const: resolving_secrets
            - type: string
              const: transferring
            - type: string
              const: building
            - type: string
              const: running_pre_deploy
            - type: string
              const: starting_candidate
            - type: string
              const: checking_health
            - type: string
              const: configuring_routing
            - type: string
              const: provisioning_tls
            - type: string
              const: checking_public_endpoint
            - type: string
              const: switching_traffic
            - type: string
              const: running_post_deploy
            - type: string
              const: cleaning_up
            - type: string
              const: succeeded
            - type: string
              const: succeeded_with_warnings
            - type: string
              const: skipped
            - type: string
              const: failed
            - type: string
              const: cancelled
        trigger:
          anyOf:
            - type: string
              const: rollback
            - type: string
              const: manual
            - type: string
              const: auto_deploy
        updatedAt:
          type: string
          format: date-time
        queueBlocker:
          anyOf:
            - type: 'null'
            - type: string
              const: server_capacity
            - type: string
              const: server_check
            - type: string
              const: server_operation
            - type: string
              const: server_preparation
      required:
        - deployableName
        - appId
        - targetEnvironment
        - commitSha
        - deployableKind
        - environment
        - createdAt
        - errorCode
        - errorMessage
        - finishedAt
        - id
        - gitRef
        - githubDeploymentId
        - hostname
        - imageDigest
        - imagePlatform
        - kind
        - manifestDigest
        - sourceInputDigest
        - serverId
        - sourceId
        - startedAt
        - state
        - trigger
        - updatedAt
        - queueBlocker
    Response_256:
      type: object
      properties:
        limit:
          type: number
        page:
          type: number
        total:
          type: number
        totalPages:
          type: number
      required:
        - limit
        - page
        - total
        - totalPages
    Response_99:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        branch:
          type: string
        mappingRevision:
          type: string
      required:
        - id
        - name
        - branch
        - mappingRevision
  responses:
    ApiError:
      description: Request failed. The error object contains code, message, and requestId.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - requestId
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
    RateLimited:
      description: Request failed. The error object contains code, message, and requestId.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - requestId
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
      headers:
        Retry-After:
          description: Seconds before retrying
          schema:
            type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Towbar API key

````