Skip to content
logoBack to home screen

Available Services

In this section the available services are listed and the possible ways to call this services are explained.

Available services

General Checks

ServiceDescription
RunCheckBundlesRuns checks on the current node (local).
RunAimedCheckBundlesRuns checks on a dedicated node.
RunDistributedCheckBundlesRuns checks on all available nodes in a distributed environment.

Each of the above mentioned services can be further qualified with filters. For filtering see Check Bundle Filters

Link to base request see JavaDoc.

Vitality Checks

RunVitalityChecks runs all checks of coverage vitality without requiring permission. The aggregation order can be configured via aggregateBy. Vitality checks do not support further filtering.

Prepared DDRA Endpoints

There are following DDRA endpoints available:

ServiceDescription
/api/v1/healthzExecutes vitality checks and returns results in the old format of the formerly known HealthzServlet in JSON format.
/api/v1/checkVitalityExecutes vitality checks and returns results in rendered HTML format.
/api/v1/checkExecutes checks and returns results in rendered HTML format.
/api/v1/checkDistributedExecutes checks distributed via Multicast and returns results in rendered HTML format.
/api/v1/checkAimedExecutes checks on specified nodeId and returns results in rendered HTML format.
/api/v1/checkPlatformExecutes checks on specified nodeId and returns results in rendered HTML format.

Examples how to execute checks via DDRA see Executing Checks via REST

What's Next?

As we are familiar with available services and how they are called, we are ready to proceed to Implementation of Checks.