Skip to content
This repository has been archived by the owner on Dec 13, 2022. It is now read-only.

improve api documentation (url) #5792

Merged
merged 1 commit into from
Oct 17, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 38 additions & 38 deletions doc/en/api/api_rest/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ API Rest
Introduction
------------

Welcome to the Centreon API rest documentation. This documentation is for devlopers familiar with HTTP requests and JSON. It explains various API operations, related request and response structure, and error codes.
Welcome to the Centreon API rest documentation. This documentation is for developers familiar with HTTP requests and JSON. It explains various API operations, related request and response structure, and error codes.
If you are not familiar with the JSON API, we recommend you to use the Centreon command line API documentation.

This documentation is available in english only.
Expand All @@ -26,7 +26,7 @@ Authentication

Using POST method and the URL below: ::

api.domain.tld/api/index.php?action=authenticate
api.domain.tld/centreon/api/index.php?action=authenticate

Body form-data:

Expand Down Expand Up @@ -60,7 +60,7 @@ All monitoring information regarding hosts are available in throw the Centreon A

Using GET method and the URL below: ::

api.domain.tld/api/index.php?object=centreon_realtime_hosts&action=list
api.domain.tld/centreon/api/index.php?object=centreon_realtime_hosts&action=list

**Header:**

Expand Down Expand Up @@ -166,7 +166,7 @@ Field list :

Using GET method and the URL below: ::

api.domain.tld/api/index.php?object=centreon_realtime_hosts&action=list&limit=60&viewType=all&sortType=name&order=desc&fields=id,name,alias,address,state,output,next_check
api.domain.tld/centreon/api/index.php?object=centreon_realtime_hosts&action=list&limit=60&viewType=all&sortType=name&order=desc&fields=id,name,alias,address,state,output,next_check

Service Status
--------------
Expand All @@ -175,7 +175,7 @@ All monitoring information regarding services are available in throw the Centreo

Using GET method and the URL below: ::

api.domain.tld/api/index.php?object=centreon_realtime_services&action=list
api.domain.tld/centreon/api/index.php?object=centreon_realtime_services&action=list

**Header:**

Expand Down Expand Up @@ -320,7 +320,7 @@ Example:

Using GET method and the URL below: ::

api.domain.tld/api/index.php?action=list&object=centreon_realtime_services&limit=60&viewType=all&sortType=name&order=desc&fields=id,description,host_id,host_name,state,output
api.domain.tld/centreon/api/index.php?action=list&object=centreon_realtime_services&limit=60&viewType=all&sortType=name&order=desc&fields=id,description,host_id,host_name,state,output


Configuration
Expand All @@ -335,7 +335,7 @@ Here is an example for listing hosts using rest API.

Using POST method and the URL below: ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi

**Header:**

Expand Down Expand Up @@ -411,7 +411,7 @@ List hosts

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -472,7 +472,7 @@ Add host

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -510,7 +510,7 @@ Delete host

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -549,7 +549,7 @@ Set parameters

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -680,7 +680,7 @@ Set instance poller

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -718,7 +718,7 @@ Get macro

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -779,7 +779,7 @@ Set macro

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -817,7 +817,7 @@ Delete macro

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -855,7 +855,7 @@ Get template

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -908,7 +908,7 @@ Set template

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -946,7 +946,7 @@ Add template

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -983,7 +983,7 @@ Delete template

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1020,7 +1020,7 @@ Apply template

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1056,7 +1056,7 @@ Get parent

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1098,7 +1098,7 @@ Add parent

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1140,7 +1140,7 @@ Set parent

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1183,7 +1183,7 @@ Delete parent

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1225,7 +1225,7 @@ Get contact group

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1269,7 +1269,7 @@ Add contact group

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1312,7 +1312,7 @@ Set contact group

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1355,7 +1355,7 @@ Delete contact group

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1396,7 +1396,7 @@ Get contact

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1438,7 +1438,7 @@ Add contact

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1481,7 +1481,7 @@ Set contact

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1525,7 +1525,7 @@ Delete contact

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1566,7 +1566,7 @@ Get hostgroup

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1611,7 +1611,7 @@ Add hostgroup

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1655,7 +1655,7 @@ Set hostgroup

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1699,7 +1699,7 @@ Delete hostgroup

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1750,7 +1750,7 @@ Enable

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down Expand Up @@ -1788,7 +1788,7 @@ Disable

**POST** ::

api.domain.tld/api/index.php?action=action&object=centreon_clapi
api.domain.tld/centreon/api/index.php?action=action&object=centreon_clapi


**Header**
Expand Down
Loading