Landscape

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

Request

  • Base URL
    https://api.icepanel.io/v1
  • URL
    https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/import
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

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

Changes

    • warning

      the // request property's maxLength was set to 950000

    • warning

      the // request property's maxLength was set to 4000

    • warning

      the // request property's maxLength was set to 50000

    • warning

      the // request property's maxLength was set to 950000

    • warning

      the // request property's maxLength was set to 4000

    • warning

      the // request property's maxLength was set to 4000

    • warning

      the // request property's maxLength was set to 4000

    • info

      added the non-success response with the status