Create a manual incident

curl --request POST \
  --url https://api.devhelm.io/api/v1/incidents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "body": "<string>",
  "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serviceIncidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.devhelm.io/api/v1/incidents"

payload = {
    "title": "<string>",
    "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "body": "<string>",
    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceIncidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    title: '<string>',
    monitorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    body: JSON.stringify('<string>'),
    serviceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    serviceIncidentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.devhelm.io/api/v1/incidents', 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/incidents",
  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([
    'title' => '<string>',
    'monitorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'body' => '<string>',
    'serviceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'serviceIncidentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/incidents"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"body\": \"<string>\",\n  \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serviceIncidentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/incidents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"body\": \"<string>\",\n  \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serviceIncidentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devhelm.io/api/v1/incidents")

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  \"title\": \"<string>\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"body\": \"<string>\",\n  \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serviceIncidentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "incident": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": 123,
      "source": "AUTOMATIC",
      "status": "WATCHING",
      "severity": "DOWN",
      "affectedRegions": [
        "<string>"
      ],
      "reopenCount": 123,
      "statusPageVisible": true,
      "suppressDispatch": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "triggeredByRule": "<string>",
      "createdByUserId": 123,
      "serviceIncidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalRef": "<string>",
      "affectedComponents": [
        "<string>"
      ],
      "shortlink": "<string>",
      "resolutionReason": "MANUAL",
      "resolutionNote": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "confirmedAt": "2023-11-07T05:31:56Z",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "cooldownUntil": "2023-11-07T05:31:56Z",
      "monitorName": "<string>",
      "serviceName": "<string>",
      "serviceSlug": "<string>",
      "monitorType": "<string>",
      "resourceGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resourceGroupName": "<string>",
      "triggeringCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "triggeredByRuleSnapshotHashHex": "<string>",
      "triggeredByRuleIndex": 123,
      "engineVersion": "<string>",
      "displayKey": "<string>",
      "alertCollapsedByResourceGroupIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "peakFailingMemberCount": 123,
      "failingMembersAtPeak": [
        {
          "memberType": "<string>",
          "name": "<string>",
          "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "membershipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ]
    },
    "updates": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "incidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "notifySubscribers": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "oldStatus": "WATCHING",
        "newStatus": "WATCHING",
        "body": "<string>",
        "createdBy": "SYSTEM"
      }
    ],
    "statusPageIncidents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "spIncidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "statusPageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "statusPageName": "<string>",
        "statusPageSlug": "<string>",
        "title": "<string>",
        "status": "INVESTIGATING",
        "impact": "NONE",
        "scheduled": true,
        "connectionMode": "AUTO",
        "pageIncidentMode": "MANUAL",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "trigger": {
      "source": "forensics",
      "ruleType": "<string>",
      "ruleIndex": 123,
      "count": 123,
      "threshold": 123,
      "lastError": "<string>",
      "firstFailedCheckAt": "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"
}

POST

api

incidents

Create a manual incident

curl --request POST \
  --url https://api.devhelm.io/api/v1/incidents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "body": "<string>",
  "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "serviceIncidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.devhelm.io/api/v1/incidents"

payload = {
    "title": "<string>",
    "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "body": "<string>",
    "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceIncidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    title: '<string>',
    monitorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    body: JSON.stringify('<string>'),
    serviceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    serviceIncidentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.devhelm.io/api/v1/incidents', 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/incidents",
  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([
    'title' => '<string>',
    'monitorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'body' => '<string>',
    'serviceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'serviceIncidentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/incidents"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"body\": \"<string>\",\n  \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serviceIncidentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/incidents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"body\": \"<string>\",\n  \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serviceIncidentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devhelm.io/api/v1/incidents")

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  \"title\": \"<string>\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"body\": \"<string>\",\n  \"serviceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"serviceIncidentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "incident": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": 123,
      "source": "AUTOMATIC",
      "status": "WATCHING",
      "severity": "DOWN",
      "affectedRegions": [
        "<string>"
      ],
      "reopenCount": 123,
      "statusPageVisible": true,
      "suppressDispatch": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "triggeredByRule": "<string>",
      "createdByUserId": 123,
      "serviceIncidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalRef": "<string>",
      "affectedComponents": [
        "<string>"
      ],
      "shortlink": "<string>",
      "resolutionReason": "MANUAL",
      "resolutionNote": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "confirmedAt": "2023-11-07T05:31:56Z",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "cooldownUntil": "2023-11-07T05:31:56Z",
      "monitorName": "<string>",
      "serviceName": "<string>",
      "serviceSlug": "<string>",
      "monitorType": "<string>",
      "resourceGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resourceGroupName": "<string>",
      "triggeringCheckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "triggeredByRuleSnapshotHashHex": "<string>",
      "triggeredByRuleIndex": 123,
      "engineVersion": "<string>",
      "displayKey": "<string>",
      "alertCollapsedByResourceGroupIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "peakFailingMemberCount": 123,
      "failingMembersAtPeak": [
        {
          "memberType": "<string>",
          "name": "<string>",
          "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "membershipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ]
    },
    "updates": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "incidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "notifySubscribers": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "oldStatus": "WATCHING",
        "newStatus": "WATCHING",
        "body": "<string>",
        "createdBy": "SYSTEM"
      }
    ],
    "statusPageIncidents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "spIncidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "statusPageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "statusPageName": "<string>",
        "statusPageSlug": "<string>",
        "title": "<string>",
        "status": "INVESTIGATING",
        "impact": "NONE",
        "scheduled": true,
        "connectionMode": "AUTO",
        "pageIncidentMode": "MANUAL",
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "trigger": {
      "source": "forensics",
      "ruleType": "<string>",
      "ruleIndex": 123,
      "count": 123,
      "threshold": 123,
      "lastError": "<string>",
      "firstFailedCheckAt": "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

Body

application/json

title

string

required

Short summary of the incident

Minimum string length: 1

severity

enum<string>

required

Incident severity: DOWN, DEGRADED, or MAINTENANCE

Available options:

DOWN,

DEGRADED,

MAINTENANCE

monitorId

string<uuid> | null

Monitor to associate with this incident

body

string | null

Detailed description or context for the incident

serviceId

string<uuid> | null

Vendor service to link; optional for Dependencies create CTA

serviceIncidentId

string<uuid> | null

Vendor incident to link; idempotent if an active org incident already links it

Response

Created

data

object

required

Show child attributes