Centreon BAM API (latest)

URL: https://www.centreon.com

You can contact us on our community platform The Watch

Authentication

There are two modes of authentication:

By token: after identification with your login credentials
By cookie: by reusing a valid session ID

Business Views

List the business views

Available since : 20.10.0

Returns all business views.

The available parameters to search / sort_by are:

id
name
description
is_enabled

Authorizations:

TokenCookie

query Parameters

limit	integer >= 1 Default: 10 Example: limit=20 Number of items per page
page	integer >= 1 Default: 1 Example: page=4 Number of the requested page
search	string Retrieve only data matching the defined search value. A simple search can be done like in the following example `search={"host.name":"Central"}` A complex search can be done with aggregators and operators. Available search aggregators are: `$or` `$and` Available search operators are: `$eq` → equal `$neq` → not equal `$lt` → less than `$le` → less or equal than `$gt` → greater than `$ge` → greater or equal than `$lk` → like `$nk` → not like `$in` → in `$ni` → not in `$rg` → regex Examples without nested aggregators: `search={ "$or":[ {"host.name":{"$eq":"name_1"}}, {"host.name":{"$eq":"name_2"}} ] }` `search={ "$and":[ {"host.address":{"$rg":"^10\.0\.0\.\d+$"}}, {"host.name":{"$lk":"fr%"}} ] }` Example with nested aggregators: `search={ "$or":[ { "$and":[ {"host.address":{"$rg":"^10\.0\.0\.\d+$"}}, {"host.name":{"$lk":"fr%"}} ] }, { "$and":[ {"host.address":{"$rg":"^192\.168\.0\.\d+$"}}, {"host.name":{"$lk":"us%"}} ] } ] }`
sort_by	string Example: sort_by={"host.name":"ASC"} Sort the resulting data by its properties

Responses

Response samples

200
403
500

Content type

application/json

{"result": [{"id": 1,
"name": "BV1",
"description": "bv 1",
"is_enabled": true
}
],
"meta": {"page": 1,
"limit": 10,
"search": { },
"sort_by": { },
"total": 1
}
}

List Business Views from the real time

Available since : 24.10.0

Returns the list of business views from real time context

The available parameters to search / sort_by are:

id
name

Authorizations:

TokenCookie

Responses

Response samples

200
403
500

Content type

application/json

{"result": [{"id": 1,
"name": "Applications - France"
}
],
"meta": {"page": 1,
"limit": 10,
"search": { },
"sort_by": { },
"total": 1
}
}

Business Activities

List the business activities

Available since : 20.10.0

Returns all business activities.

The available parameters to search / sort_by are:

id
name
description
is_enabled

Authorizations:

TokenCookie

query Parameters

limit	integer >= 1 Default: 10 Example: limit=20 Number of items per page
page	integer >= 1 Default: 1 Example: page=4 Number of the requested page
search	string Retrieve only data matching the defined search value. A simple search can be done like in the following example `search={"host.name":"Central"}` A complex search can be done with aggregators and operators. Available search aggregators are: `$or` `$and` Available search operators are: `$eq` → equal `$neq` → not equal `$lt` → less than `$le` → less or equal than `$gt` → greater than `$ge` → greater or equal than `$lk` → like `$nk` → not like `$in` → in `$ni` → not in `$rg` → regex Examples without nested aggregators: `search={ "$or":[ {"host.name":{"$eq":"name_1"}}, {"host.name":{"$eq":"name_2"}} ] }` `search={ "$and":[ {"host.address":{"$rg":"^10\.0\.0\.\d+$"}}, {"host.name":{"$lk":"fr%"}} ] }` Example with nested aggregators: `search={ "$or":[ { "$and":[ {"host.address":{"$rg":"^10\.0\.0\.\d+$"}}, {"host.name":{"$lk":"fr%"}} ] }, { "$and":[ {"host.address":{"$rg":"^192\.168\.0\.\d+$"}}, {"host.name":{"$lk":"us%"}} ] } ] }`
sort_by	string Example: sort_by={"host.name":"ASC"} Sort the resulting data by its properties

Responses

Response samples

200
403
500

Content type

application/json

{"result": [{"id": 1,
"name": "BA1",
"description": "ba 1",
"is_enabled": true,
"level_warning": 80,
"level_critical": 60,
"calculation_method": {"id": 4,
"name": "Ratio number",
"isPercentage": false
},
"icon": {"name": "linux.png",
"url": "/centreon/img/media/ppm/linux.png"
}
}
],
"meta": {"page": 1,
"limit": 10,
"search": { },
"sort_by": { },
"total": 1
}
}

Delete a business activity

Authorizations:

TokenCookie

path Parameters

id

required

integer >= 1

Example: 1

Business activity ID

Responses

Response samples

403
404
500

Content type

application/json

{"code": 403,
"message": "You are not authorized to access this resource"
}

Find a business activity

Authorizations:

TokenCookie

path Parameters

id

required

integer >= 1

Example: 1

Business activity ID

Responses

Response samples

200
403
404
500

Content type

application/json

