List | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.model.connections.list("landscapeId", "versionId", {});
}
main();

{
  "modelConnections": [
    {
      "commit": 1.1,
      "createdAt": "2024-01-15T09:30:00Z",
      "createdBy": "user",
      "createdById": "string",
      "diagrams": {},
      "direction": "outgoing",
      "flows": {},
      "handleId": "string",
      "id": "string",
      "labels": {},
      "landscapeId": "string",
      "linked": true,
      "links": {},
      "name": "string",
      "originId": "string",
      "status": "deprecated",
      "tagIds": [
        "string"
      ],
      "targetId": "string",
      "technologyIds": [
        "string"
      ],
      "updatedAt": "2024-01-15T09:30:00Z",
      "updatedBy": "user",
      "updatedById": "string",
      "version": 1.1,
      "versionId": "string",
      "viaId": "string",
      "deletedAt": "2024-01-15T09:30:00Z",
      "deletedBy": "user",
      "deletedById": "string",
      "description": "string",
      "latestEntityId": "string",
      "tags": {},
      "technologies": {}
    }
  ],
  "nextCursor": "string"
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

filterobjectOptional

expandlist of enumsOptional

Allowed values:

cursorstringOptionalformat: "id"

limitintegerOptional>=1

Response

modelConnectionslist of objects

nextCursorstring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error