API & SDK

Introduction

The IcePanel REST API is publicly accessible to write automated scripts or custom integrations with external tools. We also offer 2 SDKs. Feel free to reach out if you would like another SDK to be generated.

• Full API reference: https://developer.icepanel.io/api-reference/landscapes/get

• TypeScript SDK: https://github.com/IcePanel/icepanel-js

• Java SDK: https://github.com/IcePanel/icepanel-java

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'

Limits

The following API limits are in place:

Integrations	Free	Growth	Scale	Enterprise
API (read)	✗	10,000 requests / mo	Unlimited	Unlimited
API (write)	✗	1,000 requests / mo	Unlimited	Unlimited
Import API	✗	5 requests / mo	500 requests / mo	Unlimited
Export API	✗	5 requests / mo	500 requests / mo	Unlimited
MCP server	✗	✓	✓	✓

The limits restart at the beginning of each month.