{"id": 1,
"name": "BA1",
"is_activated": true,
"description": "ba 1",
"icon": {"id": 1,
"name": "linux.png",
"url": "/centreon/img/media/ppm/linux.png"
},
"business_views": [{"id": 1,
"name": "BV-name"
}
],
"monitoring_servers": [{"id": 1,
"name": "monitoring-server-name"
}
],
"geo_coordinates": "48.10,12.5",
"map_view": "map-view-name",
"notification": {"is_activated": true,
"options": 12,
"interval": 5,
"timeperiod": {"id": 1,
"name": "24x7"
},
"first_delay": 5,
"recovery_delay": 5,
"contact_groups": [{"id": 1,
"name": "Supervisor"
}
],
"escalations": [{"id": 1,
"name": "escalation-name"
}
]
},
"reporting": {"service_level_agreement": {"percentage": 80,
"duration": 90
},
"service_level_objective": {"percentage": 90,
"duration": 120
},
"timeperiods": {"default": {"id": 1,
"name": "24x7"
},
"extra": [{"id": 1,
"name": "24x7"
}
]
}
},
"event_handler": {"is_activated": true,
"command": {"id": 1,
"name": "command-name"
}
},
"indicator": {"calculation_method": 1,
"downtime_option": 1,
"indicators": [{"uuid": "h13-s56",
"name": "Centreon-Server - Ping"
}
]
}
}

List a business activity KPI's tree

Available since : 24.04.0

Returns A Business Activity with its KPIs.

Authorizations:

TokenCookie

path Parameters

id

required

integer >= 1

Example: 1

Business activity ID

Responses

Response samples

200
403
404
500

Content type

application/json

{"id": 0,
"name": "string",
"status": 0,
"type": "Business Activity",
"calculation_method": {"id": 0,
"name": "string",
"is_percentage": true,
"value": 0
},
"indicators": [{"type": "Service",
"id": 0,
"name": "string",
"status": 0,
"host_id": 0,
"host_name": "string",
"calculation_method": {"id": 0,
"name": "string",
"is_percentage": true,
"value": 0
},
"indicators": [ ]
}
]
}

List Business Activities from the real time

Available since : 24.10.0

Returns the list of Business Activities from the real time context

The available parameters to search / sort_by are:

id
name
status
business_view.name

Authorizations:

TokenCookie

Responses

Response samples

200
403
500

Content type

application/json

{"result": [{"id": 1,
"name": "Applications - France",
"status": {"code": 0,
"name": "OK",
"severity_code": 1
},
"business_views": {"id": 1,
"name": "Business-View1"
}
}
],
"meta": {"page": 1,
"limit": 10,
"search": { },
"sort_by": { },
"total": 1
}
}

List Business Activities statuses from the real time

Available since : 24.10.0

Returns the list of Business Activities statuses from the real time context

The available parameters to search / sort_by are:

id
name
status
business_view.name

Authorizations:

TokenCookie

Responses

Response samples

200
403
500

Content type

application/json

{"critical": {"total": 0
},
"unknown": {"total": 0
},
"ok": {"total": 0
},
"down": {"total": 0
},
"pending": {"total": 0
},
"total": 0
}

Get Business Activity detail from real time context

Available since : 24.10.0

Returns the detail of a Business Activity from the real time context with associated indicators

Authorizations:

TokenCookie

Responses

Response samples

200
403
404
500

Content type

application/json

{"id": 1,
"name": "string",
"status": {"name": "OK",
"code": 0,
"severity_code": 5
},
"infrastructure_view": "Geoview1",
"calculation_method": {"id": 1,
"name": "Ratio",
"is_percentage": false,
"critical_threshold": 70,
"health": 70,
"warning_threshold": 80
},
"current_level": 0,
"inherit_kpi_downtimes": 1,
"indicators": [{"id": 1,
"type": "Service",
"name": "Ping",
"status": {"code": 0,
"name": "OK",
"severity_code": 1
},
"impact": {"warning": 0,
"critical": 0,
"unknown": 0
},
"resource": {"id": 1,
"name": "Ping",
"parent_id": 10,
"parent_name": "Central-Server"
}
}
]
}

Get impacting indicators of a Business Activity from real time context

Available since : 24.10.0

Returns the impacting indicators of a Business Activity from the real time context

Authorizations:

TokenCookie

query Parameters

start required	string <date-time> Example: start=2024-09-10T12:45:00.000Z Start date of indicator timeline
end required	string <date-time> Example: end=2024-09-10T13:45:00.000Z End date of indicator timeline

Responses

Response samples

200
403
404
500

Content type

application/json

{"result": [[{"id": 3,
"type": "Service",
"name": "testba1",
"impact": 75,
"details": "(Execute command failed)",
"is_in_downtime": false,
"is_acknowledged": false,
"status": {"code": 3,
"name": "UNKNOWN",
"severity_code": 3
},
"business_activity": {"id": 2,
"name": "testba2"
},
"resource": {"id": 1,
"name": "testba1",
"parent_id": null,
"parent_name": null
}
}
]
],
"meta": {"page": 1,
"limit": 10,
"search": { },
"sort_by": { },
"total": 1
}
}

Get Business Activity's timeline

