For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign upLog in
Developer GuideCore ConceptsAPI Reference
  • API Reference
      • GETList
      • POSTCreate
      • GETGet
      • PUTUpsert
      • DELDelete
      • PATCHUpdate
      • POSTMerge
LogoLogo
Sign upLog in
API ReferenceDrafts

Upsert

PUT
https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/drafts/:draftId
PUT
/v1/landscapes/:landscapeId/versions/:versionId/drafts/:draftId
1import { IcePanelClient } from "@icepanel/sdk";
2
3async function main() {
4    const client = new IcePanelClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.drafts.upsert("landscapeId", "versionId", "draftId", {
8        body: {
9            name: "string",
10            status: "in-progress",
11        },
12    });
13}
14main();
1{
2  "draft": {
3    "commit": 1.1,
4    "handleId": "string",
5    "labels": {},
6    "name": "string",
7    "status": "in-progress",
8    "createdAt": "2024-01-15T09:30:00Z",
9    "createdBy": "user",
10    "createdById": "string",
11    "id": "string",
12    "landscapeId": "string",
13    "originVersionId": "string",
14    "updatedAt": "2024-01-15T09:30:00Z",
15    "updatedBy": "user",
16    "updatedById": "string",
17    "version": 1.1,
18    "versionId": "string",
19    "changeSummary": {
20      "createdAt": "2024-01-15T09:30:00Z",
21      "summary": "string",
22      "updatedAt": "2024-01-15T09:30:00Z"
23    },
24    "summaryDirtiedAt": "2024-01-15T09:30:00Z",
25    "deletedAt": "2024-01-15T09:30:00Z",
26    "deletedBy": "user",
27    "deletedById": "string",
28    "headVersionId": "string",
29    "latestEntityId": "string",
30    "mergedAt": "2024-01-15T09:30:00Z",
31    "mergedBy": "user",
32    "mergedById": "string",
33    "viewedAt": "2024-01-15T09:30:00Z",
34    "viewedBy": "user",
35    "viewedById": "string"
36  }
37}
Was this page helpful?
Previous

Delete

Next
Built with

Authentication

X-API-Keystring
API key authentication
OR
AuthorizationBearer
Bearer token authentication

Path parameters

landscapeIdstringRequired
versionIdstringRequired
draftIdstringRequired

Request

This endpoint expects an object.
namestringRequired<=4000 characters
statusenumRequired
Allowed values:
changeSummaryobjectOptional
commitdoubleOptional
handleIdstringOptional
labelsmap from strings to stringsOptional
summaryDirtiedAtdatetimeOptional

Response

OK
draftobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error