Build custom integrations to connect IcePanel to your tools

Overview

Use the IcePanel REST API and TypeScript SDK to import systems, sync objects, and automate documentation workflows. Connect IcePanel to your internal tools, CI pipelines, and custom scripts.

Availability

API access is available on Growth and Scale plans. Write limits vary by plan.

How it works

Authenticate with an API key, then use the REST endpoints or SDK helpers to create, update, and query model objects, diagrams, and landscapes. Responses are JSON and designed for automation.

Configure

1. 1

   Create an API key

   Generate a key from your IcePanel organization settings.

2. 2

   Install the SDK or call the API

   Use the TypeScript SDK or any HTTP client against the REST API.

3. 3

   Sync your data

   Import objects, update descriptions, or export model data into your other systems.