There are two modes of authentication:
Entry point to retrieve an authentication token.
Authentication schema
| security | object |
OK
Unauthorized
{- "security": {
- "credentials": {
- "login": "admin",
- "password": "centreon"
}
}
}{- "contact": {
- "id": 3,
- "name": "Admin",
- "alias": "admin",
- "email": "admin@localhost",
- "is_admin": true
}, - "security": {
- "token": "9ed937d3911d212eae59300ac6977352"
}
}List all the hosts in real-time monitoring.
The available parameters to search / sort_by are:
| show_service | boolean Default: false Example: show_service=true Allows to display services belonging to items |
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 12,
- "alias": "Central",
- "display_name": "Central",
- "name": "Central",
- "state": 0,
- "services": [
- {
- "id": 5,
- "description": "Ping",
- "display_name": "Ping",
- "state": 0
}
], - "poller_id": 1,
- "acknowledged": false,
- "address_ip": "127.0.0.1",
- "check_attempt": 1,
- "checked": true,
- "execution_time": 0.070906,
- "icon_image": "ppm/operatingsystems-linux-snmp-linux-128.png",
- "icon_image_alt": "",
- "last_check": "2020-01-03T10:16:01Z",
- "last_hard_state_change": "2020-01-03T10:16:01Z",
- "last_state_change": "2020-01-03T10:16:01Z",
- "last_time_down": "2020-01-03T10:16:01Z",
- "last_time_unreachable": "2020-01-03T10:16:01Z",
- "last_time_up": "2020-01-03T10:16:01Z",
- "last_update": "2020-01-03T10:16:01Z",
- "max_check_attempts": 3,
- "output": "OK - 127.0.0.1 rta 0.100ms lost 0%\n",
- "passive_checks": false,
- "state_type": 0,
- "timezone": ":Europe/Paris"
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}Return a single host with full details and some details about its services.
| host_id required | integer <int64> Example: 12 ID of the host |
OK
Forbidden
Not Found
Internal Server Error
{- "id": 12,
- "alias": "Central",
- "display_name": "Central",
- "name": "Central",
- "state": 0,
- "services": [
- {
- "id": 5,
- "description": "Ping",
- "display_name": "Ping",
- "state": 0
}
], - "poller_id": 1,
- "acknowledged": false,
- "address_ip": "127.0.0.1",
- "check_attempt": 1,
- "checked": true,
- "execution_time": 0.070906,
- "icon_image": "ppm/operatingsystems-linux-snmp-linux-128.png",
- "icon_image_alt": "",
- "last_check": "2020-01-03T10:16:01Z",
- "last_hard_state_change": "2020-01-03T10:16:01Z",
- "last_state_change": "2020-01-03T10:16:01Z",
- "last_time_down": "2020-01-03T10:16:01Z",
- "last_time_unreachable": "2020-01-03T10:16:01Z",
- "last_time_up": "2020-01-03T10:16:01Z",
- "last_update": "2020-01-03T10:16:01Z",
- "max_check_attempts": 3,
- "output": "OK - 127.0.0.1 rta 0.100ms lost 0%\n",
- "passive_checks": false,
- "state_type": 0,
- "timezone": ":Europe/Paris",
- "active_checks": true,
- "check_command": "base_host_alive",
- "check_interval": 5,
- "check_period": "24x7",
- "check_type": 0,
- "last_hard_state": "2020-01-03T10:16:01Z",
- "last_notification": "2020-01-03T10:16:01Z",
- "latency": 0.005,
- "next_check": "2020-01-03T10:16:01Z",
- "next_host_notification": 0,
- "notification_interval": 30,
- "notification_number": 3,
- "notify": true,
- "notify_on_down": true,
- "notify_on_downtime": false,
- "notify_on_flapping": false,
- "notify_on_recovery": true,
- "notify_on_unreachable": false
}List all the services in real-time monitoring.
The available parameters to search / sort_by are:
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 5,
- "description": "Ping",
- "display_name": "Ping",
- "state": 0,
- "check_attempt": 1,
- "icon_image": "",
- "icon_image_alt": "",
- "last_check": "2020-01-03T10:16:01Z",
- "last_state_change": "2020-01-03T10:16:01Z",
- "max_check_attempts": 3,
- "output": "OK - 127.0.0.1 rta 0.025ms lost 0%\n",
- "state_type": 1,
- "hosts": {
- "id": 12,
- "alias": "Central",
- "display_name": "Central",
- "name": "Central",
- "state": 0
}
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}List all services related to a host in real-time monitoring.
The available parameters to search / sort_by are:
| host_id required | integer <int64> Example: 12 ID of the host |
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Not Found
Internal Server Error
{- "result": [
- {
- "id": 5,
- "description": "Ping",
- "display_name": "Ping",
- "state": 0,
- "check_attempt": 1,
- "icon_image": "",
- "icon_image_alt": "",
- "last_check": "2020-01-03T10:16:01Z",
- "last_state_change": "2020-01-03T10:16:01Z",
- "max_check_attempts": 3,
- "output": "OK - 127.0.0.1 rta 0.025ms lost 0%\n",
- "state_type": 1
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}Return a single service with full details.
| host_id required | integer <int64> Example: 12 ID of the host |
| service_id required | integer <int64> Example: 5 ID of the service |
OK
Forbidden
Not Found
Internal Server Error
{- "id": 5,
- "description": "Ping",
- "display_name": "Ping",
- "state": 0,
- "check_attempt": 1,
- "icon_image": "",
- "icon_image_alt": "",
- "last_check": "2020-01-03T10:16:01Z",
- "last_state_change": "2020-01-03T10:16:01Z",
- "max_check_attempts": 3,
- "output": "OK - 127.0.0.1 rta 0.025ms lost 0%\n",
- "state_type": 1,
- "check_command": "base_centreon_ping",
- "check_interval": 5,
- "check_period": "24x7",
- "check_type": 0,
- "command_line": "/usr/lib64/nagios/plugins/check_icmp -H 127.0.0.1 -n 5 -w 200,20% -c 400,50%",
- "execution_time": 0.179335,
- "is_acknowledged": false,
- "is_active_check": true,
- "is_checked": true,
- "last_hard_state_change": "2020-01-03T10:16:01Z",
- "last_notification": "2020-01-03T10:16:01Z",
- "last_time_critical": "2020-01-03T10:16:01Z",
- "last_time_ok": "2020-01-03T10:16:01Z",
- "last_time_unknown": "2020-01-03T10:16:01Z",
- "last_time_warning": "2020-01-03T10:16:01Z",
- "last_update": "2020-01-03T10:16:01Z",
- "latency": 0.031,
- "next_check": "2020-01-03T10:16:01Z",
- "performance_data": "rta=0.025ms;200.000;400.000;0; rtmax=0.061ms;;;; rtmin=0.015ms;;;; pl=0%;20;50;0;100 ",
- "scheduled_downtime_depth": 0
}List all the host groups in real-time monitoring.
The available parameters to search / sort_by are:
| show_host | boolean Default: false Example: show_host=true Allows to display hosts belonging to items |
| show_service | boolean Default: false Example: show_service=true Allows to display services belonging to items |
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 28,
- "name": "All",
- "host": {
- "id": 12,
- "alias": "Central",
- "display_name": "Central",
- "name": "Central",
- "state": 0,
- "services": [
- {
- "id": 5,
- "description": "Ping",
- "display_name": "Ping",
- "state": 0
}
]
}
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}List all the service groups in real-time monitoring.
The available parameters to search / sort_by are:
| show_service | boolean Default: false Example: show_service=true Allows to display services belonging to items |
| show_host | boolean Default: false Example: show_host=true Allows to display hosts belonging to items |
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 13,
- "name": "MySG",
- "host": {
- "id": 12,
- "alias": "Central",
- "display_name": "Central",
- "name": "Central",
- "state": 0,
- "services": [
- {
- "id": 5,
- "description": "Ping",
- "display_name": "Ping",
- "state": 0
}
]
}
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 34,
- "author_id": 3,
- "comment": "Acknowledged by admin",
- "deletion_time": "2020-01-03T10:16:01Z",
- "entry_time": "2020-01-03T10:16:01Z",
- "host_id": 12,
- "poller_id": 1,
- "is_notify_contacts": false,
- "is_persistent_comment": true,
- "is_sticky": true,
- "state": 1
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}| comment | string Short description of the acknowledgment |
| host_id | integer <int64> ID of the host |
| is_notify_contacts | boolean Indicates whether notification is sent to the contacts linked to the host or service |
| is_persistent_comment | boolean Indicates whether acknowledgment is maintained in the case of a restart of the scheduler |
| is_sticky | boolean Indicates whether acknowledgment is maintained in the case of a change of status |
Command Sent
Forbidden
Internal Server Error
{- "comment": "Acknowledged by admin",
- "host_id": 12,
- "is_notify_contacts": false,
- "is_persistent_comment": true,
- "is_sticky": true
}{- "code": 403,
- "message": "You are not authorized to access this resource"
}| host_id required | integer <int64> Example: 12 ID of the host |
Command Sent
Forbidden
Internal Server Error
{- "code": 403,
- "message": "You are not authorized to access this resource"
}| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 34,
- "author_id": 3,
- "comment": "Acknowledged by admin",
- "deletion_time": "2020-01-03T10:16:01Z",
- "entry_time": "2020-01-03T10:16:01Z",
- "host_id": 12,
- "poller_id": 1,
- "is_notify_contacts": false,
- "is_persistent_comment": true,
- "is_sticky": true,
- "state": 1,
- "service_id": 5
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}| comment | string Short description of the acknowledgment |
| host_id | integer <int64> ID of the host |
| is_notify_contacts | boolean Indicates whether notification is sent to the contacts linked to the host or service |
| is_persistent_comment | boolean Indicates whether acknowledgment is maintained in the case of a restart of the scheduler |
| is_sticky | boolean Indicates whether acknowledgment is maintained in the case of a change of status |
| service_id | integer <int64> ID of the service |
Command Sent
Forbidden
Internal Server Error
{- "comment": "Acknowledged by admin",
- "host_id": 12,
- "is_notify_contacts": false,
- "is_persistent_comment": true,
- "is_sticky": true,
- "service_id": 5
}{- "code": 403,
- "message": "You are not authorized to access this resource"
}| host_id required | integer <int64> Example: 12 ID of the host |
| service_id required | integer <int64> Example: 5 ID of the service |
Command Sent
Forbidden
Internal Server Error
{- "code": 403,
- "message": "You are not authorized to access this resource"
}List all downtimes
The available parameters to search / sort_by are:
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 329,
- "author_id": 3,
- "host_id": 12,
- "comment": "Downtime set by admin",
- "duration": 7200,
- "entry_time": "2020-01-03T10:16:02Z",
- "start_time": "2020-01-03T10:16:02Z",
- "end_time": "2020-01-03T10:16:02Z",
- "deletion_time": null,
- "actual_start_time": "2020-01-03T10:16:02Z",
- "actual_end_time": null,
- "is_started": true,
- "is_cancelled": false,
- "is_fixed": true,
- "service_id": 5
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}Display one downtime.
| downtime_id required | integer <int64> Example: 329 ID of the downtime |
OK
Forbidden
Not Found
Internal Server Error
{- "id": 329,
- "author_id": 3,
- "host_id": 12,
- "comment": "Downtime set by admin",
- "duration": 7200,
- "entry_time": "2020-01-03T10:16:02Z",
- "start_time": "2020-01-03T10:16:02Z",
- "end_time": "2020-01-03T10:16:02Z",
- "deletion_time": null,
- "actual_start_time": "2020-01-03T10:16:02Z",
- "actual_end_time": null,
- "is_started": true,
- "is_cancelled": false,
- "is_fixed": true,
- "service_id": 5
}Cancel a downtime.
| downtime_id required | integer <int64> Example: 329 ID of the downtime |
Command Sent
Forbidden
Not Found
Internal Server Error
{- "code": 403,
- "message": "You are not authorized to access this resource"
}List all downtimes of hosts
The available parameters to search / sort_by are:
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 329,
- "author_id": 3,
- "host_id": 12,
- "comment": "Downtime set by admin",
- "duration": 7200,
- "entry_time": "2020-01-03T10:16:02Z",
- "start_time": "2020-01-03T10:16:02Z",
- "end_time": "2020-01-03T10:16:02Z",
- "deletion_time": null,
- "actual_start_time": "2020-01-03T10:16:02Z",
- "actual_end_time": null,
- "is_started": true,
- "is_cancelled": false,
- "is_fixed": true
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}List all downtimes of services
The available parameters to search / sort_by are:
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 329,
- "author_id": 3,
- "host_id": 12,
- "comment": "Downtime set by admin",
- "duration": 7200,
- "entry_time": "2020-01-03T10:16:02Z",
- "start_time": "2020-01-03T10:16:02Z",
- "end_time": "2020-01-03T10:16:02Z",
- "deletion_time": null,
- "actual_start_time": "2020-01-03T10:16:02Z",
- "actual_end_time": null,
- "is_started": true,
- "is_cancelled": false,
- "is_fixed": true,
- "service_id": 5
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}List all downtimes of a host.
The available parameters to search / sort_by are:
| host_id required | integer <int64> Example: 12 ID of the host |
| show_service | boolean Default: false Example: show_service=true Allows to display services belonging to items |
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 329,
- "author_id": 3,
- "host_id": 12,
- "comment": "Downtime set by admin",
- "duration": 7200,
- "entry_time": "2020-01-03T10:16:02Z",
- "start_time": "2020-01-03T10:16:02Z",
- "end_time": "2020-01-03T10:16:02Z",
- "deletion_time": null,
- "actual_start_time": "2020-01-03T10:16:02Z",
- "actual_end_time": null,
- "is_started": true,
- "is_cancelled": false,
- "is_fixed": true
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}Add a downtime on a host.
| host_id required | integer <int64> Example: 12 ID of the host |
| start_time | string <date-time> Scheduled start date of the downtime (ISO8601) |
| end_time | string <date-time> Scheduled end date of the downtime (ISO8601) |
| is_fixed | boolean Indicates whether the downtime is fixed |
| duration | integer Downtime duration in seconds |
| author_id | integer ID of the contact who requested the downtime |
| comment | string Comment of the downtime |
| with_services | boolean Indicates whether we should add the downtime on the host-related services |
Command Sent
Forbidden
Internal Server Error
{- "start_time": "2020-01-03T10:16:00Z",
- "end_time": "2020-01-03T10:16:00Z",
- "is_fixed": true,
- "duration": 3600,
- "author_id": 3,
- "comment": "Downtime set by admin",
- "with_services": true
}{- "code": 403,
- "message": "You are not authorized to access this resource"
}List all downtimes of a service.
The available parameters to search / sort_by are:
| host_id required | integer <int64> Example: 12 ID of the host |
| service_id required | integer <int64> Example: 5 ID of the service |
| search | object Example: search={"host.name":"Central"} Retrieve only data matching the defined search value |
| limit | integer >= 1 Default: 10 Example: limit=20 Number of items per pages |
| page | integer >= 1 Default: 1 Example: page=4 Number of the requested page |
| sort_by | object Example: sort_by={"host.name":"ASC"} Sort the resulted data by its properties |
OK
Forbidden
Internal Server Error
{- "result": [
- {
- "id": 329,
- "author_id": 3,
- "host_id": 12,
- "comment": "Downtime set by admin",
- "duration": 7200,
- "entry_time": "2020-01-03T10:16:02Z",
- "start_time": "2020-01-03T10:16:02Z",
- "end_time": "2020-01-03T10:16:02Z",
- "deletion_time": null,
- "actual_start_time": "2020-01-03T10:16:02Z",
- "actual_end_time": null,
- "is_started": true,
- "is_cancelled": false,
- "is_fixed": true,
- "service_id": 5
}
], - "meta": {
- "page": 1,
- "limit": 10,
- "search": { },
- "sort_by": { },
- "total": 1
}
}Add a downtime on a service.
| host_id required | integer <int64> Example: 12 ID of the host |
| service_id required | integer <int64> Example: 5 ID of the service |
| start_time | string <date-time> Scheduled start date of the downtime (ISO8601) |
| end_time | string <date-time> Scheduled end date of the downtime (ISO8601) |
| is_fixed | boolean Indicates whether the downtime is fixed |
| duration | integer Downtime duration in seconds |
| author_id | integer ID of the contact who requested the downtime |
| comment | string Comment of the downtime |
Command Sent
Forbidden
Internal Server Error
{- "start_time": "2020-01-03T10:16:00Z",
- "end_time": "2020-01-03T10:16:00Z",
- "is_fixed": true,
- "duration": 3600,
- "author_id": 3,
- "comment": "Downtime set by admin"
}{- "code": 403,
- "message": "You are not authorized to access this resource"
}