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 entry object

​
aliases
string[]
required

Optional aliases that can be used to reference this entry

Example:
["lawrence@incident.io", "lawrence"]
​
attribute_values
object
required

Values of this entry

Example:
{
  "abc123": {
    "array_value": [
      {
        "label": "Lawrence Jones",
        "literal": "SEV123"
      }
    ],
    "value": {
      "label": "Lawrence Jones",
      "literal": "SEV123"
    }
  }
}
​
catalog_type_id
string
required

ID of this catalog type

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
created_at
string<date-time>
required

When this entry was created

Example:

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

​
id
string
required

ID of this catalog entry

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
name
string
required

Name is the human readable name of this entry

Example:

"Primary On-call"

​
rank
integer<int32>
required

When catalog type is ranked, this is used to help order things

Example:

3

​
updated_at
string<date-time>
required

When this entry was last updated

Example:

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

​
archived_at
string<date-time>

When this entry was archived

Example:

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

​
external_id
string

An optional alternative ID for this entry, which is ensured to be unique for the type

Example:

"761722cd-d1d7-477b-ac7e-90f9e079dc33"