IcePanel

https://docs.icepanel.io
Admin
IcePanel is a software architecture visualization tool that helps users model, diagram, and tell...
Tokens:5,252
Snippets:29
Trust Score:8.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### IcePanel CLI gitlab-sync Command Reference

Source: https://docs.icepanel.io/integrations/code-repo-linking/gitlab

Detailed reference for the IcePanel CLI `gitlab-sync` command, outlining all available options and corresponding environment variables for synchronizing code repositories with a GitLab instance.

```APIDOC
Usage: IcePanel gitlab-sync [options]

Syncronize IcePanel code repos with a GitLab instance

Options:
  --api-url <value>         IcePanel API URL (default: "https://api.icepanel.io/v1")
  -k, --api-key <value>     IcePanel API key
  -s, --url <value>         GitLab URL (default: "https://gitlab.com")
  -t, --token <value>       GitLab token
  -g, --group-id <value>    GitLab group ID, comma seperated
  -i, --interval <secs>     Interval for syncronization (default: "1800")
  -f, --force               Force refresh of code repos and trees
  --filter-repos <pattern>  Filter code repo names to include, supports wildcards
  --delete-all              Delete all code repos and trees for this integration
  --concurrency <value>     Number of jobs that can be processed in parallel (default: "10")
  -h, --help                display help for command

Environment variables:
  API_URL             IcePanel API URL
  API_KEY             IcePanel API key
  GITLAB_URL          GitLab URL
  GITLAB_TOKEN        GitLab token
  GITLAB_GROUP_ID     GitLab group ID, comma seperated
  SYNC_INTERVAL       Interval for syncronization
  FORCE               Force refresh of code repos and trees
  FILTER_REPOS        Filter code repo names to include, supports wildcards
  CONCURRENCY         Number of jobs that can be processed in parallel
  LOG_LEVEL           Options are fatal, error, warn, info, debug, trace, silent
```

--------------------------------

### IcePanel Bitbucket Server Synchronization CLI Command Reference

Source: https://docs.icepanel.io/integrations/code-repo-linking/bitbucket-server

Detailed reference for the `IcePanel bitbucket-server-sync` command, including available options and environment variables for synchronizing IcePanel code repositories with a Bitbucket server instance.

```CLI
Usage: IcePanel bitbucket-server-sync [options]

Syncronize IcePanel code repos with a BitBucket server instance

Options:
  --api-url <value>          IcePanel API URL (default: "https://api.icepanel.io/v1")
  -k, --api-key <value>      IcePanel API key
  -s, --server-url <value>   BitBucket server URL
  -u, --username <value>     BitBucket server username
  -t, --token <value>        BitBucket server token
  -p, --project-key <value>  BitBucket project key, comma seperated
  -i, --interval <secs>      Interval for syncronization (default: "1800")
  -f, --force                Force refresh of code repos and trees
  --filter-repos <pattern>   Filter code repo names to include, supports wildcards
  --delete-all               Delete all code repos and trees for this integration
  --concurrency <value>      Number of jobs that can be processed in parallel (default: "10")
  -h, --help                 display help for command

Environment variables:
  API_URL                     IcePanel API URL
  API_KEY                     IcePanel API key
  BITBUCKET_SERVER_URL        BitBucket server URL
  BITBUCKET_SERVER_USERNAME   BitBucket server username
  BITBUCKET_SERVER_TOKEN      BitBucket server token
  BITBUCKET_PROJECT_KEY       BitBucket project key, comma seperated
  SYNC_INTERVAL               Interval for syncronization
  FORCE                       Force refresh of code repos and trees
  FILTER_REPOS                Filter code repo names to include, supports wildcards
  CONCURRENCY                 Number of jobs that can be processed in parallel
  LOG_LEVEL                   Options are fatal, error, warn, info, debug, trace, silent
```

--------------------------------

### Run IcePanel CLI for GitLab Synchronization with Parameters

Source: https://docs.icepanel.io/integrations/code-repo-linking/gitlab

Execute the IcePanel CLI Docker image in `gitlab-sync` mode, providing the IcePanel API key, GitLab URL, and GitLab token directly as command-line parameters.

```docker
docker run icepanel/cli gitlab-sync \
  --api-key $ICEPANEL_KEY \
  --url <https://gitlab.com> \
  --token $GITLAB_TOKEN
```

--------------------------------

### Run IcePanel CLI for GitLab Synchronization with Environment Variables

Source: https://docs.icepanel.io/integrations/code-repo-linking/gitlab

Execute the IcePanel CLI Docker image in `gitlab-sync` mode, passing the IcePanel API key, GitLab URL, and GitLab token securely via environment variables.

