Skip to content

Commit

Permalink
doc heartbeat
Browse files Browse the repository at this point in the history
  • Loading branch information
afourmy committed Nov 2, 2018
1 parent 38d14a3 commit 9515617
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/event_driven/rest_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ eNMS has a ReST API allowing to:
- delete an object
- create an object
- update an object
- execute a Service instance or a Workflow.
- run a Service instance or a Workflow.
- make sure eNMS is alive.

This ReST API allows other/external automation entities to invoke eNMS functions remotely/programmatically. In this way, eNMS can be integrated into a larger automation solution.

Expand Down Expand Up @@ -46,3 +47,13 @@ Execute a job (i.e a service, or a workflow)
http://IP_address/rest/run_job/job_name

The job will run immediately.

Heartbeat
*********

::

# Test that eNMS is still alive (used for high availability mechanisms)
http://IP_address/rest/is_alive

eNMS returns ``True`` if it is still alive.

0 comments on commit 9515617

Please sign in to comment.