# ConnectCloud Status API (v1.0.0)

Whether the modules of the environment are working: one public request, no token.

Base URLs:

- Production: `https://api.mbcom.cloud/api/status/v1`
- Staging: `https://api.mbcom.cloud/api/status/v1`
- Sandbox: `https://developers.mbcom.cloud/sandbox/status`

Status reports whether the modules of a ConnectCloud environment are working. It needs no
token and returns no details beyond the state of each module: no error texts, versions or
tenant data.

## Model
The status service probes every module inside the cluster every 15 seconds:

| State | Meaning |
|---|---|
| `up` | the module runs and can serve requests |
| `degraded` | the module runs but cannot serve requests (e.g. its database is unreachable) |
| `down` | the module does not answer |
| `unknown` | the module has not been probed yet (shortly after a restart of the status service) |

The overall `status` is the worst state of all modules (`down` before `degraded` before `unknown`
before `up`). When this API itself cannot be reached,
the environment is not reachable from outside – the status page (status.mbcom.cloud) checks
that separately and announces incidents and maintenance.

## Rate limits
Answers come from memory and may be cached for 10 seconds (`Cache-Control`). Each client IP may
send 5 requests per second (burst 30); more are answered with `429`.


## Authentication
Send an access token as `Authorization: Bearer <accessToken>`. Get it by exchanging an API key at
`POST https://api.mbcom.cloud/api/hr/v1/auth/token`; it lives 15 minutes and carries the key's permissions.
The tenant is always the one of the token. Guide: https://developers.mbcom.cloud/guides/authentication

# Status

## 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:

```json
{
  "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

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

