Create model objects | IcePanel Developer Docs

This guide shows how to create new objects in your landscape model. Useful for automatically filling out your model from another source.

Prerequisites

export ICEPANEL_API_KEY='your-api-key'
export ICEPANEL_ORGANIZATION_ID='your-organization-id'

Steps

Get your landscape

Get all landscapes in your organization and select a landscape ID:

GET

/v1/organizations/:organizationId/landscapes

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.organizations.landscapes.list({
        organizationId: "organizationId",
    });
}
main();

Try it

Note the id of the landscape:

export ICEPANEL_LANDSCAPE_ID='your-landscape-id'

Find the root object

Call a GET request with query parameter ?filter[type]=root to find the root model object. Your landscape may have multiple root model objects if you use domains.

GET

/v1/landscapes/:landscapeId/versions/:versionId/model/objects

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.model.objects.list({
        landscapeId: "landscapeId",
        versionId: "versionId",
    });
}
main();

Try it

Note the id from the response. This is the parentId for any top-level objects you create.

Create an object

Create a new model object as a child of the root:

POST

/v1/landscapes/:landscapeId/versions/:versionId/model/objects

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.model.objects.create({
        landscapeId: "landscapeId",
        versionId: "versionId",
        body: {
            name: "string",
            parentId: "string",
            type: "actor",
        },
    });
}
main();

Try it

Below is a list of different objects you can create.

Object types

Type	Description
`root`	A root object of a landscape.
`system`	A top-level system or bounded context
`app`	An application or service within a system
`component`	A component within an app
`store`	A data store (database, queue, cache)
`actor`	An external user, team, or system
`group`	A logical grouping within a diagram