Cronjob.de Benachrichtigungen API

openapi: 3.2.0
info:
  title: cronjob.de REST Benachrichtigungen API
  version: 1.0.0
  description: 'Manage cron jobs, heartbeats, server monitors and status pages on cronjob.de. Same functions as the MCP server at https://www.cronjob.de/bridge. Reading needs an API key; changes need the Unlimited plan (or the trial). Docs: https://www.cronjob.de/api'
servers:
- url: https://www.cronjob.de/api/v1
security:
- bearer: []
tags:
- name: Benachrichtigungen
paths:
  /contacts:
    get:
      operationId: list_contacts
      tags:
      - Benachrichtigungen
      summary: Benachrichtigungen ansehen
      description: 'Die Kontakte für Warnungen (E-Mail, Slack/Discord/Teams, Telegram, eigener Webhook, SMS) mit ID, ob Standardkontakt und ob bestätigt (fremde E-Mail-Adressen bekommen erst nach ihrem Bestätigungslink Warnungen). Dazu rules: wer wofür gewarnt wird – mode "standard" (die Standardkontakte), "custom" (contact_ids) oder "off" – für alle Cronjobs, einzelne Ordner, alle Heartbeats, einzelne Heartbeats, alle Serverüberwachungen, einzelne Überwachungen und SSL.'
      responses:
        '200':
          description: OK (JSON)
        '400':
          description: 'Invalid input; {"error": "..."}'
        '401':
          description: Missing or invalid API key
        '403':
          description: Plan or key does not allow changes
        '404':
          description: Not found
        '429':
          description: Rate limit
    post:
      operationId: add_contact
      tags:
      - Benachrichtigungen
      summary: Kontakt für Warnungen anlegen
      description: Legt einen Kontakt für Warnungen an. type "email" (ab Plus), "chat" (Webhook-Adresse aus Slack, Discord oder Microsoft Teams, ab Unlimited) oder "webhook" (eigener HTTPS-Endpunkt, ab Unlimited; das Signatur-Geheimnis steht im Konto unter Benachrichtigungen › Bearbeiten). Eine fremde E-Mail-Adresse (nicht die des Kontos oder eines Team-Zugangs) bekommt eine Mail mit Bestätigungslink und erst danach Warnungen – sag das dem Nutzer. Telegram lässt sich nur im Konto verbinden. Gibt es den Kontakt schon, kommt der vorhandene zurück.
      responses:
        '200':
          description: OK (JSON)
        '400':
          description: 'Invalid input; {"error": "..."}'
        '401':
          description: Missing or invalid API key
        '403':
          description: Plan or key does not allow changes
        '404':
          description: Not found
        '429':
          description: Rate limit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - email
                  - chat
                  - webhook
                target:
                  type: string
                  description: E-Mail-Adresse bzw. Webhook-Adresse.
                name:
                  type: string
                  description: Anzeigename, optional (z. B. "Bereitschaft").
                standard:
                  type: boolean
                  description: Standardkontakt? Standardkontakte bekommen alles, wofür keine eigene Auswahl gilt. Standard false.
                cc:
                  type: boolean
                  description: 'Nur E-Mail: in Kopie (CC) statt als Empfänger.'
              required:
              - type
              - target
      x-requires-plan: unlimited
  /alert-recipients:
    put:
      operationId: set_alert_recipients
      tags:
      - Benachrichtigungen
      summary: Empfänger der Warnungen festlegen
      description: 'Legt fest, wer wofür gewarnt wird. scope: "all_cronjobs", "folder" (id = Ordner-ID, 0 = unsortiert), "all_heartbeats", "heartbeat" (id = Job-ID des Heartbeats), "all_monitors", "monitor" (id = Überwachungs-ID), "ssl". mode "standard" = die Standardkontakte (bzw. die Einstellung der Gruppe darüber), "custom" = genau contact_ids, "off" = niemand. Nur bestätigte Kontakte werden tatsächlich benachrichtigt.'
      responses:
        '200':
          description: OK (JSON)
        '400':
          description: 'Invalid input; {"error": "..."}'
        '401':
          description: Missing or invalid API key
        '403':
          description: Plan or key does not allow changes
        '404':
          description: Not found
        '429':
          description: Rate limit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                scope:
                  type: string
                  enum:
                  - all_cronjobs
                  - folder
                  - all_heartbeats
                  - heartbeat
                  - all_monitors
                  - monitor
                  - ssl
                id:
                  type: integer
                  description: Nur bei folder, heartbeat und monitor.
                mode:
                  type: string
                  enum:
                  - standard
                  - custom
                  - 'off'
                contact_ids:
                  type: array
                  items:
                    type: integer
                  description: 'Bei mode "custom": IDs aus list_contacts.'
              required:
              - scope
              - mode
      x-requires-plan: unlimited
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: API key "<user_id>:<token>" from https://www.cronjob.de/loggedin/ki-zugang#ohne-browser