Skip to content

Other endpoints

José Bonnet edited this page Jul 25, 2018 · 2 revisions

This wiki page is part of the usage documentation of the tng-gtk-common module.

Root

The root (/) endpoint of this component can be accessed to return the API it implements (still a WiP).

$ curl :api_root/

Pings

In order for the component to communicate it is alive, the following command can be issued:

$ curl :api_root/pings

An HTTP return code of 200 will indicate that the component is alive. In the current implementation, the answer will be a Content-Type of application/json, like in:

{ "alive_since": "2018-05-14 10:53:41 UTC"}
Clone this wiki locally