Groundwork Open Source alert API

The alert API from Groundwork Open Source — 3 operation(s) for alert.

Documentation GitHub OpenAPI

Specifications

https://raw.githubusercontent.com/api-evangelist/groundwork-open-source/refs/heads/main/openapi/groundwork-open-source-alert-api-openapi.yml

OpenAPI Specification

swagger: '2.0'
info:
  contact: {}
  title: Groundwork Open Source agent alert API
tags:
- name: alert
paths:
  /events:
    post:
      consumes:
      - application/json
      description: The following API endpoint can be used to send Alerts to Foundation.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
          schema:
            type: string
      tags:
      - alert
  /events-ack:
    post:
      consumes:
      - application/json
      description: The following API endpoint can be used to send Alerts to Foundation.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
          schema:
            type: string
      tags:
      - alert
  /events-unack:
    post:
      consumes:
      - application/json
      description: The following API endpoint can be used to send Alerts to Foundation.
      parameters:
      - description: Auth header
        in: header
        name: GWOS-APP-NAME
        required: true
        type: string
      - description: Auth header
        in: header
        name: GWOS-API-TOKEN
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
          schema:
            type: string
      tags:
      - alert