ConnectCloud Developers

Get the state of every module (no authentication)

GET /api/status/v1/modules

Module: Status · operationId: getModuleStatus · Tag: Status · Auth: none

Returns the latest probe result of every module, in a fixed order. Poll it at most every 15 seconds; the state does not change faster.

Responses

  • 200 The state of every module. (application/json)
  • 429 Too many requests from this client IP. (application/json)

Fields of the 200 answer:

  • generatedAt (string (date-time), required)
  • modules (array of ModuleStatus, required)
    • module (string, required): Module name as used in the API prefix /api/<module>.
    • status (State, required): State of a module (see the table in the description). (one of up, degraded, down, unknown)
    • checkedAt (string (date-time)): Time of the latest probe; missing while the state is unknown.
    • since (string (date-time)): When the module entered its current state (as seen by the status service).
  • status (State, required): State of a module (see the table in the description). (one of up, degraded, down, unknown)

Example 200 answer:

{
  "generatedAt": "2026-10-28T10:00:15Z",
  "modules": [
    {
      "checkedAt": "2026-10-28T10:00:15Z",
      "module": "hr",
      "since": "2026-10-27T06:12:00Z",
      "status": "up"
    },
    {
      "checkedAt": "2026-10-28T10:00:15Z",
      "module": "desk",
      "since": "2026-10-27T06:12:00Z",
      "status": "up"
    }
  ],
  "status": "up"
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/status/v1/modules'

View as Markdown · Interactive reference · OpenAPI