Upsert | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.flows.upsert("landscapeId", "versionId", "flowId", {
        body: {
            name: "string",
            diagramId: "string",
        },
    });
}
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

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

flowIdstringRequired

Request

This endpoint expects an object.

namestringRequired

diagramIdstringRequired

commitdoubleOptional

indexdoubleOptional

labelsmap from strings to stringsOptional

pinnedbooleanOptional

pinnedAtdatetimeOptional

pinnedIndexdoubleOptional

showAllStepsbooleanOptional

showConnectionNamesbooleanOptional

stepsmap from strings to objectsOptional

handleIdstringOptional

Response

flowobject

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