Sign In

Custom Types and Fields

Create custom entity types to model your specific infrastructure and business needs.

Prerequisites

  • Access to an Upstat project with Contributor or higher role

1. Create a Custom Entity Type

Navigate to Catalog in the sidebar and click the Custom Entity Type card.

Configure the entity type:

  1. Enter a Name (e.g., “Database”)
  2. Enter a Plural Name (e.g., “Databases”)
  3. Optionally add a Description
  4. Click Save

The new type appears in the Catalog alongside built-in types.

2. Add Custom Fields

Custom fields capture metadata for entities of this type.

While creating or editing an entity type:

  1. Click Add Field in the Fields section
  2. Enter the Field Name (internal identifier)
  3. Enter the Display Name (shown in the UI)
  4. Check Required if entities must have this field
  5. Add more fields as needed
  6. Click Save

Fields appear when creating or editing entities of this type.

3. Create an Entity

After creating an entity type, add entities to it:

  1. Click the entity type card in the Catalog
  2. Click New [Entity Type Name]
  3. Enter the Name and optional Description
  4. Fill in any custom field values
  5. Optionally select an Escalation Policy
  6. Click Save

4. Edit an Entity Type

Modify an existing entity type:

  1. Navigate to Catalog
  2. Click the menu button on the entity type card
  3. Select Edit
  4. Update the name, plural name, description, or fields
  5. Click Save

Changes to fields affect all entities of this type.

Result

You have custom entity types with fields that capture the metadata relevant to your operations. Entities of each type appear organized in the Catalog.

Field Guidelines

Keep fields lightweight and operational:

Field Example Value
Team Owner SRE
Environment Production
Repository URL github.com/org/repo
Slack Channel #alerts-payments
Last Review Date 2024-10-01

All field values are stored as text strings. Use fields for searchable metadata rather than complex data structures.