POST
/
organizations
/
{organizationId}
/
landscapes
curl --request POST \
  --url https://api.icepanel.io/v1/organizations/{organizationId}/landscapes \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "scheduledVersions": true,
  "backstageEntities": {
    "apis": [
      [
        {
          "apiVersion": "backstage.io/v1alpha1",
          "kind": "API",
          "metadata": {
            "name": "artist-api",
            "description": "Retrieve artist details",
            "labels": {
              "product_name": "Random value Generator"
            },
            "annotations": {
              "docs": "https://github.com/..../tree/develop/doc"
            }
          },
          "spec": {
            "type": "openapi",
            "lifecycle": "production",
            "owner": "artist-relations-team",
            "system": "artist-engagement-portal",
            "definition": "openapi: \"3.0.0\"\ninfo:..."
          }
        }
      ]
    ],
    "components": [
      [
        {
          "apiVersion": "backstage.io/v1alpha1",
          "kind": "Component",
          "metadata": {
            "name": "LoremService",
            "description": "Creates Lorems like a pro.",
            "labels": {
              "product_name": "Random value Generator"
            },
            "annotations": {
              "docs": "https://github.com/..../tree/develop/doc"
            }
          },
          "spec": {
            "type": "service",
            "lifecycle": "production",
            "owner": "tools"
          }
        }
      ]
    ],
    "domains": [
      [
        {
          "apiVersion": "backstage.io/v1alpha1",
          "kind": "Domain",
          "metadata": {
            "name": "artists",
            "description": "Everything about artists"
          },
          "spec": {
            "owner": "artist-relations-team"
          }
        }
      ]
    ],
    "resources": [
      [
        {
          "apiVersion": "backstage.io/v1alpha1",
          "kind": "Resource",
          "metadata": {
            "name": "artists-db",
            "description": "Stores artist details"
          },
          "spec": {
            "type": "database",
            "owner": "artist-relations-team",
            "system": "artist-engagement-portal"
          }
        }
      ]
    ],
    "systems": [
      [
        {
          "apiVersion": "backstage.io/v1alpha1",
          "kind": "System",
          "metadata": {
            "name": "artist-engagement-portal",
            "description": "Handy tools to keep artists in the loop"
          },
          "spec": {
            "owner": "artist-relations-team",
            "domain": "artists"
          }
        }
      ]
    ]
  },
  "structurizrWorkspace": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "version": "<string>",
    "thumbnail": "<string>",
    "lastModifiedDate": "<string>",
    "lastModifiedUser": "<string>",
    "lastModifiedAgent": "<string>",
    "model": {
      "enterprise": {
        "name": "<string>"
      },
      "people": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "tags": "<string>",
          "url": "<string>",
          "location": "External",
          "group": "<string>",
          "properties": {},
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "tags": "<string>",
              "url": "<string>",
              "sourceId": "<string>",
              "destinationId": "<string>",
              "technology": "<string>",
              "interactionStyle": "Synchronous",
              "linkedRelationshipId": "<string>"
            }
          ]
        }
      ],
      "softwareSystems": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "location": "External",
          "tags": "<string>",
          "url": "<string>",
          "containers": [
            {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "technology": "<string>",
              "tags": "<string>",
              "url": "<string>",
              "components": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "description": "<string>",
                  "technology": "<string>",
                  "tags": "<string>",
                  "url": "<string>",
                  "group": "<string>",
                  "properties": {},
                  "relationships": [
                    {
                      "id": "<string>",
                      "description": "<string>",
                      "tags": "<string>",
                      "url": "<string>",
                      "sourceId": "<string>",
                      "destinationId": "<string>",
                      "technology": "<string>",
                      "interactionStyle": "Synchronous",
                      "linkedRelationshipId": "<string>"
                    }
                  ],
                  "documentation": {
                    "sections": [
                      {
                        "content": "<string>",
                        "format": "Markdown",
                        "order": 123
                      }
                    ],
                    "decisions": [
                      {
                        "id": "<string>",
                        "date": "<string>",
                        "status": "Proposed",
                        "title": "<string>",
                        "content": "<string>",
                        "format": "Markdown",
                        "elementId": "<string>"
                      }
                    ],
                    "images": [
                      {
                        "name": "<string>",
                        "content": "<string>",
                        "type": "<string>"
                      }
                    ]
                  }
                }
              ],
              "group": "<string>",
              "properties": {},
              "relationships": [
                {
                  "id": "<string>",
                  "description": "<string>",
                  "tags": "<string>",
                  "url": "<string>",
                  "sourceId": "<string>",
                  "destinationId": "<string>",
                  "technology": "<string>",
                  "interactionStyle": "Synchronous",
                  "linkedRelationshipId": "<string>"
                }
              ],
              "documentation": {
                "sections": [
                  {
                    "content": "<string>",
                    "format": "Markdown",
                    "order": 123
                  }
                ],
                "decisions": [
                  {
                    "id": "<string>",
                    "date": "<string>",
                    "status": "Proposed",
                    "title": "<string>",
                    "content": "<string>",
                    "format": "Markdown",
                    "elementId": "<string>"
                  }
                ],
                "images": [
                  {
                    "name": "<string>",
                    "content": "<string>",
                    "type": "<string>"
                  }
                ]
              }
            }
          ],
          "group": "<string>",
          "properties": {},
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "tags": "<string>",
              "url": "<string>",
              "sourceId": "<string>",
              "destinationId": "<string>",
              "technology": "<string>",
              "interactionStyle": "Synchronous",
              "linkedRelationshipId": "<string>"
            }
          ],
          "documentation": {
            "sections": [
              {
                "content": "<string>",
                "format": "Markdown",
                "order": 123
              }
            ],
            "decisions": [
              {
                "id": "<string>",
                "date": "<string>",
                "status": "Proposed",
                "title": "<string>",
                "content": "<string>",
                "format": "Markdown",
                "elementId": "<string>"
              }
            ],
            "images": [
              {
                "name": "<string>",
                "content": "<string>",
                "type": "<string>"
              }
            ]
          }
        }
      ],
      "deploymentNodes": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "technology": "<string>",
          "environment": "<string>",
          "instances": "<string>",
          "tags": "<string>",
          "url": "<string>",
          "children": [
            {}
          ],
          "infrastructureNodes": [
            {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "technology": "<string>",
              "environment": "<string>",
              "tags": "<string>",
              "url": "<string>",
              "properties": {},
              "relationships": [
                {
                  "id": "<string>",
                  "description": "<string>",
                  "tags": "<string>",
                  "url": "<string>",
                  "sourceId": "<string>",
                  "destinationId": "<string>",
                  "technology": "<string>",
                  "interactionStyle": "Synchronous",
                  "linkedRelationshipId": "<string>"
                }
              ]
            }
          ],
          "softwareSystemInstances": [
            {
              "id": "<string>",
              "softwareSystemId": "<string>",
              "instanceId": 123,
              "environment": "<string>",
              "tags": "<string>",
              "properties": {},
              "relationships": [
                {
                  "id": "<string>",
                  "description": "<string>",
                  "tags": "<string>",
                  "url": "<string>",
                  "sourceId": "<string>",
                  "destinationId": "<string>",
                  "technology": "<string>",
                  "interactionStyle": "Synchronous",
                  "linkedRelationshipId": "<string>"
                }
              ],
              "healthChecks": [
                {
                  "name": "<string>",
                  "url": "<string>",
                  "interval": 123,
                  "timeout": 123,
                  "headers": {}
                }
              ]
            }
          ],
          "containerInstances": [
            {
              "id": "<string>",
              "containerId": "<string>",
              "instanceId": 123,
              "environment": "<string>",
              "tags": "<string>",
              "properties": {},
              "relationships": [
                {
                  "id": "<string>",
                  "description": "<string>",
                  "tags": "<string>",
                  "url": "<string>",
                  "sourceId": "<string>",
                  "destinationId": "<string>",
                  "technology": "<string>",
                  "interactionStyle": "Synchronous",
                  "linkedRelationshipId": "<string>"
                }
              ],
              "healthChecks": [
                {
                  "name": "<string>",
                  "url": "<string>",
                  "interval": 123,
                  "timeout": 123,
                  "headers": {}
                }
              ]
            }
          ],
          "properties": {},
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "tags": "<string>",
              "url": "<string>",
              "sourceId": "<string>",
              "destinationId": "<string>",
              "technology": "<string>",
              "interactionStyle": "Synchronous",
              "linkedRelationshipId": "<string>"
            }
          ]
        }
      ]
    },
    "views": {
      "systemLandscapeViews": [
        {
          "title": "<string>",
          "description": "<string>",
          "key": "<string>",
          "paperSize": "A6_Portrait",
          "dimensions": {
            "width": 123,
            "height": 123
          },
          "automaticLayout": {
            "rankDirection": "TopBottom",
            "rankSeparation": 123,
            "nodeSeparation": 123,
            "edgeSeparation": 123,
            "vertices": true
          },
          "enterpriseBoundaryVisible": true,
          "elements": [
            {
              "id": "<string>",
              "x": 123,
              "y": 123
            }
          ],
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "response": true,
              "order": "<string>",
              "vertices": [
                {
                  "x": 123,
                  "y": 123
                }
              ],
              "routing": "Direct",
              "position": 123
            }
          ],
          "animations": [
            {
              "order": 123,
              "elements": [
                "<string>"
              ],
              "relationships": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "systemContextViews": [
        {
          "title": "<string>",
          "description": "<string>",
          "key": "<string>",
          "softwareSystemId": "<string>",
          "paperSize": "A6_Portrait",
          "dimensions": {
            "width": 123,
            "height": 123
          },
          "automaticLayout": {
            "rankDirection": "TopBottom",
            "rankSeparation": 123,
            "nodeSeparation": 123,
            "edgeSeparation": 123,
            "vertices": true
          },
          "enterpriseBoundaryVisible": true,
          "elements": [
            {
              "id": "<string>",
              "x": 123,
              "y": 123
            }
          ],
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "response": true,
              "order": "<string>",
              "vertices": [
                {
                  "x": 123,
                  "y": 123
                }
              ],
              "routing": "Direct",
              "position": 123
            }
          ],
          "animations": [
            {
              "order": 123,
              "elements": [
                "<string>"
              ],
              "relationships": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "containerViews": [
        {
          "title": "<string>",
          "description": "<string>",
          "key": "<string>",
          "softwareSystemId": "<string>",
          "paperSize": "A6_Portrait",
          "dimensions": {
            "width": 123,
            "height": 123
          },
          "automaticLayout": {
            "rankDirection": "TopBottom",
            "rankSeparation": 123,
            "nodeSeparation": 123,
            "edgeSeparation": 123,
            "vertices": true
          },
          "elements": [
            {
              "id": "<string>",
              "x": 123,
              "y": 123
            }
          ],
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "response": true,
              "order": "<string>",
              "vertices": [
                {
                  "x": 123,
                  "y": 123
                }
              ],
              "routing": "Direct",
              "position": 123
            }
          ],
          "animations": [
            {
              "order": 123,
              "elements": [
                "<string>"
              ],
              "relationships": [
                "<string>"
              ]
            }
          ],
          "externalSoftwareSystemBoundariesVisible": true
        }
      ],
      "componentViews": [
        {
          "title": "<string>",
          "description": "<string>",
          "key": "<string>",
          "containerId": "<string>",
          "paperSize": "A6_Portrait",
          "dimensions": {
            "width": 123,
            "height": 123
          },
          "automaticLayout": {
            "rankDirection": "TopBottom",
            "rankSeparation": 123,
            "nodeSeparation": 123,
            "edgeSeparation": 123,
            "vertices": true
          },
          "elements": [
            {
              "id": "<string>",
              "x": 123,
              "y": 123
            }
          ],
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "response": true,
              "order": "<string>",
              "vertices": [
                {
                  "x": 123,
                  "y": 123
                }
              ],
              "routing": "Direct",
              "position": 123
            }
          ],
          "animations": [
            {
              "order": 123,
              "elements": [
                "<string>"
              ],
              "relationships": [
                "<string>"
              ]
            }
          ],
          "externalContainerBoundariesVisible": true
        }
      ],
      "dynamicViews": [
        {
          "title": "<string>",
          "description": "<string>",
          "key": "<string>",
          "elementId": "<string>",
          "paperSize": "A6_Portrait",
          "dimensions": {
            "width": 123,
            "height": 123
          },
          "automaticLayout": {
            "rankDirection": "TopBottom",
            "rankSeparation": 123,
            "nodeSeparation": 123,
            "edgeSeparation": 123,
            "vertices": true
          },
          "elements": [
            {
              "id": "<string>",
              "x": 123,
              "y": 123
            }
          ],
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "response": true,
              "order": "<string>",
              "vertices": [
                {
                  "x": 123,
                  "y": 123
                }
              ],
              "routing": "Direct",
              "position": 123
            }
          ],
          "externalBoundariesVisible": true
        }
      ],
      "deploymentView": [
        {
          "title": "<string>",
          "description": "<string>",
          "key": "<string>",
          "softwareSystemId": "<string>",
          "environment": "<string>",
          "paperSize": "A6_Portrait",
          "dimensions": {
            "width": 123,
            "height": 123
          },
          "automaticLayout": {
            "rankDirection": "TopBottom",
            "rankSeparation": 123,
            "nodeSeparation": 123,
            "edgeSeparation": 123,
            "vertices": true
          },
          "elements": [
            {
              "id": "<string>",
              "x": 123,
              "y": 123
            }
          ],
          "relationships": [
            {
              "id": "<string>",
              "description": "<string>",
              "response": true,
              "order": "<string>",
              "vertices": [
                {
                  "x": 123,
                  "y": 123
                }
              ],
              "routing": "Direct",
              "position": 123
            }
          ],
          "animations": [
            {
              "order": 123,
              "elements": [
                "<string>"
              ],
              "relationships": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "filteredViews": [
        {
          "title": "<string>",
          "description": "<string>",
          "key": "<string>",
          "baseViewKey": "<string>",
          "mode": "Include",
          "tags": [
            "<string>"
          ]
        }
      ],
      "configuration": {
        "styles": {
          "elements": [
            {
              "tag": "<string>",
              "width": 123,
              "height": 123,
              "background": "<string>",
              "stroke": "<string>",
              "strokeWidth": 123,
              "color": "<string>",
              "fontSize": 123,
              "shape": "Box",
              "icon": "<string>",
              "border": "Solid",
              "opacity": 123,
              "metadata": true,
              "description": true
            }
          ],
          "relationships": [
            {
              "tag": "<string>",
              "thickness": 123,
              "color": "<string>",
              "fontSize": 123,
              "width": 123,
              "dashed": true,
              "routing": "Direct",
              "position": 123,
              "opacity": 123
            }
          ]
        },
        "lastSavedView": "<string>",
        "defaultView": "<string>",
        "themes": [
          "<string>"
        ],
        "branding": {
          "logo": "<string>",
          "font": {
            "name": "<string>",
            "url": "<string>"
          }
        },
        "terminology": {
          "enterprise": "<string>",
          "person": "<string>",
          "softwareSystem": "<string>",
          "container": "<string>",
          "component": "<string>",
          "code": "<string>",
          "deploymentNode": "<string>",
          "relationship": "<string>"
        },
        "metadataSymbols": "SquareBrackets"
      }
    },
    "documentation": {
      "sections": [
        {
          "content": "<string>",
          "format": "Markdown",
          "order": 123
        }
      ],
      "decisions": [
        {
          "id": "<string>",
          "date": "<string>",
          "status": "Proposed",
          "title": "<string>",
          "content": "<string>",
          "format": "Markdown",
          "elementId": "<string>"
        }
      ],
      "images": [
        {
          "name": "<string>",
          "content": "<string>",
          "type": "<string>"
        }
      ]
    },
    "configuration": {
      "users": [
        {
          "username": "<string>",
          "role": "ReadWrite"
        }
      ]
    },
    "properties": {}
  },
  "templateId": "<string>"
}'
{
  "landscape": {
    "name": "<string>",
    "scheduledVersions": true,
    "organizationId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "id": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>"
  },
  "version": {
    "modelHandleId": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "completedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "diagramHandleIds": [
      "<string>"
    ],
    "id": "<string>",
    "landscapeId": "<string>",
    "tags": [
      "<string>"
    ],
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>"
  }
}

Headers

Authorization
string
required

Path Parameters

organizationId
string
required

Body

application/json
name
string
required
scheduledVersions
boolean
backstageEntities
object

The parts of the format that's common to all versions/kinds of entity.

structurizrWorkspace
object

Represents a Structurizr workspace, which is a wrapper for a software architecture model, views, and documentation.

templateId
string

Response

200
application/json
OK
landscape
object
required
version
object
required