Create landscape versions | IcePanel Developer Docs

Version your landscape and create a snapshot in time on your version timeline. This can be run automatically as part of a build or release pipeline.

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'

Create a version

POST

/v1/landscapes/:landscapeId/versions

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.versions.create({
        landscapeId: "landscapeId",
        body: {
            modelHandleId: "string",
            name: "string",
            notes: "string",
        },
    });
}
main();

Try it