```docker
docker run \
  -e API_KEY=$ICEPANEL_KEY \
  -e GITLAB_URL=https://gitlab.com \
  -e GITLAB_TOKEN=$GITLAB_TOKEN \
  icepanel/cli gitlab-sync
```

--------------------------------

### Configure MCP Client for IcePanel Integration

Source: https://docs.icepanel.io/experiments/mcp-server-beta

This JSON configuration block is used to define the IcePanel MCP server within an MCP client's configuration file. It specifies the command to run the IcePanel MCP server using `npx` and passes the required `API_KEY` and `ORGANIZATION_ID` as arguments. Replace the placeholder values with your actual IcePanel credentials.

```JSON
{
  "mcpServers": {
    "@icepanel/icepanel": {
      "command": "npx",
      "args": ["-y", "@icepanel/mcp-server@latest", "API_KEY=\"your-api-key\"", "ORGANIZATION_ID=\"your-org-id\""]
    }
  }
}
```

--------------------------------

### Configure IcePanel MCP Server in Client

Source: https://docs.icepanel.io/experiments

This JSON configuration block is used to set up the IcePanel MCP server within an MCP client's configuration file. It specifies the command to run the server using `npx` and passes the required `API_KEY` and `ORGANIZATION_ID` as arguments. This allows the MCP client to communicate with IcePanel's data by executing the server process.

```JSON
{
  "mcpServers": {
    "@icepanel/icepanel": {
      "command": "npx",
      "args": ["-y", "@icepanel/mcp-server@latest", "API_KEY=\"your-api-key\"", "ORGANIZATION_ID=\"your-org-id\""]
    }
  }
}
```

--------------------------------

### IcePanel CLI Docker Run with Direct Parameters for Azure DevOps Sync

Source: https://docs.icepanel.io/integrations/code-repo-linking/azure-devops

This command demonstrates how to execute the IcePanel CLI Docker image to synchronize code repositories from an Azure DevOps instance. It passes the IcePanel API key, Azure DevOps URL, personal access token, and organization name directly as command-line arguments.

```Shell
docker run icepanel/cli azure-devops-sync \
  --api-key $ICEPANEL_KEY \
  --url https://dev.azure.com \
  --token $AZURE_DEVOPS_TOKEN
  --organization $AZURE_DEVOPS_ORGANIZATION
```

--------------------------------

### Whitelist IcePanel Repo Scanner IP Address

Source: https://docs.icepanel.io/integrations/code-repo-linking/gitlab

To ensure code repositories are visible when IP filtering is enabled, whitelist this specific IP address for the IcePanel repo scanner.

```text
34.168.47.236
```

--------------------------------

### Configure IcePanel CLI for Self-Signed Certificates

Source: https://docs.icepanel.io/integrations/code-repo-linking/gitlab

To enable the IcePanel CLI to work with self-signed certificates, set the `NODE_TLS_REJECT_UNAUTHORIZED` environment variable to `0` within the CLI container.

```bash
NODE_TLS_REJECT_UNAUTHORIZED=0
```

--------------------------------

### Whitelist IcePanel Repo Scanner IP Address

Source: https://docs.icepanel.io/integrations/code-repo-linking/bitbucket-server

To ensure IcePanel can access your code repositories, whitelist this IP address in your network or firewall settings if IP filtering is enabled.

```Plaintext
34.168.47.236
```

--------------------------------

### IcePanel CLI Azure DevOps Sync Command Options and Environment Variables

Source: https://docs.icepanel.io/integrations/code-repo-linking/azure-devops

This section provides a comprehensive reference for the `IcePanel azure-devops-sync` command. It details all available command-line options and their corresponding environment variables, outlining parameters for API URL, API key, Azure DevOps URL, token, organization, synchronization interval, force refresh, repository filtering, deletion, and concurrency.

```APIDOC
Usage: IcePanel azure-devops-sync [options]

Syncronize IcePanel code repos with a Azure DevOps instance

Options:
  --api-url <value>           IcePanel API URL (default: "https://api.icepanel.io/v1")
  -k, --api-key <value>       IcePanel API key
  -s, --url <value>           Azure DevOps URL (default: "https://dev.azure.com")
  -t, --token <value>         Azure DevOps token
  -o, --organization <value>  Azure DevOps organization name, comma seperated
  -i, --interval <secs>       Interval for syncronization (default: "1800")
  -f, --force                 Force refresh of code repos and trees
  --filter-repos <pattern>    Filter code repo names to include, supports wildcards
  --delete-all                Delete all code repos and trees for this integration
  --concurrency <value>       Number of jobs that can be processed in parallel (default: "10")
  -h, --help                  display help for command

Environment variables:
  API_URL                     IcePanel API URL
  API_KEY                     IcePanel API key
  AZURE_DEVOPS_URL            Azure DevOps URL
  AZURE_DEVOPS_TOKEN          Azure DevOps token
  AZURE_DEVOPS_ORGANIZATION   Azure DevOps organization name, comma seperated
  SYNC_INTERVAL               Interval for syncronization
  FORCE                       Force refresh of code repos and trees
  FILTER_REPOS                Filter code repo names to include, supports wildcards
  CONCURRENCY                 Number of jobs that can be processed in parallel
  LOG_LEVEL                   Options are fatal, error, warn, info, debug, trace, silent
```

