API docs by Redocly

Centreon Map API (latest)

Online documentation

mx-view-controller

getMxView

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
viewId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

updateMxView

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
viewId
required
integer <int64>
Request Body schema: application/xml
required
dx
number <float>
dy
number <float>
background
string
grid
integer <int32>
gridSize
integer <int32>
guides
integer <int32>
tooltips
integer <int32>
connect
integer <int32>
arrows
integer <int32>
fold
integer <int32>
page
integer <int32>
pageScale
integer <int32>
pageWidth
integer <int32>
pageHeight
integer <int32>
scale
number <float>
scrollLeft
number <float>
scrollTop
number <float>
marginLeft
number <float>
marginTop
number <float>
object (MxRoot)

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

map-rest

getAllMaps

Authorizations:
bearerAuthCentreonHeaderAuth
query Parameters
filter[hidden]
boolean
filter[name]
string
filter[ids]
Array of integers <int64> [ items <int64 > ]
Default: ""
filterOut[ids]
Array of integers <int64> [ items <int64 > ]
Default: ""
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

map-rest-controller

updateMap

Authorizations:
bearerAuthCentreonHeaderAuth
Request Body schema: application/json
required
id
integer <int64>
name
string
description
string
object (ImageDto)
locked
boolean
hidden
boolean
viewId
integer <int64>
privilege
string
Enum: "OWNER" "EDITOR" "VIEWER" "NONE"
object (Status)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "image": {
    },
  • "locked": true,
  • "hidden": true,
  • "viewId": 0,
  • "privilege": "OWNER",
  • "mapStatus": {
    }
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

createMap

Authorizations:
bearerAuthCentreonHeaderAuth
Request Body schema: application/json
required
id
integer <int64>
name
string
description
string
object (ImageDto)
locked
boolean
hidden
boolean
viewId
integer <int64>
privilege
string
Enum: "OWNER" "EDITOR" "VIEWER" "NONE"
object (Status)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "image": {
    },
  • "locked": true,
  • "hidden": true,
  • "viewId": 0,
  • "privilege": "OWNER",
  • "mapStatus": {
    }
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

importMap

Authorizations:
bearerAuthCentreonHeaderAuth
Request Body schema: application/json
required
id
integer <int64>
name
string
description
string
imageUrl
string
locked
boolean
hidden
boolean
object (ViewDetailDto)
object
aclGroupCreators
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "imageUrl": "string",
  • "locked": true,
  • "hidden": true,
  • "view": {
    },
  • "accessRules": {
    },
  • "aclGroupCreators": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

duplicateMap

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

readMap

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

exportMap

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

deleteMap

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

view-rest-controller

updateView

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
Request Body schema: application/json
required
id
integer <int64>
latitude
number <float>
longitude
number <float>
mapboxStyle
string
object (Perspective)
background
string
scale
number <float>
scrollLeft
number <float>
scrollTop
number <float>
marginTop
number <float>
marginLeft
number <float>
Array of objects (ResourceElement)
Array of Gauge (object) or LineChart (object) or LinkLegend (object) or Output (object) or PieChart (object) or Process (object)
Array of objects (Shape)
Array of Image (object) or Url (object)
Array of MetricLink (object) or SimpleLink (object) or StatusLink (object)
Array of objects (Container)
object (Status)
resourcesAckFlag
boolean
resourcesDownFlag
boolean
object (Status)
containersAckFlag
boolean
containersDownFlag
boolean
object (Status)
object (Status)
empty
boolean
object (Status)
dy
number <float>
dx
number <float>
inheritedDownFlag
boolean
inheritedAckFlag
boolean
geo
boolean
ackFlag
boolean
downFlag
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "mapboxStyle": "string",
  • "perspective": {
    },
  • "background": "string",
  • "scale": 0.1,
  • "scrollLeft": 0.1,
  • "scrollTop": 0.1,
  • "marginTop": 0.1,
  • "marginLeft": 0.1,
  • "resources": [
    ],
  • "widgets": [
    ],
  • "shapes": [
    ],
  • "media": [
    ],
  • "links": [
    ],
  • "containers": [
    ],
  • "resourcesStatus": {
    },
  • "resourcesAckFlag": true,
  • "resourcesDownFlag": true,
  • "containersStatus": {
    },
  • "containersAckFlag": true,
  • "containersDownFlag": true,
  • "widgetsStatus": {
    },
  • "linksStatus": {
    },
  • "empty": true,
  • "status": {
    },
  • "dy": 0.1,
  • "dx": 0.1,
  • "inheritedDownFlag": true,
  • "inheritedAckFlag": true,
  • "geo": true,
  • "ackFlag": true,
  • "downFlag": true
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

