docs/sections/apis/PMSH.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3
   4 ========================
   5 PM Subscription Handler
   6 ========================
   7
   8 .. contents::
   9     :depth: 3
  10
  11 Overview
  12 ========
  13
  14 Component description can be found under `PM Subscription Handler`_.
  15
  16 .. _PM Subscription Handler: ../../sections/services/pm-subscription-handler/index.html
  17
  18 Paths
  19 =====
  20
  21 GET ``/healthcheck``
  22 --------------------
  23
  24 Description
  25 ~~~~~~~~~~~
  26 This is the health check endpoint. If this returns a 200, the server is alive.
  27 If anything other than a 200, the server is either dead or no connection to PMSH.
  28
  29 Responses
  30 ~~~~~~~~~
  31
  32 +-----------+---------------------+
  33 | HTTP Code | Description         |
  34 +===========+=====================+
  35 | **200**   | successful response |
  36 +-----------+---------------------+
  37
  38 GET ``/subscriptions``
  39 ----------------------
  40
  41 Description
  42 ~~~~~~~~~~~
  43 The subscriptions endpoint can be used to fetch all subscriptions which exist in the database.
  44
  45 Responses
  46 ~~~~~~~~~
  47
  48 +-----------+---------------------+
  49 | HTTP Code | Description         |
  50 +===========+=====================+
  51 | **200**   | successful response |
  52 +-----------+---------------------+