BA real time informationΒΆ

All monitoring information regarding Business Activites (BA) are available through the Centreon API. The BA list is ordered by impact.

Using GET method and the URL below:

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

Header:

key

value

Content-Type

application/json

centreon-auth-token

the value of authToken you got on the authentication response

Parameters

You can pass a list of parameters in order to select the data you want.

Parameters

values

ba_id

filter on ba id

search

filter pattern on business activity name

business_view

filter pattern on business view name

status

filter on ba status (ok, warning, critical, unknown) multiple statuses can be set separated by commas

limit

number of lines you want

number

page number

Using GET method and the URL below:

api.domain.tld/centreon/api/index.php?object=centreon_bam_ba_realtime&action=list&status=ok&number=0&limit=2

Response

[
  {
    "id": "49",
    "name": "Africa Office Availability",
    "description": "Africa Office Availability",
    "level_w": "12",
    "level_c": "12",
    "current_level": "100",
    "acknowledged": "0",
    "last_state_change": "1518663959",
    "current_status": "0",
    "in_downtime": "0",
    "kpis": [
        "372",
        "373",
        "401",
        "402"
    ]
  },
  {
    "id": "50",
    "name": "Asia Office Availability",
    "description": "Asia Office Availability",
    "level_w": "12",
    "level_c": "12",
    "current_level": "100",
    "acknowledged": "0",
    "last_state_change": "1519029327",
    "current_status": "0",
    "in_downtime": "0",
    "kpis": [
        "374",
        "375",
        "376"
    ]
  }
]

Notes

  • current_status : 0 = ok, 1 = warning, 2 = critical, 3 = unknown

  • current_impact : imapct on linked BA in %

  • number : page number (first page is 0)

  • limit : page limit (default: 30)