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>",
    "category": "<string>",
    "officialStatusUrl": "<string>",
    "developerContext": "<string>",
    "logoUrl": "<string>",
    "adapterType": "<string>",
    "pollingIntervalSeconds": 123,
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "currentStatus": {
      "overallStatus": "<string>",
      "lastPolledAt": "2023-11-07T05:31:56Z"
    },
    "recentIncidents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "serviceSlug": "<string>",
        "serviceName": "<string>",
        "externalId": "<string>",
        "title": "<string>",
        "status": "<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>",
        "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
      }
    ],
    "uptime": {
      "day": 99.95,
      "week": 99.98,
      "month": 99.92,
      "source": "vendor_reported"
    },
    "activeMaintenances": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "externalId": "<string>",
        "title": "<string>",
        "status": "<string>",
        "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",
        "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"
          }
        ]
      }
    ],
    "dataCompleteness": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

slugOrId
string
required

Response

200 - */*

OK

data
object