---
title: "Export"
method: POST
path: "/landscapes/{landscapeId}/versions/{versionId}/export"
tags: ["Landscape"]
---

# Export

`POST /landscapes/{landscapeId}/versions/{versionId}/export`

Create a background job that exports a landscape in the specified format.

## Path parameters

- `landscapeId` string, required
- `versionId` string, required

## Query parameters

- `type` 'pdf' | 'markdown' | 'html' | 'llms' | 'json' | 'object-csv' | 'connection-csv', required
- `filter` LandscapeExportFilter
  - `diagramId` string
  - `flowId` string
  - `includeDiagrams` boolean — Whether or not to include diagrams in PDF exports, defaults to true
  - `includeFlows` boolean — Whether or not to include flows in PDF exports, defaults to true
  - `modelObjectId` string

## Request body

- LandscapeExportOptions
  - `draftId` string — Fetch and apply draft tasks before producing the export
  - `orientation` 'portrait' | 'landscape'
  - `schema` 'v1' | 'v2' — Schema version to use for JSON exports. `v1` (default) produces the legacy format where entities are keyed objects. `v2` produces the same structure as the `LandscapeImportData` used by the import endpoint, so an export can be imported directly.

## Response `200`

OK

- object
  - `landscapeExport` LandscapeExport, required
    - `completedAt` string, date-time
    - `createdAt` string, date-time, required
    - `deleteAt` string, date-time, required
    - `error` string, nullable, required
    - `fileUrl` string, uri, nullable, required
    - `filter` LandscapeExportFilter
      - `diagramId` string
      - `flowId` string
      - `includeDiagrams` boolean — Whether or not to include diagrams in PDF exports, defaults to true
      - `includeFlows` boolean — Whether or not to include flows in PDF exports, defaults to true
      - `modelObjectId` string
    - `id` string, required
    - `landscapeId` string, required
    - `options` LandscapeExportOptions
      - `draftId` string — Fetch and apply draft tasks before producing the export
      - `orientation` 'portrait' | 'landscape'
      - `schema` 'v1' | 'v2' — Schema version to use for JSON exports. `v1` (default) produces the legacy format where entities are keyed objects. `v2` produces the same structure as the `LandscapeImportData` used by the import endpoint, so an export can be imported directly.
    - `type` 'pdf' | 'markdown' | 'html' | 'llms' | 'json' | 'object-csv' | 'connection-csv', required
    - `versionId` string, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `429` — Resource Exhausted
- `500` — Internal Server

## Changes

- **2026-08-19** `27e82759be89` — 4 info
  - the `orientation` request property default value `portrait` was removed
  - the `schema` request property default value `v1` was removed
  - the `orientation` response's property default value `portrait` was removed for the status `200`
  - the `schema` response's property default value `v1` was removed for the status `200`
- **2026-07-22** `0fe4f00b60cf` — 3 info
  - added the new optional request property `schema`
  - added the non-success response with the status `429`
  - added the optional property `landscapeExport/options/schema` to the response with the `200` status
- **2026-06-03** `181c90adca5e` — 2 warning, 3 info
  - added the new `connection-csv` enum value to the `landscapeExport/type` response property for the response status `200`
  - added the new `object-csv` enum value to the `landscapeExport/type` response property for the response status `200`
  - added the new enum value `connection-csv` to the `query` request parameter `type`
  - added the new enum value `object-csv` to the `query` request parameter `type`
  - …1 more

[Change history](https://skmtc.dev/icepanel/apis/icepanel-api/changes/landscapes/:landscapeId/versions/:versionId/export/post.md)

---

[API](https://skmtc.dev/icepanel/apis/icepanel-api.md) · [All operations](https://skmtc.dev/icepanel/apis/icepanel-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/icepanel/icepanel-api/revisions/a8ce98f67129/schema)