> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Services

> Browse and explore tracked services and their components in the DevHelm Status Data catalog

The Status Data catalog contains hundreds of services — cloud providers, SaaS tools, payment processors, and infrastructure vendors — each tracked by adapters that poll their status pages. Browse the catalog to find services you depend on, view their current health, and drill into component-level detail.

## Browsing the catalog

### List services

<CodeGroup>
  ```bash CLI theme={null}
  devhelm services list
  devhelm services list --search stripe
  devhelm services list --category cloud-infrastructure
  ```

  ```bash API theme={null}
  curl "https://api.devhelm.io/api/v1/services?limit=20"

  curl "https://api.devhelm.io/api/v1/services?search=stripe"

  curl "https://api.devhelm.io/api/v1/services?category=cloud-infrastructure&limit=20"
  ```
</CodeGroup>

Use `--search` (API: `search`) for a case-insensitive match on service name or slug. The service list is cursor-paginated. Each entry includes the service name, slug, category, overall status, active incident count, and 30-day uptime percentage.

### Get service detail

<CodeGroup>
  ```bash CLI theme={null}
  devhelm services get github
  ```

  ```bash API theme={null}
  curl https://api.devhelm.io/api/v1/services/github
  ```
</CodeGroup>

The detail response includes the full service profile plus current status, components, recent incidents, uptime summary, and active maintenances.

## 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

<CodeGroup>
  ```bash CLI theme={null}
  devhelm services components github
  ```

  ```bash API theme={null}
  curl https://api.devhelm.io/api/v1/services/github/components
  ```
</CodeGroup>

### 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 have `group: true` and child components reference their parent via `groupId`.

### Component uptime

Get detailed uptime for a specific component:

```bash theme={null}
curl "https://api.devhelm.io/api/v1/services/github/components/<component-id>/uptime?period=30d" \
  -H "Authorization: Bearer $DEVHELM_API_TOKEN"
```

## Overall status

The `overallStatus` 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:

<CodeGroup>
  ```bash CLI theme={null}
  devhelm services status github
  ```

  ```bash API theme={null}
  curl https://api.devhelm.io/api/v1/services/github/live-status
  ```
</CodeGroup>

## Categories

List all categories with service counts:

<CodeGroup>
  ```bash CLI theme={null}
  devhelm services categories
  ```

  ```bash API theme={null}
  curl https://api.devhelm.io/api/v1/categories
  ```
</CodeGroup>

## Global summary

Get a high-level summary across all services:

<CodeGroup>
  ```bash CLI theme={null}
  devhelm services summary
  ```

  ```bash API theme={null}
  curl https://api.devhelm.io/api/v1/services/summary
  ```
</CodeGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Dependencies" icon="link" href="/status-data/dependencies">
    Add services to get notified when their status changes.
  </Card>

  <Card title="Service incidents" icon="circle-exclamation" href="/status-data/incidents">
    View active and historical incidents for tracked services.
  </Card>

  <Card title="Uptime data" icon="chart-line" href="/status-data/uptime">
    Query historical availability percentages.
  </Card>

  <Card title="Status Data guide" icon="wrench" href="/guides/status-data">
    End-to-end guide for working with Status Data.
  </Card>
</CardGroup>