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

Our OpenAPI 3.1 specification can be found at api.icepanel.io and opened by importing it into Postman.

Authentication

First, generate an API key on your organization management screen. Make sure to copy your key and set the X-API-Key HTTP header on any authenticated requests.

X-API-Key: SH5XAiWtgevC2ZfQym3i:17a9c60035eed62c8f4f195c754ee6972ffc40ce975c5571ec521f463ebefa7f

Example

See the example below for how to request a list of landscapes.

1
import { IcePanelClient } from "@icepanel/sdk";
2
3
async function main() {
4
    const client = new IcePanelClient({
5
        apiKey: "YOUR_API_KEY_HERE",
6
    });
7
    await client.organizations.landscapes.list("organizationId");
8
}
9
main();