Devtron

Devtron Deployment History API

Retrieves the deployment history for a specific CD pipeline based on various filter criteria.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/devtron/refs/heads/main/authentication/devtron-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/devtron/refs/heads/main/openapi/devtron-deployment-history-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/devtron/refs/heads/main/conventions/devtron-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/devtron/refs/heads/main/errors/devtron-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/devtron/refs/heads/main/data-model/devtron-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/devtron/refs/heads/main/conformance/devtron-conformance.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/devtron/refs/heads/main/agentic-access/devtron-agentic-access.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/devtron/refs/heads/main/asyncapi/devtron-notifications-webhooks.yml

OpenAPI Specification

devtron-deployment-history-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: 1.0.0
  title: Devtron APIs Specs Applications Deployment History API
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: Application management operations including creation, listing, and updates
servers:
- url: http://localhost/orchestrator
  description: Local development server
tags:
- name: Deployment History
  x-displayName: Get Deployment History (ENT)
  description: Retrieves the deployment history for a specific CD pipeline based on various filter criteria.
paths:
  /resource/history/deployment/cd-pipeline/v1:
    get:
      summary: Get Deployment History
      description: Retrieves the deployment history for a specific CD pipeline based on various filter criteria.
      operationId: getDeploymentHistory
      security: []
      parameters:
      - name: token
        in: header
        required: true
        description: Authentication token.
        schema:
          type: string
      - name: filterCriteria
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
        description: 'Filter criteria for deployment history. Example:

          - application/devtron-application|id|1064

          - environment|id|146

          - release|id|203

          '
      - name: offset
        in: query
        required: false
        schema:
          type: integer
        description: The starting point for fetching records (pagination).
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: The number of records to return (pagination).
      responses:
        '200':
          description: Successful retrieval of deployment history.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  status:
                    type: string
                    example: OK
                  result:
                    type: object
                    properties:
                      cdWorkflows:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 19767
                            cd_workflow_id:
                              type: integer
                              example: 19576
                            name:
                              type: string
                              example: cd-1064-nu4s
                            status:
                              type: string
                              example: Succeeded
                            pod_status:
                              type: string
                              example: ''
                            message:
                              type: string
                              example: ''
                            started_on:
                              type: string
                              format: date-time
                              example: '2024-07-25T08:36:42.414376Z'
                            finished_on:
                              type: string
                              format: date-time
                              example: '2024-07-25T08:40:03.455303Z'
                            pipeline_id:
                              type: integer
                              example: 2082
                            namespace:
                              type: string
                              example: devtron-cd
                            log_file_path:
                              type: string
                              example: ''
                            triggered_by:
                              type: integer
                              example: 23
                            email_id:
                              type: string
                              example: deepak@devtron.ai
                            image:
                              type: string
                              example: devtroninc.azurecr.io/test:8a0c2298-fc94fa4b-956-18655
                            ci_artifact_id:
                              type: integer
                              example: 14593
                            workflow_type:
                              type: string
                              example: DEPLOY
                            blobStorageEnabled:
                              type: boolean
                              example: true
                            userApprovalMetadata:
                              type: object
                              nullable: true
                            gitTriggers:
                              type: object
                              additionalProperties:
                                type: object
                                properties:
                                  Commit:
                                    type: string
                                    example: 8a0c22983ae7acae10abe7569026ae25d889e159
                                  Author:
                                    type: string
                                    example: jatin-jangir-0220 <122791251+jatin-jangir-0220@users.noreply.github.com>
                                  Date:
                                    type: string
                                    format: date-time
                                    example: '2024-04-29T18:49:39Z'
                                  Message:
                                    type: string
                                    example: 'Update Dockerfile (#19)


                                      '
                                  Changes:
                                    type: string
                                    nullable: true
                                  WebhookData:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 0
                                      eventActionType:
                                        type: string
                                        example: ''
                                      data:
                                        type: string
                                        nullable: true
                                  CiConfigureSourceValue:
                                    type: string
                                    example: main
                                  GitRepoUrl:
                                    type: string
                                    example: https://github.com/devtron-labs/casbin-enterprise
                                  GitRepoName:
                                    type: string
                                    example: casbin-enterprise
                                  CiConfigureSourceType:
                                    type: string
                                    example: SOURCE_TYPE_BRANCH_FIXED
                            ciMaterials:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1013
                                  gitMaterialId:
                                    type: integer
                                    example: 411
                                  gitMaterialUrl:
                                    type: string
                                    example: ''
                                  gitMaterialName:
                                    type: string
                                    example: casbin-enterprise
                                  type:
                                    type: string
                                    example: SOURCE_TYPE_BRANCH_FIXED
                                  value:
                                    type: string
                                    example: main
                                  active:
                                    type: boolean
                                    example: true
                                  lastFetchTime:
                                    type: string
                                    format: date-time
                                    example: '0001-01-01T00:00:00Z'
                                  isRepoError:
                                    type: boolean
                                    example: false
                                  repoErrorMsg:
                                    type: string
                                    example: ''
                                  isBranchError:
                                    type: boolean
                                    example: false
                                  branchErrorMsg:
                                    type: string
                                    example: ''
                                  url:
                                    type: string
                                    example: https://github.com/devtron-labs/casbin-enterprise
                                  regex:
                                    type: string
                                    example: ''
                      tagsEditable:
                        type: boolean
                        example: false
                      appReleaseTagNames:
                        type: array
                        items:
                          type: string
                        example: []
                      hideImageTaggingHardDelete:
                        type: boolean
                        example: false
              examples:
                example-1:
                  value:
                    code: 200
                    status: OK
                    result:
                      cdWorkflows:
                      - id: 19752
                        cd_workflow_id: 19561
                        name: cd-1064-nu4s
                        status: Failed
                        pod_status: ''
                        message: 'Unable to continue with install: could not get information about the resource Job "" in namespace "devtroncd": resource name may not be empty'
                        started_on: '2024-07-25T08:26:21.792068Z'
                        finished_on: '2024-07-25T08:26:23.855384Z'
                        pipeline_id: 2082
                        namespace: devtron-cd
                        log_file_path: ''
                        triggered_by: 23
                        email_id: deepak@devtron.ai
                        image: devtroninc.azurecr.io/test:8a0c2298-fc94fa4b-956-18655
                        ci_artifact_id: 14593
                        workflow_type: DEPLOY
                        blobStorageEnabled: true
                        userApprovalMetadata: null
                        gitTriggers:
                          '1013':
                            Commit: 8a0c22983ae7acae10abe7569026ae25d889e159
                            Author: jatin-jangir-0220 <122791251+jatin-jangir-0220@users.noreply.github.com>
                            Date: '2024-04-29T18:49:39Z'
                            Message: 'Update Dockerfile (#19)


                              '
                            Changes: null
                            WebhookData:
                              id: 0
                              eventActionType: ''
                              data: null
                            CiConfigureSourceValue: main
                            GitRepoUrl: https://github.com/devtron-labs/casbin-enterprise
                            GitRepoName: casbin-enterprise
                            CiConfigureSourceType: SOURCE_TYPE_BRANCH_FIXED
                          '2072':
                            Commit: fc94fa4bad21460e822ce896b5166273aa3df1a8
                            Author: Gireesh Naidu <111440205+gireesh-naidu@users.noreply.github.com>
                            Date: '2024-07-23T18:13:18+05:30'
                            Message: "fix: getting 500 while updating the branch of linked CI (#1424)\n\n* fix: sync ci pipeline materials for linked pipelines\r\n\r\n* fix: sync ci pipeline materials for linked pipelines\r\n\r\n* fix: null column fix\r\n\r\n* fix: null column fix\r\n\r\n* fix: able to delete ci pipeline though it has linked ci's using API"
                            Changes: null
                            WebhookData:
                              id: 0
                              eventActionType: ''
                              data: null
                            CiConfigureSourceValue: main
                            GitRepoUrl: https://github.com/devtron-labs/devtron-enterprise
                            GitRepoName: devtron-enterprise
                            CiConfigureSourceType: SOURCE_TYPE_BRANCH_FIXED
                        ciMaterials:
                        - id: 1013
                          gitMaterialId: 411
                          gitMaterialUrl: ''
                          gitMaterialName: casbin-enterprise
                          type: SOURCE_TYPE_BRANCH_FIXED
                          value: main
                          active: true
                          lastFetchTime: '0001-01-01T00:00:00Z'
                          isRepoError: false
                          repoErrorMsg: ''
                          isBranchError: false
                          branchErrorMsg: ''
                          url: https://github.com/devtron-labs/casbin-enterprise
                          regex: ''
                        - id: 2072
                          gitMaterialId: 1286
                          gitMaterialUrl: ''
                          gitMaterialName: devtron-enterprise
                          type: SOURCE_TYPE_BRANCH_FIXED
                          value: main
                          active: true
                          lastFetchTime: '0001-01-01T00:00:00Z'
                          isRepoError: false
                          repoErrorMsg: ''
                          isBranchError: false
                          branchErrorMsg: ''
                          url: https://github.com/devtron-labs/devtron-enterprise
                          regex: ''
                        imageReleaseTags: null
                        imageComment: null
                        referenceCdWorkflowRunnerId: 0
                        appliedFilters: null
                        appliedFiltersState: 0
                        appliedFiltersTimestamp: '0001-01-01T00:00:00Z'
                        promotionApprovalMetadata: null
                        runSource:
                          kind: release
                          version: alpha1
                          id: 203
                          identifier: qa-releases-track-0.0.2
                          releaseVersion: 0.0.2
                          name: deepak-qa-release
                          releaseTrackName: qa-releases-track
                        targetConfig:
                          tenantId: qa-devtroncd-x
                          tenantName: QA Devtron Env
                          installationId: qa-devtroncd-2
                          installationName: qa-devtroncd-2
                          releaseChannelId: beta
                          releaseChannelName: beta-channel
      tags:
      - Deployment History
  /orchestrator/app/history/deployed-component/detail/{appId}/{pipelineId}/{id}:
    get:
      summary: Fetch component history
      description: fetch detail of a history on the basis of the history component and it's name
      operationId: FetchHistoryByDeployedConfigurationDetail
      tags:
      - Deployment History
      parameters:
      - name: token
        in: header
        required: true
        description: Authentication token.
        schema:
          type: string
      - name: appId
        in: path
        required: true
        schema:
          type: integer
      - name: pipelineId
        in: path
        required: true
        schema:
          type: integer
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: historyComponent
        in: query
        required: true
        schema:
          type: string
          enum:
          - DEPLOYMENT_TEMPLATE
          - CONFIGMAP
          - SECRET
          - PIPELINE_STRATEGY
      - name: historyComponentName
        in: query
        required: false
        description: name of config-map, secret
        schema:
          type: string
      security: []
      responses:
        '200':
          description: Successfully return history
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoryComponentDetailDto'
        '400':
          description: Bad Request. Input Validation error/wrong request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Unauthorized User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /orchestrator/app/history/deployed-component/list/{appId}/{pipelineId}:
    get:
      summary: fetch deployed history details list
      description: fetch deployed history details list
      operationId: FetchHistoryListByDeployedConfigurationDetail
      tags:
      - Deployment History
      parameters:
      - name: token
        in: header
        required: true
        description: Authentication token.
        schema:
          type: string
      - name: appId
        in: path
        required: true
        schema:
          type: integer
      - name: pipelineId
        in: path
        required: true
        schema:
          type: integer
      - name: historyComponent
        in: query
        required: true
        schema:
          type: string
          enum:
          - DEPLOYMENT_TEMPLATE
          - CONFIGMAP
          - SECRET
          - PIPELINE_STRATEGY
      - name: historyComponentName
        in: query
        required: false
        description: name of config-map, secret
        schema:
          type: string
      - name: baseConfigurationId
        in: query
        required: true
        description: id of base configuration
        schema:
          type: integer
      security: []
      responses:
        '200':
          description: Successfully return history list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoryComponentListDto'
        '400':
          description: Bad Request. Input Validation error/wrong request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Unauthorized User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /orchestrator/app/history/deployed-configuration/{appId}/{pipelineId}/{wfrId}:
    get:
      summary: all deployed configuration history
      description: fetch all deployed configurations history (deployment template, pipeline strategy, configmaps, secrets)
      operationId: FetchHistoryListForAllDeployedConfigurations
      tags:
      - Deployment History
      parameters:
      - name: token
        in: header
        required: true
        description: Authentication token.
        schema:
          type: string
      - name: appId
        in: path
        required: true
        schema:
          type: integer
      - name: pipelineId
        in: path
        required: true
        schema:
          type: integer
      - name: wfrId
        in: path
        required: true
        schema:
          type: integer
      security: []
      responses:
        '200':
          description: Successfully return history
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HistoryConfigurationListDto'
        '400':
          description: Bad Request. Input Validation error/wrong request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Unauthorized User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    HistoryComponentValuesDto:
      type: object
      properties:
        fieldName:
          type: object
          properties:
            displayName:
              type: string
            value:
              type: string
    HistoryComponentListDto:
      type: object
      properties:
        id:
          type: integer
        deployedOn:
          type: string
          format: timestamp
        deployedBy:
          type: string
        deploymentStatus:
          type: string
    HistoryConfigurationListDto:
      type: array
      items:
        $ref: '#/components/schemas/HistoryConfiguration'
    HistoryConfiguration:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          enum:
          - DEPLOYMENT_TEMPLATE
          - CONFIGMAP
          - SECRET
          - PIPELINE_STRATEGY
        childList:
          type: array
          items:
            type: string
    Error:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          description: Error code
        message:
          type: string
          description: Error message
    HistoryComponentDetailDto:
      type: object
      properties:
        values:
          type: array
          items:
            $ref: '#/components/schemas/HistoryComponentValuesDto'
        codeEditorValue:
          type: object
          properties:
            displayName:
              type: string
            value:
              type: string
x-tagGroups:
- name: Common Devtron automation APIs
  tags:
  - Metadata
  - Jobs
  - Helm Charts
  - List Applications
  - Applications
  - Labels
  - bulk_other
  - BulkUpdate
  - SSO Configuration
  - User Management
  - Role Group Management
  - RBAC
  - Authentication
  - Policy Management
  - Cache Management
  - Cluster Environment
  - Cluster Management
  - Environment Management
  - Change Chart
  - Clone Workflow
  - Deployment History
  - K8s Resource
  - Resource Recommendation
  - Workflow Management
  - Devtron Server version
  - GitOps Validation
  - Notifications