openapi: 3.0.1
info:
  title: ilert REST Alert Actions Connectors 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: Connectors
paths:
  /connectors:
    get:
      tags:
      - Connectors
      summary: Get connectors.
      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 entities.
        schema:
          maximum: 100
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: The connectors
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Connector'
    post:
      tags:
      - Connectors
      summary: Create a new connector.
      requestBody:
        description: the connector
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Connector'
        required: true
      responses:
        '200':
          description: The newly created connector
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connector'
      x-codegen-request-body-name: connector
  /connectors/{id}:
    get:
      tags:
      - Connectors
      summary: Get a specific connector.
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested connector
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connector'
    put:
      tags:
      - Connectors
      summary: 'Update the specific connector. (note: type cannot be changed)'
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: string
      requestBody:
        description: the connector
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Connector'
        required: true
      responses:
        '200':
          description: The updated connector
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connector'
      x-codegen-request-body-name: connector
    delete:
      tags:
      - Connectors
      summary: Remove a specific connector.
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Empty body delete response
          content: {}
components:
  schemas:
    EParamsGoogleFunction:
      type: object
      properties:
        authorization:
          type: string
    EParamsJira:
      type: object
      properties:
        url:
          type: string
        email:
          type: string
        password:
          type: string
    EParamsZabbix:
      type: object
      properties:
        url:
          type: string
        apiKey:
          type: string
    EParamsDatadog:
      type: object
      properties:
        apiKey:
          type: string
    EParamsSlack:
      type: object
    EParamsSysdig:
      type: object
      properties:
        apiKey:
          type: string
    EParamsStatusPageIO:
      type: object
      properties:
        apiKey:
          type: string
    EParamsAWSLambda:
      type: object
      properties:
        authorization:
          type: string
    EParamsZendesk:
      type: object
      properties:
        url:
          type: string
        email:
          type: string
        apiKey:
          type: string
    EParamsTopdesk:
      type: object
      properties:
        url:
          type: string
        username:
          type: string
        password:
          type: string
    ConnectorType:
      type: string
      enum:
      - jira
      - microsoft_teams_bot
      - servicenow
      - slack
      - zendesk
      - discord
      - github
      - topdesk
      - zammad
      - mattermost
      - zoom_chat
      - dingtalk
      - dynamic
      - zabbix
      - autotask
      - google_chat_bot
    EParamsDiscord:
      type: object
      properties:
        url:
          type: string
    EParamsServiceNow:
      type: object
      properties:
        url:
          type: string
        username:
          type: string
        password:
          type: string
    EParamsMicrosoftTeams:
      type: object
      properties:
        url:
          type: string
    EParamsDingTalk:
      type: object
      properties:
        url:
          type: string
        secret:
          type: string
    EParamsAzureFunction:
      type: object
      properties:
        authorization:
          type: string
    Connector:
      required:
      - name
      - type
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/ConnectorType'
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        params:
          type: object
          oneOf:
          - $ref: '#/components/schemas/EParamsDatadog'
          - $ref: '#/components/schemas/EParamsJira'
          - $ref: '#/components/schemas/EParamsMicrosoftTeams'
          - $ref: '#/components/schemas/EParamsServiceNow'
          - $ref: '#/components/schemas/EParamsSlack'
          - $ref: '#/components/schemas/EParamsZendesk'
          - $ref: '#/components/schemas/EParamsDiscord'
          - $ref: '#/components/schemas/EParamsGithub'
          - $ref: '#/components/schemas/EParamsTopdesk'
          - $ref: '#/components/schemas/EParamsAWSLambda'
          - $ref: '#/components/schemas/EParamsAzureFunction'
          - $ref: '#/components/schemas/EParamsGoogleFunction'
          - $ref: '#/components/schemas/EParamsSysdig'
          - $ref: '#/components/schemas/EParamsStatusPageIO'
          - $ref: '#/components/schemas/EParamsDingTalk'
          - $ref: '#/components/schemas/EParamsZabbix'
    EParamsGithub:
      type: object
      properties:
        apiKey:
          type: string
  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'