For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign upLog in
Developer GuideCore ConceptsAPI Reference
  • API Reference
      • GETGet
      • DELDelete
      • PATCHUpdate
      • POSTDuplicate
      • POSTCopy
      • GETSearch
        • POSTExport
        • GETStatus
LogoLogo
Sign upLog in
API ReferenceLandscapesExport

Status

GET
https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/export/:landscapeExportId
GET
/v1/landscapes/:landscapeId/versions/:versionId/export/:landscapeExportId
1import { IcePanelClient } from "@icepanel/sdk";
2
3async function main() {
4    const client = new IcePanelClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.landscapes.export.get("landscapeId", "versionId", "landscapeExportId");
8}
9main();
1{
2  "landscapeExport": {
3    "createdAt": "2024-01-15T09:30:00Z",
4    "deleteAt": "2024-01-15T09:30:00Z",
5    "error": "string",
6    "fileUrl": "string",
7    "id": "string",
8    "landscapeId": "string",
9    "type": "pdf",
10    "versionId": "string",
11    "completedAt": "2024-01-15T09:30:00Z",
12    "filter": {
13      "diagramId": "string",
14      "flowId": "string",
15      "includeDiagrams": true,
16      "includeFlows": true,
17      "modelObjectId": "string"
18    },
19    "options": {
20      "draftId": "string",
21      "orientation": "portrait"
22    }
23  }
24}
Get the status of a landscape export job.
Was this page helpful?
Previous

Import

Next
Built with

Authentication

X-API-Keystring
API key authentication
OR
AuthorizationBearer
Bearer token authentication

Path parameters

landscapeIdstringRequired
versionIdstringRequired
landscapeExportIdstringRequired

Response

OK
landscapeExportobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error