Update | IcePanel Developer Docs

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

{
  "flow": {
    "commit": 1.1,
    "index": 1.1,
    "labels": {},
    "name": "string",
    "pinned": true,
    "showAllSteps": true,
    "showConnectionNames": true,
    "steps": {},
    "diagramId": "string",
    "handleId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "landscapeId": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "pinnedAt": "2024-01-15T09:30:00Z",
    "pinnedIndex": 1.1,
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "latestEntityId": "string",
    "viewedAt": "2024-01-15T09:30:00Z",
    "viewedBy": "user",
    "viewedById": "string"
  }
}

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

flowIdstringRequired

Request

This endpoint expects an object.

commitdoubleOptional

indexdoubleOptional

labelsmap from strings to stringsOptional

namestringOptional

pinnedbooleanOptional

pinnedAtdatetimeOptional

pinnedIndexdoubleOptional

showAllStepsbooleanOptional

showConnectionNamesbooleanOptional

stepsobjectOptional

Response

flowobject

Authentication

Path parameters

Request

Response

Errors