Create | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.shareLink.create("landscapeId", "versionId", {
        body: {
            protected: true,
        },
    });
}
main();

{
  "defaultUrl": "string",
  "shareLink": {
    "protected": true,
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "landscapeId": "string",
    "shortId": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "versionId": "string",
    "password": "string",
    "draftId": "string"
  },
  "url": "string"
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Request

This endpoint expects an object.

protectedbooleanRequired

passwordstringOptionalformat: "password"8-64 characters

draftIdstring or nullOptional

Response

defaultUrlstringformat: "uri"

Share link url with default options encoded in the path

shareLinkobject

urlstringformat: "uri"

Share link url prefix, you need to append the options short id onto a trailing path segment

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error