IcePanel Docs
  • 🧊Welcome
  • 🏁Getting started
  • Core Features
    • Modelling
      • Model objects view
      • Connections list
      • Groups
    • Diagramming
      • Diagrams section
    • Organizations
    • Landscapes
    • Domains
    • Global search
    • Dependencies view
    • Imports
    • Exports
  • COLLABORATION
    • Comments
    • Share links & embeds
  • Ownership teams
  • Roles & permissions
  • Visual Storytelling
    • Flows
      • Flows section
    • Tags
    • Technology choices
  • Future state design
    • Drafts
    • Versioning
  • Reality linking and integrations
    • Linking to reality
    • Code repo linking
      • GitLab
      • GitHub
      • Bitbucket Server
      • Azure DevOps
    • Inaccuracy score
    • REST API
  • 🎓Expert help
    • Training
    • Pilot
  • 🎨Templates
    • IcePanel
    • E-commerce
    • Low-code
    • Marketplace
    • RSS feed
    • Bank
  • ❓Other information
    • Glossary
    • SSO - SAML
    • UI theme
    • Hotkeys
    • Troubleshooting
Powered by GitBook
On this page
  • Introduction
  • Authentication
  • Example
  • API reference

Was this helpful?

  1. Reality linking and integrations

REST API

PreviousInaccuracy scoreNextTraining

Last updated 2 months ago

Was this helpful?

Introduction

The IcePanel REST API is publicly accessible to write automated scripts or custom integrations with external tools.

Authentication

First generate an API key on your organization management screen. Make sure to copy your key now as you won't be able to see it again for security reasons!

You can then set the Authorization HTTP header on any authenticated requests.

Authorization: ApiKey SH5XAiWtgevC2ZfQym3i:17a9c60035eed62c8f4f195c754ee6972ffc40ce975c5571ec521f463ebefa7f

Example

See the example below for how to request a list of projects using curl.

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

API reference

Checkout the full API reference here:

https://developer.icepanel.io/api-reference/