Entities¶
An entity is a concrete instance of a blueprint — a specific database, API, worker, or any infrastructure component you want to track. Entities carry field values, a current health status, and a full history of state transitions.
Anatomy of an entity¶
| Field | Type | Description |
|---|---|---|
slug |
string | URL-safe identifier, unique per blueprint |
name |
string | Human-readable label |
blueprint_id |
UUID | The blueprint this entity belongs to |
current_status |
enum | up, degraded, down, unknown |
status_changed_at |
timestamp | When the status last changed |
fields |
array | Key-value pairs matching the blueprint's field defs |
Creating an entity¶
Listing entities¶
Updating an entity¶
Deleting an entity¶
Warning
Deleting an entity also deletes all its checks and check results. State transitions are preserved in the audit log.
Status lifecycle¶
Entities start at unknown. As checks run, status evolves automatically:
unknown → up (first successful check)
up → degraded (threshold consecutive failures, not yet fully down)
up → down (threshold failures, no degraded intermediate)
down → up (recovery)
See State Machine for the full transition rules.