• Documentation
    • Documentation
    • Getting Started
      • Getting Started
      • What's New in ioFog 3.7.0?
      • Core Concepts
      • Architecture
      • Quick Start With Local Deployment
    • iofogctl
      • iofogctl
      • Introduction
      • Download
      • Getting Familiar
      • Resource Management
      • Connect/Disconnect
      • Legacy
      • CLI Reference
    • Platform Deployment
      • Platform Deployment
      • Introduction
      • Prepare Your Network
      • Prepare Realm and OIDC Client
      • Keycloak Deployment
      • Prepare Your Remote Hosts
      • Remote Control Plane
      • Kubernetes Prepare Cluster
      • External Database Deployment
      • Kubernetes iofogctl
      • Setup Your Agents
      • Airgap Deployment
    • Security and RBAC
      • Security and RBAC
      • Securing Cluster
      • Roles
      • Role Bindings
      • Certificates Manager
      • NATs Account Rule
      • NATs User Rule
      • NATs JWT Authentication
    • Agent Management
      • Agent Management
      • Introduction
      • Agent Configuration
      • Attach/Detach
      • Volumes
      • Docker Image Pruning
      • Upgrade/Rollback
    • Application Management
      • Application Management
      • Introduction
      • Application Templates
      • Microservice Lifecycle Management
      • Microservice Logs
      • Microservice Move/Rename
      • Microservice Registry Catalog
    • YAML References
      • YAML References
      • YAML Kinds
      • Control Plane
      • Agent
      • Application
      • Application Template
      • Registry
      • Catalog
      • OfflineImage
      • Secret
      • Certificate
      • ConfigMap
      • VolumeMount
      • Service
      • Role
      • RoleBinding
      • NatsAccountRule
      • NatsUserRule
    • ECN Viewer
      • ECN Viewer
      • ECN Viewer
    • Reference - Controller
      • Reference - Controller
      • Overview
      • Configuration
      • REST API
    • Reference - Agent
      • Reference - Agent
      • Overview
      • CLI Usage
      • Local API
      • Configuration
      • Agent Logs
    • Reference - Catalog Microservices
      • Reference - Catalog Microservices
      • HAL
      • REST Blue
    • Contributing
      • Contributing
      • Guidelines
      • Code of Conduct
  • Releases
  • Community
Quick Start Guide
1.3.0
Core ConceptsQuick StartMinikube and Vagrant, the Kubernetes local stack
IntroductionPrepare Your Remote HostsPrepare Your Kubernetes ClusterPrepare Your NetworkSetup Your Control PlaneSetup Your ConnectorsSetup Your Agents
IntroductionGet To Know ioFogManage Your MicroservicesCreate Your First Microservice - JavaScriptDeploy Your Microservice
Introduction to iofogctlCommon Header YAML SpecificationPlatform YAML SpecificationAgent configuration YAML SpecificationApplication YAML Specification
Platform ToolsHelm Guide
OverviewSDKDebugging
Controller microservices overviewSystem: DiagnosticsSystem: Hardware Abstraction LayerSystem: Bluetooth REST APIJSON REST API And Open Weather Map
OverviewLegacy CLI UsageREST API Reference
OverviewLegacy CLI UsageAPI Reference
OverviewLegacy CLI UsageLocal API Reference
GuidelinesCode of Conduct

Controller REST API Reference

/swagger/1.3.0/controller/swagger.yaml
ioFog

Eclipse ioFogTM is free, open source,
and always will be.

© 2026 Eclipse Foundation, Inc.

More information

Legal
Report Security Issues
Privacy Policy
Terms of Use
Copyright
Eclipse Foundation

Contributors

Datasance
IoT Eclipse
Eclipse Foundation

Follow us

© 2026 Eclipse Foundation, Inc.