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

Changes

Changed in 3 of the 17 revisions of this API.358

Jul 22, 20260fe4f00b60cf1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Jun 3, 2026181c90adca5e241See the full diff
- ▲
  the //// request property format changed from no format to uri
  request-property-type-changed
- ▲
  the //// request property format changed from no format to uri
  request-property-type-changed
- ●
  the /// request property's maxLength was set to 5000
  request-property-max-length-set
- ●
  the /// request property's maxLength was set to 5000
  request-property-max-length-set
- ●
  the /// request property's maxLength was set to 5000
  request-property-max-length-set
- ●
  the /// request property's maxLength was set to 5000
  request-property-max-length-set
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 6, 20261856884cd7e6116See the full diff
- ▲
  added the new required request property ///////
  new-required-request-property
- ●
  removed the request property ///////
  request-property-removed
- ○
  added the new optional query request parameter prune
  new-optional-request-parameter
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the media type application/yaml to the request body
  request-body-media-type-added
- ○
  the request property // became optional
  request-property-became-optional
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added

Full history