aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org>2020-02-29 11:17:51 +0200
committerSergey Poznyakoff <gray@gnu.org>2020-02-29 11:17:51 +0200
commit4771762b12e16954f94a1da6f49250413686811f (patch)
tree84172710b03e0d68408fa8f122d9c120fd49e225 /README
parent9714865e61ff0eedbe4b5557b50eb8ea0bb42259 (diff)
downloadping903-4771762b12e16954f94a1da6f49250413686811f.tar.gz
ping903-4771762b12e16954f94a1da6f49250413686811f.tar.bz2
New entry point "/id"
Returns information about the running instance.
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
index 688d431..15b6b33 100644
--- a/README
+++ b/README
@@ -192,6 +192,25 @@ The default channel for communication with the ping903 daemon is the
HTTP socket open on localhost port 8080. Only GET requests are
allowed. The following endpoints are provided:
+** /id
+
+Identifies the running instance. On success, a JSON object with the
+following attributes is returned:
+
+- "package": string
+ The package name.
+
+- "version": string
+ Package version string.
+
+- "pid": number
+ PID of the running instance.
+
+** /id/ATTR
+
+ATTR is one of the attributes discussed above. Returned is the value
+of that attribute.
+
** /host/NAME
NAME is the IP address or hostname. The server will look up this

Return to:

Send suggestions and report system problems to the System administrator.