openapi: 3.0.1
info:
  title: ilert REST Alert Actions Deployment Pipelines API
  description: "# Introduction\nThe ilert API is a [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API and provides programmatic access to entities in ilert and lets you easily integrate ilert with 3rd party tools. If you are looking to develop an inbound integration (e.g. for a monitoring tool), please use our [Events API](#tag/events). \n\nThe API supports the JSON content type for requests and responses. The response content type is requested via the HTTP Accept header (`application/json`). All resources are accessible via https and are located at `api.ilert.com/api`. \n\n You may download ilert's latest [OpenAPI.json {...} here](https://api.ilert.com/api-docs/openapi.json).\n\n If you are looking for a classic Swagger-UI view you may also open [this link](https://api.ilert.com/api-docs/swagger-ui). \n\n ## Authentication\nThe REST API accepts bearer API tokens. Each user may create API keys using the ilert web application. Note: Make sure to send the `Bearer ` prefix e.g. `Bearer APIKEY` when sending api key requests. By default, access to all resources (using any method) requires the client to be authenticated.\n\n ## Team Context\n When using API tokens, the currently selected team context of the user will not be taken into account, i.e. list results will always return all entities to which the user has a view permission. When using basic auth credentials the currently selected team context of the user will be used to filter resource results. The context may be overwritten for API key calls using the `team-context` HTTP header. Specifying `0` for ALL teams, `-1` for MY teams or a specific team id e.g. `team-context=901` to fetch results for a certain team.  \n\n ## Errors\nilert uses HTTP response codes to indicate success or failure of an API request. Codes in the 2xx range indicate success, codes in the 4xx range indicate a client error (e.g. a missing required parameter) and codes in the 5xx range indicate an error with ilert's servers. In case of an error, the response body contains the following information:\n\n Attribute     | Description \n ------------- | ------------- \n status  | the corresponsing HTTP status code  \n message  | a human readable description of the error \n code  | error code, used to identify error type  \n\n ## API Versioning\nChanges to our API are always backwards-compatible. To get more information about our API versioning and historical changes, please <a href='https://docs.ilert.com/rest-api/api-version-history' target='_blank'>take a look here</a>."
  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'
    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'
  /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'
    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'
    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: {}
components:
  schemas:
    TeamRel:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    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
    DPipeAPIParams:
      type: object
      description: Deployment pipeline API integration params
      default: null
      properties: {}
    DPipeGithubParams:
      type: object
      description: Deployment pipeline Github integration params
      properties:
        branchFilters:
          type: array
          items:
            type: string
        eventFilters:
          type: array
          items:
            type: string
    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'