Status API

The Status API allows to retrieve certain status information (e.g. availability, healthiness) of the BPC.

Method Endpoint

Method	Endpoint
`GET`	`/cxf/bpc-core/status`
Description Get the status of the local BPC server.
Returns Depending on the user session more or less data is returned as JSON. HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights Can be used without a user session.
`GET`	`/cxf/bpc-core/status/health`
Description Get the following health infos in one call: status of loaded bundles maintenance mode status license status OpenSearch status Identity-Provider status (if endpoint is configured)
Returns HTTP Status Code `200` : All health status are fine `503` : At least one health status is not fine
Required Access Rights Can be used without a user session.
`GET`	`/cxf/bpc-core/status/bpc`
Description Get the status of all loaded BPC modules/bundles.
Returns HTTP Status Code `200` : Karaf is running and all BPC modules are not in state 'Resolved' and not in state 'Failure` `503` : At least one BPC module is in state 'Resolved' or 'Failure'
Required Access Rights Can be used without a user session.
`GET`	`/cxf/bpc-core/status/maintenance`
Description Get the maintenance mode status.
Returns HTTP Status Code `200` : BPC is not in maintenance mode `503` : BPC is in maintenance mode
Required Access Rights Can be used without a user session.
`GET`	`/cxf/bpc-core/status/identity-provider`
Description Get the health status of the identity provider. The idp health endpoint can be configured by the setting `identityProvider_healthEndpoint`. If the setting is not configured, this endpoint signals success.
Returns HTTP Status Code `200` : The identity provider is healthy (or the idp health endpoint is not configured) `503` : The identity provider is not healthy
Required Access Rights Can be used without a user session.
`GET`	`/cxf/bpc-core/status/license`
Description Get the license status.
Returns HTTP Status Code `200` : BPC license is valid `503` : BPC license is invalid
Required Access Rights Can be used without a user session.
`GET`	`/cxf/bpc-core/status/opensearch`
Description Get the OpenSearch status.
Returns HTTP Status Code `200` : OK `503` : The OpenSearch Service is not healthy due to one of the following reasons: No connection to OpenSearch No nodes available Cluster health status is 'red'
Required Access Rights Can be used without a user session.
`GET`	`/cxf/bpc-core/status/sessions`
Description Get a list of all sessions.
Returns The requested data as JSON. HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights The logged in user or API Key must have either the following role or right. Right : `getSessionStatus`
`GET`	`/cxf/bpc-core/status/clustermaster`
Description To check if this is the BPC master server.
Returns HTTP Status Code `200` : BPC is the master server `503` : BPC is not the master server
Required Access Rights Can be used without a user session.

GET

/cxf/bpc-core/status

Description

Get the status of the local BPC server.

Returns

Depending on the user session more or less data is returned as JSON.

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

Can be used without a user session.

GET

/cxf/bpc-core/status/health

Description

Get the following health infos in one call:

status of loaded bundles
maintenance mode status
license status
OpenSearch status
Identity-Provider status (if endpoint is configured)

Returns

HTTP Status Code

200 : All health status are fine
503 : At least one health status is not fine

Required Access Rights

Can be used without a user session.

GET

/cxf/bpc-core/status/bpc

Description

Get the status of all loaded BPC modules/bundles.

Returns

HTTP Status Code

200 : Karaf is running and all BPC modules are not in state 'Resolved' and not in state 'Failure`
503 : At least one BPC module is in state 'Resolved' or 'Failure'

Required Access Rights

Can be used without a user session.

GET

/cxf/bpc-core/status/maintenance

Description

Get the maintenance mode status.

Returns

HTTP Status Code

200 : BPC is not in maintenance mode
503 : BPC is in maintenance mode

Required Access Rights

Can be used without a user session.

GET

/cxf/bpc-core/status/identity-provider

Description

Get the health status of the identity provider. The idp health endpoint can be configured by the setting identityProvider_healthEndpoint. If the setting is not configured, this endpoint signals success.

Returns

HTTP Status Code

200 : The identity provider is healthy (or the idp health endpoint is not configured)
503 : The identity provider is not healthy

Required Access Rights

Can be used without a user session.

GET

/cxf/bpc-core/status/license

Description

Get the license status.

Returns

HTTP Status Code

200 : BPC license is valid
503 : BPC license is invalid

Required Access Rights

Can be used without a user session.

GET

/cxf/bpc-core/status/opensearch

Description

Get the OpenSearch status.

Returns

HTTP Status Code

200 : OK
503 : The OpenSearch Service is not healthy due to one of the following reasons:
- No connection to OpenSearch
- No nodes available
- Cluster health status is 'red'

Required Access Rights

Can be used without a user session.

GET

/cxf/bpc-core/status/sessions

Description

Get a list of all sessions.

Returns

The requested data as JSON.

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

Right : getSessionStatus

GET

/cxf/bpc-core/status/clustermaster

Description

To check if this is the BPC master server.

Returns

HTTP Status Code

200 : BPC is the master server
503 : BPC is not the master server

Required Access Rights

Can be used without a user session.