Skip to content
Siemens
Siemens
Siemens
Siemens
Intro
Setup, Operate & Utilize
Develop an Application
Build a Device
Become a Seller
APIs & References
What's New?
Overview
APIs
API Guides
Industrial Edge Control (IECTL)
Helm chart
Initializing search
Overview
APIs
APIs
Overview
Industrial Edge Management
Industrial Edge Management
IE Portal API
IE Portal API
1.9.0
1.8.0
1.7.0
1.6.0
1.5.0
1.4.0
1.3.0
1.2.0
1.1.0
1.0.0
Admin User API
Admin User API
1.0.0
Industrial Edge Device
Industrial Edge Device
IE Device API
IE Device API
2.1.0
2.0.0
1.0.0
Secure Storage API
Secure Storage API
2.0.0
IE Device OIDC Provider API
IE Device OIDC Provider API
1.0.0
IE Device App Role API
IE Device App Role API
1.0.0
Industrial Edge Device Kit
Industrial Edge Device Kit
Network Service
NTP Service
Onboard Service
System Service
Security Service
Proxy Service
Databus
Databus
Common Payload Definition
Definitions
Release Notes
General Payload
General Payload
V1.3.0
V1.2.2
Profinet IO Payload
Profinet IO Payload
V1.3.0
V1.2.2
PROFINET Asset Service
PROFINET Asset Service
Introduction
What is PROFINET Asset Service
Why we Need PROFINET Asset Service
Prerequisites
Installation of PROFINET Asset Service
API
API
Server API
Server API
Device Dicovery API
Driver Event API
Driver Info API
Generic Data API
Device Address
Datatype
Device Filters
Device Identifiers
Error Code
Operators
Variant
Download Proto files
Client API
Client API
Registry API
Download Proto files
Additional Information
Additional Information
System Requirements
Troubleshooting
Service Registry
Service Registry
Introduction
Rest API
gRPC API
Limitations
IIH Essentials
IIH Essentials
API Specification
API Specification
V2.1.0
V2.0.0
V1.11.0
V1.10.0
V1.9.0
V1.8.0
V1.7.0
V1.6.0
V1.5.0
V1.4.1
V1.3.3
Point-to-Point
Point-to-Point
Vision Payload Specification_V1.1.0
Vision Payload Specification_V1.0.0
API Guides
API Guides
Authentication
Listing Applications
Import Application to Catalog
Deploy Apps to IEDs
Download logs of Edge Device
Configure OpenID Connect Client
Secure Storage
Monitor IED
Monitor Apps
Operation IED
Operation Apps
Listing Projects
App to IERT Communication
Graceful Shutdown
App authentication
Usage of Device Roles
Listing Users
Industrial Edge Control (IECTL)
Industrial Edge Control (IECTL)
Overview
Getting Started
Getting Started
Download
Installation on Linux
Installation on Windows
Bash and Shell Completion
Tutorials
Tutorials
Create Application
Create Application
Create Standalone App and Export
Create App on IEM
Create app with same appid
Create app without Docker engine
Creating arm application
Upload Application
Upload Application
Upload App to IEM
Upload App to IE Hub
Device Features for applications
Device Features for applications
Reverse proxy
Layer 2 network access
GPU access
CPU Isolation
Device Auth
Event Service
Device API
Service Registry
Manage IEM Jobs
Manage IEM Jobs
Batch Jobs
List all import app jobs
Wait for Import app job till given timeout
Wait for device related job till given timeout
List all install application jobs submitted on Edge Devices
Configure IEM and IED
Configure IEM and IED
Onboard IEM-OS
Onboard IEM-Pro
Onboard IED
Onboard IED Single Command
Create and Activate Developer IED
Create Application Configurations
Environment variables
Apply Commands via manifest file
Apply Commands via manifest file
Overview
Onboard IEM to IED
Create standalone app
Create IEHUB version
Upload an App to Catalog and install
Create and export IEM version
Setup Development Environment
Setup Development Environment
Overview
Install Dependencies Using Script
Install Dependencies Manually
Onboard IEM and IED using Manifest
Create CLI user on IEHUB
Download IEVD
All Commands
All Commands
iectl
iectl apply
iectl completion
iectl completion bash
iectl completion zsh
Config
Config
iectl config
iectl config list active
Add
Add
iectl config add
iectl config add ied
iectl config add iehub
iectl config add iem
iectl config add iem-os
iectl config add publisher
iectl config delete
iectl config list
iectl config switch
IED
IED
iectl ied
Settings
Dev
Dev
iectl ied dev
Dev Port Forward
App
App
iectl ied dev app containers list
iectl ied dev app details
iectl ied dev app list
System
System
iectl ied system
iectl ied system activate
iectl ied system hard-reset
iectl ied system shutdown
iectl ied system statistics
Token
Token
iectl ied token
iectl ied token fetch
IEHub
IEHub
IEHub
App-management
App-management
iectl iehub app-management (deprecated)
Create
Create
iectl iehub app-management create (deprecated)
Version
Version
iectl iehub app-management version (deprecated)
iectl iehub app-management version create (deprecated)
iectl iehub app-management version delete (deprecated)
iectl iehub app-management version get-details (deprecated)
iectl iehub app-management version list (deprecated)
iectl iehub app-management version private-release (deprecated)
iectl iehub app-management version public-release (deprecated)
iectl iehub app-management version upload (deprecated)
Product-management
Product-management
iectl iehub product-management
Create
Create
iectl iehub product-management create
List
List
iectl iehub product-management list
Version
Version
iectl iehub product-management version
iectl iehub product-management version create
iectl iehub product-management version delete
iectl iehub product-management version get-details
iectl iehub product-management version list
iectl iehub product-management version private-release
iectl iehub product-management version public-release
iectl iehub product-management version upload
Artifacts
Artifacts
iectl iehub artifacts
iectl iehub artifacts download
iectl iehub artifacts list
Instance
Instance
iectl iehub iem-instance (deprecated)
iectl iehub iem-instance create (deprecated)
iectl iehub iem-instance delete (deprecated)
iectl iehub iem-instance get-details (deprecated)
iectl iehub iem-instance list (deprecated)
Instance-management
Instance-management
IEM Cloud
IEM Cloud
iectl iehub instance-management iemc-create
iectl iehub instance-management iemc-status
iectl iehub instance-management iemc-list
iectl iehub instance-management iemc-delete
iectl iehub instance-management
iectl iehub instance-management create
iectl iehub instance-management delete
iectl iehub instance-management get-details
iectl iehub instance-management list
Library
Library
iectl iehub library
iectl iehub library list
iectl iehub library copy-product
iectl iehub library list-app (deprecated)
iectl iehub library copy-app (deprecated)
iectl iehub run-ied-dev
Token
Token
iectl iehub token
iectl iehub token fetch
IEM
IEM
IEM
App-config
App-config
iectl iem app-config
Add
Add
iectl iem app-config add
iectl iem app-config add browsetype
iectl iem app-config add templatetype
iectl iem app-config add versiontype
iectl iem app-config delete
iectl iem app-config delete-version
iectl iem app-config get-template
iectl iem app-config list
App-project
App-project
iectl iem app-project
iectl iem app-project app-details
iectl iem app-project create-app
iectl iem app-project install
iectl iem app-project publish
iectl iem app-project unpublish
iectl iem app-project create-project
iectl iem app-project create-company
iectl iem app-project list-apps
iectl iem app-project list-categories
iectl iem app-project list-projects
iectl iem app-project delete-company
iectl iem app-project delete-project
iectl iem app-project list-company
Catalog
Catalog
iectl iem catalog
iectl iem catalog app-details
iectl iem catalog import-application
iectl iem catalog import-status
iectl iem catalog list
iectl iem catalog publish
iectl iem device type list
Device
Device
iectl iem device
iectl iem device create
iectl iem device create-template
iectl iem device delete
iectl iem device get-details
iectl iem device get-statistics
iectl iem device list
iectl iem device list-apps
iectl iem device onboard
iectl iem device app-statistics
iectl iem device system
Firmware
Firmware
iectl iem device firmware
iectl iem device firmware update
iectl iem device firmware list
iectl iem device firmware update-status
Device-Logs
Device-Logs
iectl iem device-logs
iectl iem device-logs generate-link
iectl iem device-logs list
IEM-Extensions
IEM-Extensions
iectl iem iem-extensions
iectl iem iem-extensions delete
iectl iem iem-extensions install
iectl iem iem-extensions list
iectl iem iem-extensions list-version
iectl iem iem-extensions package
iectl iem iem-extensions unistall
iectl iem iem-extensions upload
Job
Job
iectl iem job
iectl iem job action
iectl iem job batch-create
iectl iem job batch-status
iectl iem job delete
iectl iem job list
iectl iem job status
iectl iem job batch-create-device
iectl iem job import-job-list
iectl iem job import-job-wait
iectl iem job device-job-wait
iectl iem job device-job-list
System
System
iectl iem system
iectl iem system delete-cluster
iectl iem system onboard
iectl iem system onboard-status
Token
Token
iectl iem token
iectl iem token fetch
Plugin
Plugin
iectl plugin
iectl plugin list
Publisher
Publisher
iectl publisher
App project
App project
iectl publisher app-project
Upload
Upload
iectl publisher app-project upload
iectl publisher app-project upload catalog
iectl publisher app-project upload project
Version
Version
iectl publisher app-project version
iectl publisher app-project version create
iectl publisher app-project version delete (deprecated)
iectl publisher app-project version export
iectl publisher app-project version link-document
iectl publisher app-project version create-mendix-version
Docker-engine
Docker-engine
iectl publisher docker-engine
iectl publisher docker-engine verify
iectl publisher docker-engine list-images
iectl publisher downloadLogs
iectl publisher environment
iectl publisher image
iectl publisher image createmendiximage
Standalone-app
Standalone-app
iectl publisher standalone-app
App-config
App-config
iectl publisher standalone-app app-config
iectl publisher standalone-app app-config add
iectl publisher standalone-app app-config addversion
iectl publisher standalone-app app-config delete
iectl publisher standalone-app app-config deleteversion
iectl publisher standalone-app app-config list
iectl publisher standalone-app create
iectl publisher standalone-app delete
iectl publisher standalone-app export
iectl publisher standalone-app import
iectl publisher standalone-app list
Version
Version
iectl publisher standalone-app version
iectl publisher standalone-app version create
iectl publisher standalone-app version delete
iectl publisher standalone-app version export
iectl publisher standalone-app version list
iectl publisher standalone-app version create-mendix-version
iectl publisher standalone-app validate
Workspace
Workspace
iectl publisher workspace
iectl publisher workspace export
iectl publisher workspace init
iectl provision
iectl version
Migrating from PUBCLI to IECTL
FAQs
Helm chart
General Payload Specification
¶
Back to top