Update

PATCH

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

PATCH

/v1/landscapes/:landscapeId/versions/:versionId

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

Try it

200Updated

1 {
2   "version": {
3     "modelHandleId": "string",
4     "name": "string",
5     "notes": "string",
6     "createdAt": "2024-01-15T09:30:00Z",
7     "createdBy": "user",
8     "createdById": "string",
9     "diagramHandleIds": [
10       "string"
11     ],
12     "id": "string",
13     "landscapeId": "string",
14     "tags": [
15       "string"
16     ],
17     "updatedAt": "2024-01-15T09:30:00Z",
18     "updatedBy": "user",
19     "updatedById": "string",
20     "completedAt": "2024-01-15T09:30:00Z"
21   }
22 }

Authentication

X-API-Keystring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Request

This endpoint expects an object.

modelHandleIdstring or nullOptional

namestringOptional>=1 character

notesstringOptional>=10 characters

Response

versionobject

Authentication

Path parameters

Request

Response

Errors