Skip to main content
POST
/
organizations
/
{organizationId}
/
technologies
Create
curl --request POST \
  --url https://api.icepanel.io/v1/organizations/{organizationId}/technologies \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "blue",
  "name": "<string>",
  "provider": "aws",
  "restrictions": [
    "actor"
  ],
  "type": "data-storage",
  "category": "<string>",
  "deprecatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "docsUrl": "<string>",
  "iconUrlDark": [
    "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
    "/dark/{catalogTechnologyId}.png"
  ],
  "iconUrlLight": [
    "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
    "/light/{catalogTechnologyId}.png"
  ],
  "nameShort": "<string>",
  "rejectionMessage": "<string>",
  "rejectionReason": "duplicate",
  "status": "approved",
  "updatesUrl": "<string>",
  "websiteUrl": "<string>"
}
'
{
  "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": "2023-11-07T05:31:56Z",
    "createdBy": "user",
    "createdById": "<string>",
    "disabled": false,
    "iconUrl": "<string>",
    "id": "<string>",
    "organizationId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "user",
    "updatedById": "<string>",
    "category": "<string>",
    "deprecatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "docsUrl": "<string>",
    "nameShort": "<string>",
    "rejectionMessage": "<string>",
    "rejectionReason": "duplicate",
    "status": "approved",
    "updatesUrl": "<string>",
    "websiteUrl": "<string>",
    "awsXmlSelector": "<string>",
    "azureUpdatesKeyword": "<string>",
    "defaultSlug": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedBy": "user",
    "deletedById": "<string>",
    "slugs": [
      "<string>"
    ],
    "updatesXmlUrl": "<string>"
  }
}

Headers

​
Authorization
string
required

Path Parameters

​
organizationId
string
required

Body

application/json
​
color
enum<string>
required

Technology color used in diagrams

Available options:
blue,
green,
yellow,
orange,
red,
beaver,
dark-blue,
purple,
pink,
white,
grey,
black
​
name
string
required

Long verbose name

​
provider
enum<string> | null
required

Service provider that provides this technology

Available options:
aws,
azure,
gcp,
microsoft,
salesforce,
atlassian,
apache,
supabase,
​
restrictions
enum<string>[] | null
required

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

Available options:
actor,
app,
component,
connection,
group,
store,
system,
​
type
enum<string> | null
required

Type or category of technology

Available options:
data-storage,
deployment,
framework-library,
gateway,
other,
language,
message-broker,
network,
protocol,
runtime,
service-tool,
​
category
string
​
deprecatedAt
string<date-time>
​
description
string

Technical description for the technology, avoid marketing language

​
docsUrl
string

Documentation or readme url

​
iconUrlDark
string | null

Icon that only works on dark backgrounds

Example:
[
  "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
  "/dark/{catalogTechnologyId}.png"
]
​
iconUrlLight
string | null

Icon that only works on light backgrounds

Example:
[
  "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
  "/light/{catalogTechnologyId}.png"
]
​
nameShort
string

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

​
rejectionMessage
string

If rejected, detail description of why

​
rejectionReason
enum<string>

If rejected, the reason why

Available options:
duplicate,
incomplete,
invalid,
other
​
status
enum<string>

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

Available options:
approved,
pending-review,
rejected
​
updatesUrl
string

Release notes or changelog url

​
websiteUrl
string

Landing page website url

Response

OK

​
catalogTechnology
object
required