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>"
}
'
import requests

url = "https://api.devhelm.io/api/v1/service-subscriptions/{slug}"

payload = {
    "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "alertSensitivity": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    componentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    alertSensitivity: '<string>'
  })
};

fetch('https://api.devhelm.io/api/v1/service-subscriptions/{slug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.devhelm.io/api/v1/service-subscriptions/{slug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'componentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'alertSensitivity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.devhelm.io/api/v1/service-subscriptions/{slug}"

	payload := strings.NewReader("{\n  \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alertSensitivity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.devhelm.io/api/v1/service-subscriptions/{slug}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alertSensitivity\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.devhelm.io/api/v1/service-subscriptions/{slug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"alertSensitivity\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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"
    }
  }
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}

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