Skip to main content
GET
/
api
/
v1
/
services
/
{slugOrId}
Get a single service by slug or UUID with current status, components, and recent incidents
curl --request GET \
  --url https://api.devhelm.io/api/v1/services/{slugOrId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "name": "<string>",
    "adapterType": "<string>",
    "pollingIntervalSeconds": 123,
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "recentIncidents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "status": "<string>",
        "serviceSlug": "<string>",
        "serviceName": "<string>",
        "externalId": "<string>",
        "impact": "<string>",
        "startedAt": "2023-11-07T05:31:56Z",
        "resolvedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "shortlink": "<string>",
        "detectedAt": "2023-11-07T05:31:56Z",
        "vendorCreatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "components": [
      {
        "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"
      }
    ],
    "activeMaintenances": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "externalId": "<string>",
        "title": "<string>",
        "status": "<string>",
        "affectedComponents": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "status": "<string>"
          }
        ],
        "updates": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "status": "<string>",
            "body": "<string>",
            "displayAt": "2023-11-07T05:31:56Z"
          }
        ],
        "impact": "<string>",
        "shortlink": "<string>",
        "scheduledFor": "2023-11-07T05:31:56Z",
        "scheduledUntil": "2023-11-07T05:31:56Z",
        "startedAt": "2023-11-07T05:31:56Z",
        "completedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "dataCompleteness": "<string>",
    "category": "<string>",
    "officialStatusUrl": "<string>",
    "developerContext": "<string>",
    "logoUrl": "<string>",
    "currentStatus": {
      "overallStatus": "<string>",
      "lastPolledAt": "2023-11-07T05:31:56Z"
    },
    "componentsSummary": {
      "totalCount": 123,
      "includedCount": 123,
      "groupComponentCounts": {}
    },
    "uptime": {
      "source": "vendor_reported",
      "day": 99.95,
      "week": 99.98,
      "month": 99.92
    },
    "seoMetadata": {
      "shortDescription": "<string>",
      "description": "<string>",
      "about": "<string>"
    },
    "relatedServices": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "name": "<string>",
        "adapterType": "<string>",
        "pollingIntervalSeconds": 123,
        "enabled": true,
        "published": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "componentCount": 123,
        "activeIncidentCount": 123,
        "dataCompleteness": "<string>",
        "category": "<string>",
        "officialStatusUrl": "<string>",
        "developerContext": "<string>",
        "logoUrl": "<string>",
        "overallStatus": "<string>",
        "uptime30d": 123
      }
    ]
  }
}

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

slugOrId
string
required

Query Parameters

summary
boolean
default:false

Return a curated subset of components (groups + showcase + impacted + ungrouped) and a componentsSummary block; default false

Response

OK

data
object
required