Skip to main content
POST
Create Type

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Body

application/json
description
string
required

Human readble description of this type

Example:

"Represents Kubernetes clusters that we run inside of GKE."

name
string
required

Name is the human readable name of this type

Example:

"Kubernetes Cluster"

annotations
object

Annotations that can track metadata about this type

Example:
categories
enum<string>[]

What categories is this type considered part of

Available options:
customer,
issue-tracker,
product-feature,
service,
on-call,
team,
user
Example:
color
enum<string>

Sets the display color of this type in the dashboard

Available options:
yellow,
green,
blue,
violet,
pink,
cyan,
orange
Example:

"yellow"

icon
enum<string>

Sets the display icon of this type in the dashboard

Available options:
alert,
bolt,
box,
briefcase,
browser,
bulb,
calendar,
clock,
cog,
components,
database,
doc,
email,
escalation-path,
files,
flag,
folder,
globe,
money,
server,
severity,
status-page,
store,
star,
tag,
user,
users
Example:

"alert"

owning_team_ids
string[]

IDs of the teams that own this catalog type

Example:
ranked
boolean

If this type should be ranked

Example:

true

source_repo_url
string

The url of the external repository where this type is managed

Example:

"https://github.com/my-company/incident-io-catalog"

type_name
string

The type name of this catalog type, to be used when defining attributes. This is immutable once a CatalogType has been created. For non-externally sync types, it must follow the pattern Custom["SomeName"]

Example:

"Custom[\"BackstageGroup\"]"

use_name_as_identifier
boolean

If enabled, you can refer to entries of this type by their name, as well as their external ID and any aliases.

Example:

true

Response

201 - application/json

Created response.

catalog_type
object
required