Skip to content
This repository has been archived by the owner on Feb 3, 2023. It is now read-only.

Commit

Permalink
minor docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
guilhemmarchand committed Jan 4, 2021
1 parent 170704f commit f1589e7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/rest_api_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@ ack_by_object / Get Ack by object
**This endpoint retrieves an existing acknowledgment record by the object name, it requires a GET call with the following information:**


- ``"object_category": type of object (data_source / data_host / metric_host)>"``
- ``"object": name of the object (data source / data host / metric host)``
- ``"object_category": type of object (data_source / data_host / metric_host)"``
- ``"object": name of the entity``

::

Expand Down Expand Up @@ -244,7 +244,7 @@ ack_enable / Enable Ack
**This endpoint will enable an acknowledgment by the object name, it requires a POST call with the following information:**

- ``"object_category": type of object (data_source / data_host / metric_host)``
- ``"object": name of the object (data source / data host / metric host)``
- ``"object": name of the entity``
- ``"ack_period": period for the acknowledgment in seconds``
- ``"update_comment": OPTIONAL: a comment for the update, comments are added to the audit record, if unset will be defined to: API update``

Expand All @@ -271,8 +271,8 @@ ack_disable / Disable Ack

**This endpoint will disable an acknowledgment by the object name, it requires a POST call with the following information:**

- ``"object_category": type of object (data_source / data_host / metric_host)>"``
- ``"object": name of the object (data source / data host / metric host)``
- ``"object_category": type of object (data_source / data_host / metric_host)"``
- ``"object": name of the entity``
- ``"update_comment": OPTIONAL: a comment for the update, comments are added to the audit record, if unset will be defined to: API update``

::
Expand Down

0 comments on commit f1589e7

Please sign in to comment.