Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.incident.io/llms.txt

Use this file to discover all available pages before exploring further.

​
The catalog type object

​
annotations
object
required

Annotations that can track metadata about this type

Example:
{
  "incident.io/catalog-importer/id": "id-of-config"
}
​
categories
enum<string>[]
required

What categories is this type considered part of

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

Sets the display color of this type in the dashboard

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

"yellow"

​
created_at
string<date-time>
required

When this type was created

Example:

"2021-08-17T13:28:57.801578Z"

​
description
string
required

Human readble description of this type

Example:

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

​
icon
enum<string>
required

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"

​
id
string
required

ID of this catalog type

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
is_editable
boolean
required

Catalog types that are synced with external resources can't be edited

Example:

false

​
name
string
required

Name is the human readable name of this type

Example:

"Kubernetes Cluster"

​
ranked
boolean
required

If this type should be ranked

Example:

true

​
schema
object
required
Example:
{
  "attributes": [
    {
      "array": false,
      "backlink_attribute": "abc123",
      "id": "01GW2G3V0S59R238FAHPDS1R66",
      "mode": "",
      "name": "tier",
      "path": [
        {
          "attribute_id": "abc123",
          "attribute_name": "abc123"
        }
      ],
      "type": "Custom[\"Service\"]"
    }
  ],
  "version": 1
}
​
type_name
string
required

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\"]"

​
updated_at
string<date-time>
required

When this type was last updated

Example:

"2021-08-17T13:28:57.801578Z"

​
use_name_as_identifier
boolean
required

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

Example:

true

​
dynamic_resource_parameter
string

If this is a dynamic catalog type, this will be the unique parameter for identitfying this resource externally.

Example:

"abc123"

​
estimated_count
integer<int64>

If populated, gives an estimated count of entries for this type

Example:

7

​
is_team_type
boolean

Whether this catalog type is the designated team type in team settings

Example:

false

​
last_synced_at
string<date-time>

When this type was last synced (if it's ever been sync'd)

Example:

"2021-08-17T13:28:57.801578Z"

​
registry_type
string

The registry resource this type is synced from, if any

Example:

"PagerDutyService"

​
required_integrations
string[]

If populated, the integrations required for this type

Example:
["pager_duty"]
​
source_repo_url
string

The url of the external repository where this type is managed

Example:

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