Skip to main content
PUT
/
landscapes
/
{landscapeId}
/
versions
/
{versionId}
/
model
/
connections
/
{modelConnectionId}
Upsert
curl --request PUT \
  --url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/model/connections/{modelConnectionId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "direction": null,
  "name": "<string>",
  "originId": "<string>",
  "targetId": "<string>",
  "commit": 123,
  "description": "<string>",
  "labels": {},
  "status": "deprecated",
  "tagIds": [
    "<string>"
  ],
  "technologyIds": [
    "<string>"
  ],
  "viaId": "<string>",
  "handleId": "<string>"
}
'
{
  "modelConnection": {
    "commit": 123,
    "direction": null,
    "labels": {},
    "name": "<string>",
    "originId": "<string>",
    "status": "deprecated",
    "tagIds": [
      "<string>"
    ],
    "targetId": "<string>",
    "technologyIds": [
      "<string>"
    ],
    "viaId": "<string>",
    "handleId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "diagrams": {},
    "flows": {},
    "id": "<string>",
    "landscapeId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>",
    "version": 123,
    "versionId": "<string>",
    "description": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedBy": "user",
    "deletedById": "<string>",
    "latestEntityId": "<string>"
  }
}

Headers

Authorization
string
required

Path Parameters

landscapeId
string
required
versionId
string
required
modelConnectionId
string
required

Query Parameters

originConnector
enum<string>
Available options:
top-left,
top-center,
top-right,
right-top,
right-middle,
right-bottom,
bottom-right,
bottom-center,
bottom-left,
left-bottom,
left-middle,
left-top
targetConnector
enum<string>
Available options:
top-left,
top-center,
top-right,
right-top,
right-middle,
right-bottom,
bottom-right,
bottom-center,
bottom-left,
left-bottom,
left-middle,
left-top
updateDiagrams
boolean

Body

application/json
direction
enum<string> | null
required
Available options:
,
outgoing,
bidirectional
name
string
required
originId
string
required

Model object that initiates the connection Model object that initiates the connection

targetId
string
required

Model object that receives the message Model object that receives the message

commit
number
description
string
labels
object
status
enum<string>
Available options:
deprecated,
future,
live,
removed
tagIds
string[]

Tag IDs assigned to this model Tag IDs assigned to this model

technologyIds
string[]

Technology IDs assigned to this model Technology IDs assigned to this model

viaId
string | null

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

handleId
string

Response

OK

modelConnection
object
required