Zum Inhalt springen

API

API Documentation

REST API endpoints for programmatic access to the Resilience Platform.

Hinweis: The API is read-only and returns JSON. No authentication required for public endpoints.

API Overview

11

Endpoints

JSON

Response Format

Read-Only

Access Mode

Endpoints

Method Endpoint Description
GET /api API index with all available endpoints
GET /api/risk-register IKT Risk Register with 10 risks, categories, risk matrix
GET /api/vendor-scorecard Vendor Scorecard with 7 vendors, 5-dimension scores
GET /api/incident-drills Incident drill scenarios with tasks and success criteria
GET /api/gap-analysis Gap analysis across DORA, MaRisk, ISO 27001, NIS2
GET /api/measures Complete DORA measures catalog (103 measures)
GET /api/evidence Evidence catalog with all evidence items
GET /api/radar Regulatory radar signals from BaFin, EBA, ESMA
GET /api/modules Platform modules overview with route availability
GET /api/stats Platform statistics (counts, version, routes)

Example Response

All endpoints return JSON with appropriate HTTP status codes (200 for success, 500 for errors).

GET /api/stats

{
    "modules": 55,
    "measures": 103,
    "evidence": 116,
    "radar_signals": 42,
    "routes_count": 714,
    "platform_version": "2.4"
}

Usage Examples

cURL:

curl https://resilience.amartens.com/api/stats

JavaScript:

fetch('https://resilience.amartens.com/api/measures')
  .then(r => r.json())
  .then(data => console.log(data));

Python:

import requests
data = requests.get('https://resilience.amartens.com/api/radar').json()

API v2

New

Full REST API with unified JSON responses, filtering, pagination, and API key authentication.

Method Endpoint Auth Description
GET /api/v2 🔑 API Key
GET /api/v2/risk-register?level=&status=&search= 🔑 API Key
GET /api/v2/vendor-scorecard?criticality=&min_score= 🔑 API Key
GET /api/v2/incident-drills?difficulty= 🔑 API Key
GET /api/v2/gap-analysis?framework= 🔑 API Key
GET /api/v2/compliance-timeline?status=&category= 🔑 API Key
GET /api/v2/compliance-training?difficulty= 🔑 API Key
GET /api/v2/vendor-risk-assessment 🔑 API Key
GET /api/v2/dashboard-widgets 🔑 API Key
GET /api/v2/alerts 🔑 API Key
GET /api/v2/compliance-scores 🔑 API Key
GET /api/v2/search?q= 🔑 API Key

Authentication

curl -H "Authorization: Bearer YOUR_API_KEY" https://resilience.amartens.com/api/v2/risk-register?level=critical

Get your API key from the API Keys page.

Example Response

{
    "data": [...],
    "meta": {
        "count": 10,
        "total": 18,
        "limit": 100,
        "offset": 0,
        "version": "2.0"
    }
}

Query Parameters

  • ?limit=N — Results per page (max 500)
  • ?offset=N — Pagination offset
  • ?search=term — Text search
  • ?level=critical — Filter by level
  • ?status=open — Filter by status