ICicepanel
Diagrams

Create

Changed on
post/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/export/image

Request

  • Base URL
    https://api.icepanel.io/v1
  • URL
    https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/export/image
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

landscapeIdstring required
versionIdstring required
diagramIdstring required

Request body

draftIdstring

Fetch and apply draft tasks before producing the export

flowIdstring
flowPathIdsstring[]
focusIdsstring[]
groupIdstring
hideIdsstring[]
maxWidthinteger

Maximum pixel width for the exported PNG. The image will be scaled down if the diagram exceeds this width. Defaults to no limit (up to 10240px).

pinIdsstring[]
tab'tags' | 'technology' | 'status' | 'teams'
theme'light' | 'dark'

Response

OK

Changes

  • 0fe4f00b60cfRevision changes
    • info

      added the non-success response with the status

  • 181c90adca5eRevision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status