For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Sign up Log in

Developer Guide Core Concepts API Reference

API Reference

Get
Delete
Update
Duplicate
Copy
Search
List
Get
List Children
By Type
By Entity
Export
Status
Import
Status
Create Signed Icon URL
Get
List
Create
Get
Upsert
Delete
Update
List
Create
Get
Upsert
Delete
Update
List
Create
Get
Upsert
Delete
Update
Exists
List Thumbnails
Get Thumbnail
Get
Replace
Update
List
Create
Get
Upsert
Delete
Update
Exists
Get
Create
List
Create
Get
Upsert
Delete
Update
Exists
List
Create
Get
Upsert
Delete
Update
Merge
List
Create
Get
Upsert
Delete
Update
Exists
List Thumbnails
Get Thumbnail
Text
Code
Mermaid
List
Create
Get
Upsert
Delete
Update
Generate Description
CSV
List Dependencies
List
Create
Get
Upsert
Delete
Update
Dependencies JSON
CSV
List
Create
Get
Delete
Update
List
Create
List
Get
By Type
By Entity
List
Create
Get
Delete
Update
List
Delete
Update
List
Create
Revoke
Get
Create
Delete
Update
List
Create
Get
Upsert
Delete
Update
List
Create
Get
Upsert
Delete
Update
List
Create
Get
Delete
Update
List Landscapes
List Model Objects
List
Create
Get
Delete
Update
List
Create
Get
Update

Sign up Log in

API Reference Share Link

Update

PATCH

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/share-link

PATCH

/v1/landscapes/:landscapeId/versions/:versionId/share-link

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.shareLink.update("landscapeId", "versionId", {
8         body: {},
9     });
10 }
11 main();

1 {
2   "shareLink": {
3     "protected": true,
4     "createdAt": "2024-01-15T09:30:00Z",
5     "createdBy": "user",
6     "createdById": "string",
7     "id": "string",
8     "landscapeId": "string",
9     "shortId": "string",
10     "updatedAt": "2024-01-15T09:30:00Z",
11     "updatedBy": "user",
12     "updatedById": "string",
13     "versionId": "string",
14     "password": "string",
15     "draftId": "string"
16   }
17 }

Authentication

X-API-Keystring

API key authentication

OR

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

resetShortIdbooleanOptional

Request

This endpoint expects an object.

passwordstringOptionalformat: "password"8-64 characters

protectedbooleanOptional

Response

OK

shareLinkobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error

Was this page helpful?