Create | IcePanel Developer Docs

curl -X POST https://api.icepanel.io/v1/landscapes/landscapeId/versions/latest/adrs \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "status": "accepted",
  "handleId": "string"
}'

{
  "adr": {
    "commit": 1.1,
    "name": "string",
    "status": "accepted",
    "handleId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "landscapeId": "string",
    "number": 1.1,
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "content": "string",
    "description": "string",
    "relatedItems": {},
    "statusChanges": [
      {
        "createdAt": "2024-01-15T09:30:00Z",
        "createdBy": "user",
        "createdById": "string",
        "status": "accepted"
      }
    ],
    "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

landscapeIdstringRequiredformat: "id"

versionIdstring or enumRequired

Request

This endpoint expects an object.

namestringRequired<=1000 characters

The name of the ADR

statusenumRequired

The status of the ADR

handleIdstringRequiredformat: "handle-id"

The handle id of the ADR

commitdoubleOptional>=0

contentstringOptional<=100000 characters

The markdown content of the ADR

descriptionstringOptional<=100000 characters

The description of the ADR

relatedItemsmap from strings to objectsOptional

statusChangeslist of objectsOptional

Response

adrobject

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