Update | IcePanel Developer Docs

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

{
  "tag": {
    "color": "blue",
    "commit": 1.1,
    "groupId": "string",
    "index": 1.1,
    "labels": {},
    "name": "string",
    "handleId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "landscapeId": "string",
    "modelConnectionIds": [
      "string"
    ],
    "modelObjectIds": [
      "string"
    ],
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "latestEntityId": "string"
  }
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

tagIdstringRequired

Request

This endpoint expects an object.

colorenumOptional

commitdoubleOptional

groupIdstringOptional

indexdoubleOptional

labelsmap from strings to stringsOptional

namestringOptional

Response

tagobject

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error