APIs
APIs Overview
SDA provides a fully accessible, modern API layer that allows you to integrate, automate, and extend every part of the platform. Nearly all SDA platform capabilities—including device management, project operations, pipeline execution, identity management, and remote engineering—are exposed through secure, versioned APIs. This enables customers to build custom workflows, automate engineering processes, and integrate SDA into existing enterprise systems and toolchains.
This section documents the core APIs available within SDA and provides practical examples to help you get started quickly. Code samples are included in common languages such as Python, with patterns that can be adapted to JavaScript, C#, and other environments as needed.
Key API Categories
The Asset API provides programmatic access to devices, projects, resource groups, and related metadata. It enables external systems to list, query, update, and orchestrate assets within SDA, making it ideal for CMDB synchronization, automated asset onboarding, and data-driven asset lifecycle management.
The Job API allows you to trigger, monitor, and manage operational tasks such as backups, deployments, snapshots, password rotations, and other pipeline actions. It is commonly used for CI/CD-style automation, nightly backups, and integration with ticketing or workflow systems.
The Identity API provides access to user, role, and permission information. It supports integration with external identity systems, custom provisioning workflows, and advanced automation around entitlements and RBAC-driven operations.
The IDEaaS API exposes browser-based engineering capabilities, allowing external tools or orchestrators to create engineering sessions, open PLC projects, and interact with vendor-specific IDEs remotely. This enables automated engineering pipelines, remote workspaces, and deep integration with existing DevOps or IT/OT platforms.
To help you quickly integrate SDA APIs into your environment, this section includes practical, end-to-end examples. These examples demonstrate how to authenticate, retrieve data, trigger pipeline actions, and integrate with external applications.
Each example highlights best practices such as token management, error handling, pagination, and recommended security configurations.
Last updated