Muse connector documentation

Endpoint

GET https://brightcert.co.uk/api/muse/cyber-essentials-guide

Optional query parameter:

• stage — one of the 7 Cyber Essentials readiness stage ids below. Omit it for a summary overview of all 7.

Valid stage ids:

• scope
• firewalls
• secure-configuration
• user-access
• malware
• updates
• final-review

Example: overview

GET /api/muse/cyber-essentials-guide

{
  "service": {
    "name": "BrightCert",
    "whatItDoes": "BrightCert is a UK Cyber Essentials readiness-assessment platform for SMEs...",
    "assessmentUrl": "https://brightcert.co.uk",
    "disclaimer": "General guidance only. This is not a certification decision..."
  },
  "checklist": {
    "description": "Cyber Essentials readiness breaks into 7 stages...",
    "stages": [
      { "id": "scope", "title": "1. Scope", "purpose": "..." },
      { "id": "firewalls", "title": "2. Boundary firewalls and internet gateways", "purpose": "..." }
      // ...5 more
    ]
  }
}

Example: one stage

GET /api/muse/cyber-essentials-guide?stage=firewalls

{
  "service": { "name": "BrightCert", "...": "..." },
  "stage": {
    "id": "firewalls",
    "title": "2. Boundary firewalls and internet gateways",
    "purpose": "What sits between your systems and the internet, and who decided each gap in it.",
    "items": [
      { "task": "Identify every internet-facing device and cloud boundary", "evidence": "Network diagram or device list" }
      // ...more tasks
    ]
  }
}

Errors

An unrecognised stage value returns HTTP 400:

{
  "error": "Unknown stage 'bogus'. Valid values: scope, firewalls, secure-configuration, user-access, malware, updates, final-review"
}

Access, auth, and caching

• No API key, login, or account required.
• No rate limit is enforced by BrightCert directly — responses are served from a CDN cache (only 8 fixed response bodies exist), so repeat requests don't reach the origin server.
• No regional restriction.
• Machine-readable spec: OpenAPI 3.0 (JSON)