API

Documentation Map

• Overview

• Quick Start

• Installation

• Configuration

• Operations

• Troubleshooting

• Release Notes

• Compatibility

• Architecture

• API Reference

• Security

• Integrations

• Capabilities

• Data Model

• Roadmap

• Project Plan

• Contract Governance

• OSS Inventory

• Channel: stable

• Source repo: JaddaHelpifyr/jhf-shuttle

API

This repository has an optional API runtime. It is additive to the CLI and requires the optional aiohttp dependency.

Base

• Base path: /api/v1
• OpenAPI: /api/v1/openapi.json
• WorkflowContext schema: /api/v1/workflow-context.schema.json
• Auth: optional bearer token via jhf_shuttle_API_TOKEN

Endpoints

Health / Status

• GET /api/v1/health
  • API + n8n reachability
• GET /api/v1/status
  • compact operator/runtime/catalog/upgrade/fabric status

Catalog / Upstream

• GET /api/v1/catalog/baseline/latest
• GET /api/v1/upstream/releases/latest

Execution / Workflow

• GET /api/v1/executions/hotspots
• GET /api/v1/workflows
• GET /api/v1/workflows/{id}
• GET /api/v1/workflows/{id}/context
• POST /api/v1/workflows/{id}/validate

Upgrade

• GET /api/v1/upgrade/summary
• GET /api/v1/upgrade/backlog
• GET /api/v1/upgrade/batches
• GET /api/v1/upgrade/alerts
• GET /api/v1/upgrade/scheduled/latest
• POST /api/v1/upgrade/impact

Request / Response Format

• JSON requests/responses
• success payloads are wrapped by the repo API response helpers
• error payloads use explicit error codes instead of raw tracebacks

Versioning

• API surface version is exposed via /api/v1/status
• no separate /version endpoint exists today
• API breaking changes should be reflected in:
  • OpenAPI
  • tests
  • CHANGELOG.md
  • versioning/governance docs

Stability

• API is real and usable
• stability classification: pilot
• CLI remains the primary product surface

Examples

See:

• MISSION_CONTROL_API.md (docs/MISSION_CONTROL_API.md)
• examples/mission-control/*.json
• examples/mission-control/curl-examples.sh

AGPLv3. Learn more at helpifyr.com.