Create | IcePanel Developer Docs

curl -X POST https://api.icepanel.io/v1/landscapes/landscapeId/versions/versionId/import \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "modelConnections": [
    {
      "direction": "outgoing",
      "id": "connection-1",
      "name": "Connection",
      "originId": "object-1",
      "targetId": "object-2"
    }
  ],
  "modelObjects": [
    {
      "id": "object-1",
      "name": "Domain",
      "parentId": null,
      "type": "domain"
    },
    {
      "id": "object-2",
      "name": "System",
      "parentId": "object-1",
      "type": "system",
      "groupIds": [
        "object-3"
      ]
    },
    {
      "id": "object-3",
      "name": "Group",
      "parentId": "object-1",
      "type": "group",
      "tagIds": [
        "tag-1"
      ]
    }
  ],
  "tagGroups": [
    {
      "icon": "bug",
      "id": "tag-group-1",
      "name": "Tag Group"
    }
  ],
  "tags": [
    {
      "color": "beaver",
      "groupId": "tag-group-1",
      "id": "tag-1",
      "name": "Tag"
    }
  ]
}'

{
  "landscapeImport": {
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "deleteAt": "2024-01-15T09:30:00Z",
    "id": "string",
    "landscapeId": "string",
    "status": "in-progress",
    "versionId": "string",
    "completedAt": "2024-01-15T09:30:00Z",
    "errors": [
      {
        "message": "string",
        "code": "string",
        "entityId": "string",
        "entityOriginalId": "string",
        "entityType": "model-object"
      }
    ]
  }
}

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.

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Request

This endpoint expects an object.

modelConnectionslist of objectsOptional

modelObjectslist of objectsOptional

tagGroupslist of objectsOptional

tagslist of objectsOptional

Response

landscapeImportobject

Authentication

Path parameters

Request

Response

Errors