Available since : 24.10.0

Returns the timeline of a Business Activity status

Authorizations:

TokenCookie

Responses

Response samples

200
403
404
500

Content type

application/json

{"id": 1,
"name": "Marketing Web App",
"timeline": [{"critical": {"start": "2023-10-01T12:00:00+02:00",
"end": "2023-10-01T12:30:00+02:00"
},
"unknown": {"start": "2023-10-01T13:30:00+02:00",
"end": "2023-10-01T14:00:00+02:00"
},
"ok": {"start": "2023-10-01T14:00:00+02:00",
"end": "2023-10-01T14:30:00+02:00"
},
"down": {"start": "2023-10-01T14:30:00+02:00",
"end": "2023-10-01T15:00:00+02:00"
},
"pending": {"start": "2023-10-01T15:00:00+02:00",
"end": "2023-10-01T15:30:00+02:00"
}
}
]
}

Indicators

List all available indicators

Available since : 23.04.0

Returns all available indicators.

The available parameters to search / sort_by are:

name

Authorizations:

TokenCookie

query Parameters

limit	integer >= 1 Default: 10 Example: limit=20 Number of items per page
page	integer >= 1 Default: 1 Example: page=4 Number of the requested page
search	string Retrieve only data matching the defined search value. A simple search can be done like in the following example `search={"host.name":"Central"}` A complex search can be done with aggregators and operators. Available search aggregators are: `$or` `$and` Available search operators are: `$eq` → equal `$neq` → not equal `$lt` → less than `$le` → less or equal than `$gt` → greater than `$ge` → greater or equal than `$lk` → like `$nk` → not like `$in` → in `$ni` → not in `$rg` → regex Examples without nested aggregators: `search={ "$or":[ {"host.name":{"$eq":"name_1"}}, {"host.name":{"$eq":"name_2"}} ] }` `search={ "$and":[ {"host.address":{"$rg":"^10\.0\.0\.\d+$"}}, {"host.name":{"$lk":"fr%"}} ] }` Example with nested aggregators: `search={ "$or":[ { "$and":[ {"host.address":{"$rg":"^10\.0\.0\.\d+$"}}, {"host.name":{"$lk":"fr%"}} ] }, { "$and":[ {"host.address":{"$rg":"^192\.168\.0\.\d+$"}}, {"host.name":{"$lk":"us%"}} ] } ] }`
sort_by	string Example: sort_by={"host.name":"ASC"} Sort the resulting data by its properties

Responses

Response samples

200
403
500

Content type

application/json

{"result": [{"uuid": "h10-s20",
"name": "Centreon-Server - Ping",
"type": "service",
"short_type": "s",
"enabled": true,
"resource": {"id": 20,
"parent_id": 10
}
}
],
"meta": {"page": 1,
"limit": 10,
"search": { },
"sort_by": { },
"total": 1
}
}

List indicators from the real time

Available since : 24.10.0

Returns the list of indicators linked to Business Activities from the real time context

The available parameters to search / sort_by are:

name
status
business_activity.name
business_view.name

Authorizations:

TokenCookie

Responses

Response samples

200
403
500

Content type

application/json

{"result": [{"id": 1,
"type": "Service",
"name": "Ping",
"impact": 50,
"details": "(Execute command failed)\\n",
"is_in_downtime": false,
"is_acknowledged": false,
"status": {"code": 0,
"name": "OK",
"severity_code": 1
},
"business_activity": {"id": 1,
"name": "BA1"
},
"resource": {"id": 1,
"name": "Ping",
"parent_id": 10,
"parent_name": "Central-Server"
}
}
],
"meta": {"page": 1,
"limit": 10,
"search": { },
"sort_by": { },
"total": 1
}
}

List indicator statuses from the real time

Available since : 24.10.0

Returns the list of indicator statuses linked to Business Activities from the real time context

The available parameters to search / sort_by are:

name
status
business_activity.name

Authorizations:

TokenCookie

Responses

Response samples

200
403
500

Content type

application/json

{"ok": {"total": 0
},
"warning": {"total": 0
},
"critical": {"total": 0
},
"unknown": {"total": 0
},
"pending": {"total": 0
},
"total": 0
}

Get boolean rule detailed information from real time context

Available since : 24.10.0

Returns the detailed information of boolean rule from the real time context

Authorizations:

TokenCookie

Responses

Response samples

200
403
404
500

Content type

application/json

{"id": 1,
"name": "boolean-rule-1",
"status": {"code": 0,
"name": "OK",
"severity_code": 1
},
"is_impacting_when_expression_true": true,
"expression_status": true
}

Impacts

List all impacts

Returns all impacts configurations.

Authorizations:

TokenCookie

query Parameters

page	integer >= 1 Default: 1 Example: page=4 Number of the requested page
limit	integer >= 1 Default: 10 Example: limit=20 Number of items per page

Responses

Response samples

200
403
500

Content type

application/json

{"status": true,
"result": {"entitities": [{"id": 1,
"impact": 75,
"color": "#ff0000",
"name": "Blocking"
}
]
},
"pagination": {"total": 5,
"offset": 0,
"limit": 10
}
}