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