Sign in

v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011528661.3 MB
Landscape

Import

Create a background job that imports a landscape from JSON format.

The JSONSchema can be accessed at api.icepanel.io/v1/schemas/LandscapeImportData for automations or using LLMs for generation.

post/landscapes/{landscapeId}/versions/{versionId}/import

Path parameters

landscapeIdstring required
versionIdstring required

Query parameters

pruneboolean

When enabled, entities that are missing from the import will be deleted.

Request body

namespacestring

The namespace of the import, used for seperate operations when using multiple import sources

Example request

{
  "modelConnections": [
    {
      "direction": "outgoing",
      "id": "connection-1",
      "name": "Connection",
      "originId": "object-2",
      "targetId": "object-3"
    }
  ],
  "modelObjects": [
    {
      "id": "object-1",
      "name": "Domain",
      "type": "domain"
    },
    {
      "groupIds": [
        "object-3"
      ],
      "id": "object-2",
      "name": "System",
      "parentId": "object-1",
      "type": "system"
    },
    {
      "id": "object-3",
      "name": "Group",
      "parentId": "object-1",
      "tagIds": [
        "tag-1"
      ],
      "type": "group"
    }
  ],
  "tagGroups": [
    {
      "icon": "bug",
      "id": "tag-group-1",
      "name": "Tag Group"
    }
  ],
  "tags": [
    {
      "color": "beaver",
      "groupId": "tag-group-1",
      "id": "tag-1",
      "name": "Tag"
    }
  ]
}

Response

OK