--------------------------------

### Copy IcePanel Flow as Text Output Example

Source: https://docs.icepanel.io/visual-storytelling

This snippet illustrates the format of an IcePanel flow when copied as plain text. It presents steps chronologically, detailing object names, step types, titles, connection names, and paths, which is useful for appending to image or PDF diagrams.

```Text
Introduction: Notes about this flow
- Step 1: User: This happens first
- Step 2: User -> API service: Thing happens via Request PNG or PDF export
- Step 3: API service -> Export topic: Then this happens via Publish export request
```

--------------------------------

### Fetch IcePanel Organization Landscapes using Curl

Source: https://docs.icepanel.io/integrations/rest-api

An example `curl` command demonstrating how to retrieve a list of landscapes for a specific organization via the IcePanel REST API. It includes setting the `Accept` header for JSON responses and the necessary `Authorization` header with your API key.

```bash
curl 'https://api.icepanel.io/v1/organizations/{organizationId}/landscapes' \
  -H 'Accept: application/json' \
  -H 'Authorization: ApiKey SH5XAiWtgevC2ZfQym3i:17a9c60035eed62c8f4f195c754ee6972ffc40ce975c5571ec521f463ebefa7f'
```

--------------------------------

### IcePanel CLI Docker Run with Environment Variables for Azure DevOps Sync

Source: https://docs.icepanel.io/integrations/code-repo-linking/azure-devops

This command illustrates an alternative method to run the IcePanel CLI Docker image for Azure DevOps synchronization. It utilizes environment variables to provide the necessary configuration details such as the IcePanel API key, Azure DevOps URL, personal access token, and organization.

```Shell
docker run \
  -e API_KEY=$ICEPANEL_KEY \
  -e AZURE_DEVOPS_URL=https://dev.azure.com \
  -e AZURE_DEVOPS_TOKEN=$AZURE_DEVOPS_TOKEN \
  -e AZURE_DEVOPS_ORGANIZATION=$AZURE_DEVOPS_ORGANIZATION \
  icepanel/cli azure-devops-sync
```

--------------------------------

### IcePanel CLI github-sync Command Reference

Source: https://docs.icepanel.io/integrations/code-repo-linking/github

Comprehensive documentation for the `IcePanel github-sync` command, detailing its purpose, available command-line options, and corresponding environment variables for configuration. This reference is crucial for understanding and customizing the synchronization process.

```APIDOC
Usage: IcePanel github-sync [options]

Syncronize IcePanel code repos with a GitHub instance

Options:
  --api-url <value>         IcePanel API URL (default: "https://api.icepanel.io/v1")
  -k, --api-key <value>     IcePanel API key
  -s, --url <value>         GitHub URL (default: "https://api.github.com")
  -t, --token <value>       GitHub token
  -i, --interval <secs>     Interval for syncronization (default: "1800")
  -f, --force               Force refresh of code repos and trees
  --filter-repos <pattern>  Filter code repo names to include, supports wildcards
  --delete-all              Delete all code repos and trees for this integration
  --concurrency <value>     Number of jobs that can be processed in parallel (default: "10")
  -h, --help                display help for command

Environment variables:
  API_URL             IcePanel API URL
  API_KEY             IcePanel API key
  GITHUB_URL          GitHub URL
  GITHUB_TOKEN        GitHub token
  SYNC_INTERVAL       Interval for syncronization
  FORCE               Force refresh of code repos and trees
  FILTER_REPOS        Filter code repo names to include, supports wildcards
  CONCURRENCY         Number of jobs that can be processed in parallel
  LOG_LEVEL           Options are fatal, error, warn, info, debug, trace, silent
```

--------------------------------

### IcePanel CLI GitHub Sync with Command Line Arguments

Source: https://docs.icepanel.io/integrations/code-repo-linking/github

This Docker command runs the IcePanel CLI in `github-sync` mode, connecting to a specified GitHub URL using an API key and GitHub token provided as command-line arguments. It's used for synchronizing code repositories from a GitHub instance into IcePanel.

