Update | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.organizations.technologies.update("organizationId", "catalogTechnologyId", {
        body: {},
    });
}
main();

{
  "catalogTechnology": {
    "color": "blue",
    "iconUrlDark": [
      "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
      "/dark/{catalogTechnologyId}.png"
    ],
    "iconUrlLight": [
      "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
      "/light/{catalogTechnologyId}.png"
    ],
    "name": "string",
    "provider": "aws",
    "restrictions": [
      "actor"
    ],
    "type": "data-storage",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "disabled": false,
    "id": "string",
    "organizationId": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "iconUrl": "string",
    "category": "string",
    "deprecatedAt": "2024-01-15T09:30:00Z",
    "description": "string",
    "docsUrl": "string",
    "nameShort": "string",
    "rejectionMessage": "string",
    "rejectionReason": "duplicate",
    "status": "approved",
    "updatesUrl": "string",
    "websiteUrl": "string",
    "awsXmlSelector": "string",
    "azureUpdatesKeyword": "string",
    "defaultSlug": "string",
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "slugs": [
      "string"
    ],
    "updatesXmlUrl": "string"
  }
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

organizationIdstringRequired

catalogTechnologyIdstringRequired

Request

This endpoint expects an object.

categorystringOptional<=1000 characters

colorenumOptional

Technology color used in diagrams

deprecatedAtdatetimeOptional

descriptionstringOptional<=10000 characters

Technical description for the technology, avoid marketing language

docsUrlstringOptional<=2048 characters

Documentation or readme url

iconUrlDarkstring or nullOptional<=2048 characters

Icon that only works on dark backgrounds

iconUrlLightstring or nullOptional<=2048 characters

Icon that only works on light backgrounds

namestringOptional<=1000 characters

Long verbose name

nameShortstringOptional<=1000 characters

Short one or two word name to show in places with limited space

providerenumOptional

Service provider that provides this technology

rejectionMessagestringOptional<=5000 characters

If rejected, detail description of why

rejectionReasonenumOptional

If rejected, the reason why

restrictionslist of enums or nullOptional

Restriction on which model object or connections this technology can be added to

statusenumOptional

Current status of the technology, including pending review, approved, and rejected. Approved technologies are visible to all users. Set to null to make the technology private.

typeenumOptional

Type or category of technology

updatesUrlstringOptional<=2048 characters

Release notes or changelog url

websiteUrlstringOptional<=2048 characters

Landing page website url

Response

catalogTechnologyobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error