Import | 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-2",
      "targetId": "object-3"
    }
  ],
  "modelObjects": [
    {
      "id": "object-1",
      "name": "Domain",
      "type": "domain"
    },
    {
      "id": "object-2",
      "name": "System",
      "type": "system",
      "groupIds": [
        "object-3"
      ],
      "parentId": "object-1"
    },
    {
      "id": "object-3",
      "name": "Group",
      "type": "group",
      "parentId": "object-1",
      "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"
      }
    ],
    "prune": true
  }
}

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

Query parameters

prunebooleanOptional

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

Request

This endpoint expects an object.

modelConnectionslist of objectsOptional

modelObjectslist of objectsOptional

namespacestringOptional

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

tagGroupslist of objectsOptional

tagslist of objectsOptional

Response

landscapeImportobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error