Developer Guide Core Concepts API Reference

API Reference

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

Was this page helpful?

List