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

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

200 - */*

OK

data
object

An org-level service subscription with current status information