T-IA Connect

API Reference

Welcome to the T-IA Connect API documentation. This REST API allows you to interact directly with Siemens TIA Portal, enabling full automation of your engineering workflows through standard HTTP requests.

568endpoints documented across 53 categories

Generated from the API contract of T-IA Connect 2.5.354.

Base URL

All endpoints are prefixed with:

http://localhost:9000/api

Content Type

Requests and responses are formatted as:

application/json

Key Capabilities

Native Integration

Direct connection to Openness API without proprietary DLL complexity.

Real-time Feedback

Monitor compilation and downloads via WebSockets and Jobs API.

Headless Automation

Designed for CI/CD pipelines and industrial server environments.

Response envelope

Every JSON response is wrapped in the same envelope: success and message summarize the result, response carries the payload declared for the operation, and status carries listener context (TIA Portal state, build) whose shape is not guaranteed.

response.json
{
  "status": {},
  "response": {},
  "success": true,
  "message": "string"
}

Common parameters

Every operation also accepts these query parameters.

  • culture (query, string)default: fr

Quick Start

Test that the API is running with a simple health check:

Terminal
curl http://localhost:9000/api/health -H "X-API-KEY: YOUR_API_KEY"

Real response captured from an installed T-IA Connect, checked against the contract

response.json
{
  "status": {
    "status": "Connecté",
    "pid": 2888,
    "tiaPortalVersion": "20.0.0.0",
    "buildVersion": "2.5.354",
    "buildDate": "2026-10-18T14:04:22.719771+02:00",
    "projectName": "Line1",
    "projectPath": "C:\\Projects\\Line1\\Line1.ap20"
  },
  "response": {
    "success": true,
    "message": "Project 'Line1' is open.",
    "data": {
      "healthy": true,
      "status": "Project 'Line1' is open.",
      "tiaVersion": "20.0.0.0",
      "tiaConnected": true,
      "projectName": "Line1",
      "apiVersion": "2.5.354.0",
      "warningCount": 0,
      "errorCount": 0
    },
    "timestamp": "2026-10-23T09:15:40.2562756Z"
  },
  "success": true,
  "message": "Project 'Line1' is open."
}