Chaitin Tech notificationbot API

通知机器人

OpenAPI Specification

chaitin-notificationbot-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: APISec Management account notificationbot API
  version: '26.05'
  description: Generated from APISec skyview APIView classes.
tags:
- name: notificationbot
  description: 通知机器人
paths:
  /notificationbot:
    post:
      summary: 新增通知渠道
      deprecated: false
      description: ''
      tags:
      - notificationbot
      parameters:
      - name: X-CS-Header-App
        in: header
        description: 应用id
        required: true
        example: '{{app}}'
        schema:
          type: string
      - name: X-CS-Header-Company
        in: header
        description: 公司id
        required: true
        example: '{{company_id}}'
        schema:
          type: string
      - name: X-CS-Header-Crypt
        in: header
        description: 加密算法,请参考:https://servaltech.feishu.cn/docs/doccnQCZ2cw32uazgNSO0DFwceb
        required: true
        example: ''
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 对于支持「ETAG」的接口,将上一次请求的响应header的Etag,填入到下一次请求。若匹配,则返回304(无变更),否则会返回新版本的数据 + 新Etag
        required: true
        example: string
        schema:
          type: string
      - name: X-CS-Header-Debug
        in: header
        description: ''
        required: true
        example: '{{debug}}'
        schema:
          type: string
      - name: Accept-Language
        in: header
        description: ''
        required: true
        example: zh
        schema:
          type: string
      - name: X-Cs-Header-Timezone
        in: header
        description: ''
        required: true
        example: Asia/Shanghai
        schema:
          type: string
      - name: Content-Type
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      - name: Accept
        in: header
        description: ''
        required: true
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                category:
                  type: string
                config:
                  type: object
                  properties:
                    email_notification:
                      type: object
                      properties:
                        from_user:
                          type: string
                        user_name:
                          type: string
                        password:
                          type: string
                        server:
                          type: string
                        smtp_port:
                          type: integer
                        encryption_mode:
                          type: integer
                      required:
                      - from_user
                      - user_name
                      - password
                      - server
                      - smtp_port
                      - encryption_mode
                  required:
                  - email_notification
              required:
              - name
              - category
              - config
            example:
              name: 邮件机器人
              category: email
              config:
                email_notification:
                  from_user: xingwang.xu@cyberserval.cn
                  user_name: 邮件告警测试
                  password: nopassword
                  server: smtp.feishu.cn
                  smtp_port: 465
                  encryption_mode: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
              example: {}
      security: []