How to check Services Health on OCM v10 using API

Overview

You can retrieve the health status of all services via the Fusion Console API endpoint:

The healthStatus field in the response indicates the operational state of each service.

Prerequisites

• Access to the CM10 Fusion Console (web interface or API endpoint).

• A valid Bearer token for authentication (obtained via login API, refer to https://www.opswat.com/docs/cm/developer-guidelines/authentication).

• The base URL of your CM10 environment

Step-by-Step: Checking Health Status via API

1. Obtain Authentication Token: obtained via login API, refer to https://www.opswat.com/docs/cm/developer-guidelines/authentication

2. Call the Services API Endpoint: Use a GET request to fetch the list of services.

Endpoint

• page=1 & limit=25: Pagination (adjust as needed; increase limit for more results).

• sort=lastSeen&order=asc: Optional sorting (by last seen time).

Headers (required):

Example using Python

Alternative using curl:

Example JSON Response

In this example, one of the MetaDefender Core "healthStatus" is "Operational".

Best practice: Alert/monitor when healthStatus is anything other than Operational

The healthStatus value indicates the current operational state of a service. Below is a breakdown of all possible Health Status types and what each one means.