Model Connections

Model connections are the edges of the model objects in your architecture. They represent relationships, dependencies, API calls, data flows, or any meaningful interaction between two model objects.


Creating connections

POST
/v1/landscapes/:landscapeId/versions/:versionId/model/connections
1import { IcePanelClient } from "@icepanel/sdk";
2
3async function main() {
4 const client = new IcePanelClient({
5 apiKey: "YOUR_API_KEY_HERE",
6 });
7 await client.model.connections.create("landscapeId", "versionId", {
8 body: {
9 direction: "outgoing",
10 name: "string",
11 originId: "string",
12 targetId: "string",
13 },
14 });
15}
16main();

Filtering connections

The GET /model/connections endpoint supports filtering:

Query parameterDescription
filter[originId]Connections starting from a specific object
filter[targetId]Connections ending at a specific object
filter[viaId]Connections passing through a specific object
filter[direction]outgoing or bidirectional
filter[status]Status lifecycle value
filter[tagIds][]One or more tag IDs
filter[technologyIds][]One or more technology IDs
filter[labels][key]Label key-value pair
filter[name]Partial name match
filter[linked]true to return only connections with at least one link

Status lifecycle

Connections share the same four-state lifecycle as model objects:

StatusDescription
liveActive dependency or relationship
futurePlanned but not yet implemented
deprecatedIn use but being phased out
removedRetired, kept for historical reference