Skip to main content
POST
/
api
/
v1
/
service-subscriptions
/
{slug}
Subscribe to a service or a component of a service
curl --request POST \
  --url https://api.devhelm.io/api/v1/service-subscriptions/{slug} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alertSensitivity": "<string>"
}
'
{
  "data": {
    "subscriptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "name": "<string>",
    "adapterType": "<string>",
    "pollingIntervalSeconds": 123,
    "enabled": true,
    "subscribedAt": "2023-11-07T05:31:56Z",
    "category": "<string>",
    "officialStatusUrl": "<string>",
    "logoUrl": "<string>",
    "overallStatus": "<string>",
    "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "component": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "name": "<string>",
      "status": "<string>",
      "showcase": true,
      "onlyShowIfDegraded": true,
      "lifecycleStatus": "<string>",
      "dataType": "full",
      "hasUptime": true,
      "displayAggregatedUptime": true,
      "firstSeenAt": "2023-11-07T05:31:56Z",
      "lastSeenAt": "2023-11-07T05:31:56Z",
      "isGroup": true,
      "description": "<string>",
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "position": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "vendorCreatedAt": "2023-11-07T05:31:56Z",
      "region": "<string>",
      "groupName": "<string>",
      "childCount": 123,
      "uptime": {
        "source": "vendor_reported",
        "day": 99.95,
        "week": 99.98,
        "month": 99.92
      },
      "statusChangedAt": "2023-11-07T05:31:56Z"
    }
  }
}

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.

Authorizations

​
Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Path Parameters

​
slug
string
required

Body

application/json

Optional body for subscribing to a specific component of a service

​
componentId
string<uuid> | null

ID of the component to subscribe to. Omit or null for whole-service subscription.

​
alertSensitivity
string | null

Alert sensitivity: ALL (any status change), INCIDENTS_ONLY (real vendor incidents, page on every one), MAJOR_ONLY (only DOWN-level incidents), AWARENESS (track silently — show on dashboard, never send alerts). Defaults to AWARENESS when not provided — silent tracking is the friendliest first-run choice; switch to one of the paging modes to opt in to alert-channel fan-out.

Pattern: ALL|AWARENESS|INCIDENTS_ONLY|MAJOR_ONLY

Response

Created

​
data
object
required

An org-level service subscription with current status information