ilert Deployment Pipelines API

openapi: 3.2.0
info:
  title: ilert REST Deployment Pipelines API
  description: '# Introduction

    The ilert API is a RESTful API and provides programmatic access to entities in ilert and lets you easily integrate ilert with 3rd party tools.'
  version: v2.2026.5-r.3
  x-logo:
    url: ./ilert-logo-spaced.png
    backgroundColor: '#fafafa'
    altText: ilert documentation logo
servers:
- url: /api
security:
- apiKey: []
tags:
- name: Deployment Pipelines
paths:
  /deployment-pipelines:
    get:
      tags:
      - Deployment Pipelines
      summary: Get deployment pipelines
      parameters:
      - name: start-index
        in: query
        description: an integer specifying the starting point (beginning with 0) when paging through a list of entities
        schema:
          type: integer
          format: int32
          default: 0
      - name: max-results
        in: query
        description: the maximum number of results when paging through a list of deployment pipelines
        schema:
          maximum: 100
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: The deployment pipelines
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentPipeline'
      operationId: getDeploymentPipelines
      x-operation-id-source: derived
    post:
      tags:
      - Deployment Pipelines
      summary: Create a new deployment pipeline
      requestBody:
        description: The deployment pipeline
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentPipeline'
        required: true
      responses:
        '200':
          description: The newly created depoyment pipeline
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentPipeline'
      operationId: postDeploymentPipelines
      x-operation-id-source: derived
  /deployment-pipelines/{id}:
    get:
      tags:
      - Deployment Pipelines
      summary: Get a specific deployment pipeline
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '200':
          description: The requested deployment pipeline
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentPipeline'
      operationId: getDeploymentPipelinesById
      x-operation-id-source: derived
    put:
      tags:
      - Deployment Pipelines
      summary: Update the specific deployment pipeline
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      requestBody:
        description: The deployment pipeline
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentPipeline'
        required: true
      responses:
        '200':
          description: The updated deployment pipeline
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentPipeline'
      operationId: putDeploymentPipelinesById
      x-operation-id-source: derived
    delete:
      tags:
      - Deployment Pipelines
      summary: Delete a specific deployment pipeline
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '204':
          description: Empty body delete response
          content: {}
      operationId: deleteDeploymentPipelinesById
      x-operation-id-source: derived
components:
  schemas:
    DeploymentPipeline:
      type: object
      required:
      - name
      - integrationType
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        integrationType:
          type: string
        integrationKey:
          type: string
        teams:
          type: array
          items:
            $ref: '#/components/schemas/TeamRel'
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        params:
          $ref: '#/components/schemas/DeploymentPipelineParams'
        integrationUrl:
          type: string
    DPipeGithubParams:
      type: object
      description: Deployment pipeline Github integration params
      properties:
        branchFilters:
          type: array
          items:
            type: string
        eventFilters:
          type: array
          items:
            type: string
    TeamRel:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    DPipeAPIParams:
      type: object
      description: Deployment pipeline API integration params
      default: null
      properties: {}
    DeploymentPipelineParams:
      type: object
      description: Dynamic params based on the chosen integration type of the pipeline
      default: 'null'
      oneOf:
      - $ref: '#/components/schemas/DPipeAPIParams'
      - $ref: '#/components/schemas/DPipeGithubParams'
  securitySchemes:
    apiKey:
      type: apiKey
      description: The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.
      name: Authorization
      in: header
x-original-swagger-version: '2.0'