Create | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.model.connections.create("landscapeId", "versionId", {
        body: {
            direction: "outgoing",
            name: "string",
            originId: "string",
            targetId: "string",
        },
    });
}
main();

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

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Request

This endpoint expects an object.

directionenum or nullRequired

namestringRequired<=4000 characters

originIdstringRequired

Model object that initiates the connection

targetIdstringRequired

Model object that receives the message

commitdoubleOptional

descriptionstringOptional<=950000 characters

labelsmap from strings to stringsOptional

linksmap from strings to objectsOptional

statusenumOptional

tagIdslist of stringsOptional

Tag IDs assigned to this model

technologyIdslist of stringsOptional

Technology IDs assigned to this model

viaIdstring or nullOptional

Model object that facilitates the connection, such as a Kafka topic, or RabbitMQ queue

handleIdstringOptional

Response

modelConnectionobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error