Browsing the catalog
List services
Get service detail
Service fields
Key fields on the service catalog listing:| Field | Type | Description |
|---|---|---|
id | UUID | Unique service identifier |
slug | string | Human-readable identifier (e.g., github, stripe) |
name | string | Display name |
category | string | Service category (e.g., cloud-infrastructure, developer-tools) |
officialStatusUrl | string | Link to the vendor’s official status page |
overallStatus | string | Current health state |
activeIncidentCount | integer | Number of active incidents |
uptime30d | double | 30-day uptime percentage |
componentCount | integer | Number of tracked components |
adapterType | string | How DevHelm polls the service |
pollingIntervalSeconds | integer | How frequently the adapter polls |
dataCompleteness | string | How complete the historical data is |
Components
Services break down into components that represent functional parts — API, dashboard, webhooks, individual regions, CDN edges, etc. Each component tracks its own health status and uptime independently.Listing components
Component fields
| Field | Type | Description |
|---|---|---|
id | UUID | Unique component identifier |
name | string | Component display name (e.g., “Git Operations”, “API Requests”) |
status | string | Current health state |
description | string | What this component covers |
group | boolean | Whether this is a group that aggregates child components |
groupName | string | Parent group display name (for child components) |
showcase | boolean | Whether the component is highlighted on the service overview |
region | string | Geographic region (for region-specific components) |
uptime | object | Inline uptime summary (24h, 7d, 30d percentages) |
statusChangedAt | datetime | When the status last changed |
Group components
Some services organize their components hierarchically. A group component aggregates the status of its children — if any child is degraded, the group shows as degraded. Group components havegroup: true and child components reference their parent via groupId.
Component uptime
Get detailed uptime for a specific component:Overall status
TheoverallStatus field reflects the worst-case status across all components. A service shows as operational only when all non-hidden components are operational.
Live status
For real-time status without the full detail response:Global summary
Get a high-level summary across all services:Next steps
Dependencies
Add services to get notified when their status changes.
Service incidents
View active and historical incidents for tracked services.
Uptime data
Query historical availability percentages.
Status Data guide
End-to-end guide for working with Status Data.