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

1 curl -X POST https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/model/connections \
2      -H "X-API-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "direction": "outgoing",
6   "name": "string",
7   "originId": "string",
8   "targetId": "string"
9 }'

Try it

Filtering connections

The GET /model/connections endpoint supports filtering:

Query parameter	Description
`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:

Status	Description
`live`	Active dependency or relationship
`future`	Planned but not yet implemented
`deprecated`	In use but being phased out
`removed`	Retired, kept for historical reference

Model Objects

1	curl -X POST https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/model/connections \
2	-H "X-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"direction": "outgoing",
6	"name": "string",
7	"originId": "string",
8	"targetId": "string"
9	}'

Creating connections

Filtering connections

Status lifecycle

Related concepts

Creating connections

Filtering connections

Status lifecycle

Related concepts