```docker
docker run icepanel/cli github-sync \
  --api-key $ICEPANEL_KEY \
  --url <https://github.com> \
  --token $GITHUB_TOKEN
```

--------------------------------

### Full IcePanel REST API Reference Documentation

Source: https://docs.icepanel.io/integrations/rest-api

This entry provides a direct link to the comprehensive and detailed API reference documentation. It contains complete specifications for all endpoints, request/response schemas, and usage guidelines for the IcePanel REST API.

```APIDOC
Refer to: https://developer.icepanel.io/api-reference/
```

--------------------------------

### IcePanel CLI GitHub Sync with Environment Variables

Source: https://docs.icepanel.io/integrations/code-repo-linking/github

This Docker command provides an alternative way to run the IcePanel CLI for GitHub synchronization, configuring the API key, GitHub URL, and GitHub token via environment variables. This method is often preferred for automation or container orchestration.

```docker
docker run \
  -e API_KEY=$ICEPANEL_KEY \
  -e GITHUB_URL=https://github.com \
  -e GITHUB_TOKEN=$GITHUB_TOKEN \
  icepanel/cli github-sync
```

--------------------------------

### Export Backstage Entities to JSON using cURL

Source: https://docs.icepanel.io/core-features/imports

This cURL command demonstrates how to fetch all entities from the Backstage catalog API and save them to a local JSON file. This is a crucial initial step for preparing Backstage data for import into IcePanel.

```bash
curl https://demo.backstage.io/api/catalog/entities --output entities.json
```

--------------------------------

### Okta SAML Application Settings for IcePanel

Source: https://docs.icepanel.io/other-information/sso-saml

Configuration details for creating a SAML 2.0 application in Okta to connect with IcePanel, including Single Sign-On URL, Audience URI, Name ID format, and Application username.

```APIDOC
Okta SAML Settings:
  Single sign on URL: https://app.icepanel.io/__/auth/handler
  Audience URI (SP Entity ID): icepanel.io
  Name ID format: email address
  Application username: email
```

--------------------------------

### Export IcePanel Flow Steps as Plain Text

Source: https://docs.icepanel.io/visual-storytelling/flows

This snippet demonstrates the format of an IcePanel flow when copied as plain text. It chronologically lists object names, step types, step titles, connection names, and paths, making it suitable for documentation alongside diagram images or PDFs.

```Text
Introduction: Notes about this flow
- Step 1: User: This happens first
- Step 2: User -> API service: Thing happens via Request PNG or PDF export
- Step 3: API service -> Export topic: Then this happens via Publish export request
```

--------------------------------

### Common SAML Configuration Parameters for IcePanel Integration

Source: https://docs.icepanel.io/other-information/sso-saml

These are the standard Assertion Consumer Service (ACS) URL and Service Provider (SP) Entity ID required for configuring any SAML 2.0 identity provider to work with IcePanel.

```APIDOC
SAML Configuration Parameters:
  ACS URL / Reply URL: https://app.icepanel.io/__/auth/handler
  Entity ID / Identifier: icepanel.io
```

--------------------------------

### Embed IcePanel Diagram in SharePoint using iFrame Code

Source: https://docs.icepanel.io/collaboration/sharing

This HTML iFrame snippet provides the recommended structure for embedding IcePanel landscapes or diagrams into SharePoint. It specifies the source URL, default height and width, and a title for the embedded content. Users should replace the placeholder '____' with their specific IcePanel share link and can adjust dimensions as needed.

```HTML
<iframe src="s.icepanel.io/____" height="800" width="1200" title="Your landscape / diagram name"></iframe>
```

--------------------------------

### Google Workspace SAML Application Settings for IcePanel

Source: https://docs.icepanel.io/other-information/sso-saml

Specific settings to configure within Google Workspace for the custom SAML application, including the application name, ACS URL, Entity ID, Name ID format, and user access.

```APIDOC
Google Workspace SAML Settings:
  App Name: IcePanel
  ACS URL: https://app.icepanel.io/__/auth/handler
  Entity ID: icepanel.io
  Name ID format: EMAIL
  Name ID: Primary email
  User Access: ON for everyone
```

--------------------------------

### Microsoft Entra ID SAML Application Settings for IcePanel

Source: https://docs.icepanel.io/other-information/sso-saml

Required configuration for setting up a non-gallery SAML application in Microsoft Entra ID (Azure AD) for IcePanel integration, specifying Identifier (Entity ID) and Reply URL.

