Create | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        environment: "https://api.icepanel.io/v1",
    });
    await client.organizations.technologies.create("organizationId", {
        body: {
            color: "blue",
            name: "string",
            provider: "aws",
            restrictions: [
                "actor",
            ],
            type: "data-storage",
        },
    });
}
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 via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Request

This endpoint expects an object.

colorenumRequired

Technology color used in diagrams

namestringRequired

Long verbose name

providerenumRequired

Service provider that provides this technology

restrictionslist of enums or nullRequired

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

typeenumRequired

Type or category of technology

categorystringOptional

deprecatedAtdatetimeOptional

descriptionstringOptional

Technical description for the technology, avoid marketing language

docsUrlstringOptional

Documentation or readme url

iconUrlDarkstring or nullOptional

Icon that only works on dark backgrounds

iconUrlLightstring or nullOptional

Icon that only works on light backgrounds

nameShortstringOptional

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

rejectionMessagestringOptional

If rejected, detail description of why

rejectionReasonenumOptional

If rejected, the reason why

Allowed values:

statusenumOptional

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

Allowed values:

updatesUrlstringOptional

Release notes or changelog url

websiteUrlstringOptional

Landing page website url

Response

catalogTechnologyobject

Authentication

Path parameters

Request

Response

Errors