updateViewPerspective

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
viewId
required
integer <int64>
mapId
required
integer <int64>
Request Body schema: application/json
required
zoomperspective
number <float>
yperspective
number <float>
xperspective
number <float>

Responses

Request samples

Content type
application/json
{
  • "zoomperspective": 0.1,
  • "yperspective": 0.1,
  • "xperspective": 0.1
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getViewById

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
viewId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getBreadcrumb

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
viewId
required
integer <int64>
query Parameters
elementId
integer <int64>
resourceId
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

geo-view-rest-end-point

retrieveGeoView

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

updateGeoView

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
id
integer <int64>
name
string
object (GeoCoordinate)
zoom
number <float>
markerClustering
boolean
htHostGroupIds
Array of integers <int64> [ items <int64 > ]
baBusinessViewIds
Array of integers <int64> [ items <int64 > ]
dataLayerIds
Array of integers <int64> [ items <int64 > ]
hostGroupIds
Array of integers <int64> [ items <int64 > ]
privilege
string
Enum: "OWNER" "EDITOR" "VIEWER" "NONE"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "position": {
    },
  • "zoom": 0.1,
  • "markerClustering": true,
  • "htHostGroupIds": [
    ],
  • "baBusinessViewIds": [
    ],
  • "dataLayerIds": [
    ],
  • "hostGroupIds": [
    ],
  • "privilege": "OWNER"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

deleteGeoView

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

createGeoView

Authorizations:
bearerAuthCentreonHeaderAuth
Request Body schema: application/json
required
id
integer <int64>
name
string
object (GeoCoordinate)
zoom
number <float>
markerClustering
boolean
htHostGroupIds
Array of integers <int64> [ items <int64 > ]
baBusinessViewIds
Array of integers <int64> [ items <int64 > ]
dataLayerIds
Array of integers <int64> [ items <int64 > ]
hostGroupIds
Array of integers <int64> [ items <int64 > ]
privilege
string
Enum: "OWNER" "EDITOR" "VIEWER" "NONE"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "position": {
    },
  • "zoom": 0.1,
  • "markerClustering": true,
  • "htHostGroupIds": [
    ],
  • "baBusinessViewIds": [
    ],
  • "dataLayerIds": [
    ],
  • "hostGroupIds": [
    ],
  • "privilege": "OWNER"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

createGeoView_1

Authorizations:
bearerAuthCentreonHeaderAuth
Request Body schema: application/json
required
id
integer <int64>
name
string
object (GeoCoordinate)
zoom
number <float>
markerClustering
boolean
htHostGroupIds
Array of integers <int64> [ items <int64 > ]
baBusinessViewIds
Array of integers <int64> [ items <int64 > ]
dataLayerIds
Array of integers <int64> [ items <int64 > ]
hostGroupIds
Array of integers <int64> [ items <int64 > ]
privilege
string
Enum: "OWNER" "EDITOR" "VIEWER" "NONE"

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "position": {
    },
  • "zoom": 0.1,
  • "markerClustering": true,
  • "htHostGroupIds": [
    ],
  • "baBusinessViewIds": [
    ],
  • "dataLayerIds": [
    ],
  • "hostGroupIds": [
    ],
  • "privilege": "OWNER"
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

retrieveGeoViews

Authorizations:
bearerAuthCentreonHeaderAuth
query Parameters
filter[name]
string
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

geo-view-resource-rest-controller

getGeoViewHostGroup

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
geoViewId
required
integer <int64>
hostGroupId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getGeoViewHostGroupHosts

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
geoViewId
required
integer <int64>
hostGroupId
required
integer <int64>
query Parameters
filter[name][]
Array of strings
Default: ""
filter[status][]
Array of strings
Default: ""
Items Enum: "DOWN" "UNREACHABLE" "PENDING" "UP" "NA"
orderBy[]
Array of strings
Default: ""
offset
integer <int64>
Default: 0
count
integer <int64>
Default: 25

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getGeoViewBusinessActivities

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
geoViewId
required
integer <int64>
businessViewId
required
integer <int64>
query Parameters
filter[name][]
Array of strings
Default: ""
filter[status][]
Array of strings
Default: ""
Items Enum: "CRITICAL" "WARNING" "UNKNOWN" "OK" "PENDING" "NA"
orderBy[]
Array of strings
Default: ""
offset
integer <int64>
Default: 0
count
integer <int64>
Default: 25

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getGeoViewMaps

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
geoViewId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

acl-group-rest-end-controller

getAclGroupsAndRoles

Authorizations:
bearerAuthCentreonHeaderAuth

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

updateAclGroupsAndRoles

Authorizations:
bearerAuthCentreonHeaderAuth
Request Body schema: application/json
required
Array
name
string
id
integer <int64>
is_creator
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getAclGroupsAndPrivileges

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

updateAclGroupsAndPrivileges

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
Request Body schema: application/json
required
Array
id
integer <int64>
aclGroupId
integer <int64>
name
string
privilege
string
Enum: "OWNER" "EDITOR" "VIEWER" "NONE"
mapId
integer <int64>
geoId
integer <int64>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getAclGroupsAndPrivilegesGeo

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
geoId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

updateAclGroupsAndPrivilegesGeo

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
geoId
required
integer <int64>
Request Body schema: application/json
required
Array
id
integer <int64>
aclGroupId
integer <int64>
name
string
privilege
string
Enum: "OWNER" "EDITOR" "VIEWER" "NONE"
mapId
integer <int64>
geoId
integer <int64>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

map-resource-rest-controller

executeCommand

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
hostId
required
integer <int64>
serviceId
required
integer <int64>
query Parameters
forced
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMapHost

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMapHostServices

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
hostId
required
integer <int64>
query Parameters
filter[name][]
Array of strings
Default: ""
filter[status][]
Array of strings
Default: ""
Items Enum: "CRITICAL" "WARNING" "UNKNOWN" "OK" "PENDING" "NA"
orderBy[]
Array of strings
Default: ""
offset
integer <int64>
Default: 0
count
integer <int64>
Default: 25

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMapServiceById

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
hostId
required
integer <int64>
serviceId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMapMetaService

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMapBusinessActivity

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMapKpis

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
baId
required
integer <int64>
query Parameters
filter[status][]
Array of strings
Default: ""
Items Enum: "CRITICAL" "WARNING" "UNKNOWN" "OK" "PENDING" "NA"
orderBy[]
Array of strings
Default: ""
offset
integer <int64>
Default: 0
count
integer <int64>
Default: 25

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMapServiceGroupStatistics

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMapHostGroupStatistics

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getServiceGraph

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
hostId
required
integer <int64>
serviceId
required
integer <int64>
query Parameters
startDate
required
integer <int32>
endDate
required
integer <int32>
soughtLabels[]
Array of strings unique

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

getMetaServiceGraph

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
id
required
integer <int64>
query Parameters
startDate
required
integer <int32>
endDate
required
integer <int32>
soughtLabels[]
Array of strings unique

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

studio-admin-rest-controller

getAllStudioAdmins

Authorizations:
bearerAuthCentreonHeaderAuth

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

createStudioAdmin

Authorizations:
bearerAuthCentreonHeaderAuth
Request Body schema: application/json
required
aclGroupId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "aclGroupId": 0
}

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

deleteStudioAdmin

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
aclGroupId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

resource-reloader-rest-end-controller

reloadResources

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
delay
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}

resource-element-rest-controller

getChildrenAsView

Authorizations:
bearerAuthCentreonHeaderAuth
path Parameters
mapId
required
integer <int64>
type
required
string
Enum: "HOST" "HOST_GROUP" "SERVICE" "SERVICE_GROUP" "META_SERVICE" "BUSINESS_ACTIVITY" "BUSINESS_ACTIVITY_GROUP" "KPI"
resourceId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "Bad Request"
}