```APIDOC
Microsoft Entra ID SAML Settings:
  App Name: IcePanel
  Identifier (Entity ID): icepanel.io
  Reply URL (Assertion Consumer Service URL): https://app.icepanel.io/__/auth/handler
```

--------------------------------

### Authenticate IcePanel REST API Requests with API Key

Source: https://docs.icepanel.io/integrations/rest-api

This snippet illustrates the required `Authorization` HTTP header format for making authenticated requests to the IcePanel REST API. It specifies using the `ApiKey` scheme followed by your unique generated key.

```HTTP
Authorization: ApiKey SH5XAiWtgevC2ZfQym3i:17a9c60035eed62c8f4f195c754ee6972ffc40ce975c5571ec521f463ebefa7f
```

--------------------------------

### IcePanel C4 Model Object Structure and Properties

Source: https://docs.icepanel.io/core-features/modelling

Defines the hierarchical structure of model objects within IcePanel, adhering to the C4 model, and enumerates the detailed properties available for configuration on each object type.

```APIDOC
IcePanel Model Object Hierarchy:
  Organization
    Landscape
      Domain
        Actor
        Group
        System
          App or Store
            Component

Model Object Common Properties:
  Icon: string (linked to technology choices)
  Name: string
  Connections: array of Connection objects
  History: array of HistoryEntry objects
  Team edit access: boolean (Growth plan only)
  Internal or external object type: string ('internal' | 'external')
  Abstraction: string ('Actor' | 'System' | 'Group' | 'App' | 'Store' | 'Component')
  Status: string ('Live' | 'future' | 'deprecated' | 'removed')
  Domain: string (Growth plan only)
  Ownership team: string (Growth plan only)
  Diagrams list: array of Diagram objects
  Flows list: array of Flow objects
  Tags: array of string
  Display description: string
  Technology choices: array of TechnologyChoice objects
  Reality or generic links: array of Link objects
  Detailed description: string
```

--------------------------------

### IcePanel Model Connections CSV Export Fields

Source: https://docs.icepanel.io/core-features/export

This section defines the structure and fields included when exporting IcePanel model connections to CSV format. It details the properties of both the sender and receiver objects involved in the connection, as well as attributes specific to the connection itself, such as name, status, direction, and description.

```APIDOC
ModelConnectionCSV:
  fields:
    - Identifier: Unique identifier for the connection.
    - Sender Belongs Inside: The system/app/store the sender object is contained within.
    - Sender Object Name: The display name of the sender object.
    - Sender Object Type: The classification or type of the sender object.
    - Sender Object External: Indicates if the sender object is external.
    - Sender Object Tags: Tags associated with the sender object.
    - Sender Object Technology: The technology stack or primary technology related to the sender object.
    - Sender Object Teams: Teams responsible for or associated with the sender object.
    - Connection Name: The display name of the connection.
    - Connection Status: The current status of the connection.
    - Connection Direction: The direction of the connection (e.g., unidirectional, bidirectional).
    - Connection Tags: Tags associated with the connection.
    - Connection Technology: The technology used for the connection.
    - Connection Description: A detailed description of the connection.
    - Receiver Belongs Inside: The system/app/store the receiver object is contained within.
    - Receiver Object Name: The display name of the receiver object.
    - Receiver Object Type: The classification or type of the receiver object.
    - Receiver Object External: Indicates if the receiver object is external.
    - Receiver Object Tags: Tags associated with the receiver object.
    - Receiver Object Technology: The technology stack or primary technology related to the receiver object.
    - Receiver Object Teams: Teams responsible for or associated with the receiver object.
```

--------------------------------

### IcePanel Model Objects CSV Export Fields

Source: https://docs.icepanel.io/core-features/export

This section defines the structure and fields included when exporting IcePanel model objects to CSV format. It provides a comprehensive list of metadata associated with each object, such as identifiers, names, types, statuses, tags, and links.

```APIDOC
ModelObjectCSV:
  fields:
    - Identifier: Unique identifier for the object.
    - Belongs Inside System: The system the object is contained within.
    - Belongs Inside App: The application the object is contained within.
    - Belongs Inside Store: The store the object is contained within.
    - Object Name: The display name of the object.
    - Object Type: The classification or type of the object.
    - Object Status: The current status of the object.
    - Object External: Indicates if the object is external to the primary scope.
    - Object Displayed Description: A concise description displayed for the object.
    - Object Tags: Tags associated with the object for categorization.
    - Object Technology: The technology stack or primary technology related to the object.
    - Object Teams: Teams responsible for or associated with the object.
    - Object Link: A direct link to the object within IcePanel.
    - Object Share Link: A shareable link for the object.
    - Object Description: A detailed description of the object.
```
Tokens:
Raw