Alerts and Notification Channels APIs

List of APIs to manage alerts and notification channels

Notification Channel APIs

Configure channel

POSThttp://localhost:3000/alerts/v1/notifications/create

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/notifications/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "manager": "grafana",
      "name": "functional-metrics-email",
      "type": "email",
      "config": {
        "recipientAddresses": "[e-mail];[e-mail]",
        "subject": "Obsrv Prod Alert"
      }
    }),
});
const data = await response.json();

Publish Channel

GEThttp://localhost:3000/alerts/v1/notifications/publish/{alert_id}

Path parameters

alert_id*string

Unique identifier for the alert

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/notifications/publish/{alert_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Search Notificaation Channels

POSThttp://localhost:3000/alerts/v1/notifications/search

Body

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/notifications/search', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Update Specific Channel

PATCHhttp://localhost:3000/alerts/v1/notifications/update/{alert_id}

Path parameters

alert_id*string

Unique identifier for the alert

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/notifications/update/{alert_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "updated name"
    }),
});
const data = await response.json();

Delete Channel

DELETEhttp://localhost:3000/alerts/v1/notifications/delete/{alert_id}

Path parameters

alert_id*string

Unique identifier for the alert

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/notifications/delete/{alert_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Verify Configured Channel

POSThttp://localhost:3000/alerts/v1/notifications/test

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/notifications/test', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "message": "Testing Email integration. If you can read this, it's working!",
      "payload": {
        "error": {
          "selectChannel": true,
          "configureChannel": true
        },
        "manager": "grafana",
        "name": "udhw",
        "type": "email",
        "config": {
          "recipientAddresses": "[e-mail]"
        }
      }
    }),
});
const data = await response.json();

Alerts APIs

Add Rule

POSThttp://localhost:3000/alerts/v1/create

Header parameters

Body

*/*

string

Example: "\"{\\n \\\"name\\\": \\\"Total Api Calls1\\\",\\n \\\"manager\\\":\\\"grafana\\\",\\n \\\"description\\\": \\\"This alert is set up to notify you when the CPU usage on a host reaches a Low level.\\\",\\n \\\"expression\\\": \\\"(node_total_api_calls) > 20\\\",\\n \\\"category\\\": \\\"Infra\\\",\\n \\\"severity\\\":\\\"warning\\\",\\n \\\"frequency\\\": \\\"1m\\\",\\n \\\"interval\\\": \\\"1m\\\",\\n \\\"labels\\\": {\\n \\\"component\\\": \\\"api\\\",\\n \\\"notificationChannel\\\": \\\"slack\\\"\\n },\\n \\\"annotations\\\":{\\n \\\"summary\\\":\\\"Host Low CPU usage\\\"\\n },\\n \\\"metadata\\\": {\\n \\\"query\\\": [\\n {\\n \\\"refId\\\": \\\"A\\\",\\n \\\"datasourceUid\\\": \\\"$datasourceUid\\\",\\n \\\"queryType\\\": \\\"\\\",\\n \\\"relativeTimeRange\\\": {\\n \\\"from\\\": 600,\\n \\\"to\\\": 0\\n },\\n \\\"model\\\": {\\n \\\"refId\\\": \\\"A\\\",\\n \\\"hide\\\": false,\\n \\\"editorMode\\\": \\\"code\\\",\\n \\\"expr\\\": \\\"node_total_api_calls\\\",\\n \\\"legendFormat\\\": \\\"__auto\\\",\\n \\\"range\\\": true\\n }\\n },\\n {\\n \\\"refId\\\": \\\"B\\\",\\n \\\"datasourceUid\\\": \\\"__expr__\\\",\\n \\\"queryType\\\": \\\"\\\",\\n \\\"model\\\": {\\n \\\"refId\\\": \\\"B\\\",\\n \\\"hide\\\": false,\\n \\\"type\\\": \\\"reduce\\\",\\n \\\"datasource\\\": {\\n \\\"uid\\\": \\\"__expr__\\\",\\n \\\"type\\\": \\\"__expr__\\\"\\n },\\n \\\"conditions\\\": [\\n {\\n \\\"type\\\": \\\"query\\\",\\n \\\"evaluator\\\": {\\n \\\"params\\\": [],\\n \\\"type\\\": \\\"gt\\\"\\n },\\n \\\"operator\\\": {\\n \\\"type\\\": \\\"and\\\"\\n },\\n \\\"query\\\": {\\n \\\"params\\\": [\\n \\\"B\\\"\\n ]\\n },\\n \\\"reducer\\\": {\\n \\\"params\\\": [],\\n \\\"type\\\": \\\"last\\\"\\n }\\n }\\n ],\\n \\\"reducer\\\": \\\"last\\\",\\n \\\"expression\\\": \\\"A\\\"\\n },\\n \\\"relativeTimeRange\\\": {\\n \\\"from\\\": 600,\\n \\\"to\\\": 0\\n }\\n },\\n {\\n \\\"refId\\\": \\\"C\\\",\\n \\\"datasourceUid\\\": \\\"__expr__\\\",\\n \\\"queryType\\\": \\\"\\\",\\n \\\"model\\\": {\\n \\\"refId\\\": \\\"C\\\",\\n \\\"hide\\\": false,\\n \\\"type\\\": \\\"threshold\\\",\\n \\\"datasource\\\": {\\n \\\"uid\\\": \\\"__expr__\\\",\\n \\\"type\\\": \\\"__expr__\\\"\\n },\\n \\\"conditions\\\": [\\n {\\n \\\"type\\\": \\\"query\\\",\\n \\\"evaluator\\\": {\\n \\\"params\\\": [\\n 20\\n ],\\n \\\"type\\\": \\\"gt\\\"\\n },\\n \\\"operator\\\": {\\n \\\"type\\\": \\\"and\\\"\\n },\\n \\\"query\\\": {\\n \\\"params\\\": [\\n \\\"C\\\"\\n ]\\n },\\n \\\"reducer\\\": {\\n \\\"params\\\": [],\\n \\\"type\\\": \\\"last\\\"\\n }\\n }\\n ],\\n \\\"expression\\\": \\\"B\\\"\\n },\\n \\\"relativeTimeRange\\\": {\\n \\\"from\\\": 600,\\n \\\"to\\\": 0\\n }\\n }\\n ]\\n }\\n}\""

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify("\"{\\n    \\\"name\\\": \\\"Total Api Calls1\\\",\\n    \\\"manager\\\":\\\"grafana\\\",\\n    \\\"description\\\": \\\"This alert is set up to notify you when the CPU usage on a host reaches a Low level.\\\",\\n    \\\"expression\\\": \\\"(node_total_api_calls) > 20\\\",\\n    \\\"category\\\": \\\"Infra\\\",\\n    \\\"severity\\\":\\\"warning\\\",\\n    \\\"frequency\\\": \\\"1m\\\",\\n    \\\"interval\\\": \\\"1m\\\",\\n    \\\"labels\\\": {\\n        \\\"component\\\": \\\"api\\\",\\n        \\\"notificationChannel\\\": \\\"slack\\\"\\n    },\\n    \\\"annotations\\\":{\\n        \\\"summary\\\":\\\"Host Low CPU usage\\\"\\n    },\\n    \\\"metadata\\\": {\\n        \\\"query\\\": [\\n            {\\n                \\\"refId\\\": \\\"A\\\",\\n                \\\"datasourceUid\\\": \\\"$datasourceUid\\\",\\n                \\\"queryType\\\": \\\"\\\",\\n                \\\"relativeTimeRange\\\": {\\n                    \\\"from\\\": 600,\\n                    \\\"to\\\": 0\\n                },\\n                \\\"model\\\": {\\n                    \\\"refId\\\": \\\"A\\\",\\n                    \\\"hide\\\": false,\\n                    \\\"editorMode\\\": \\\"code\\\",\\n                    \\\"expr\\\": \\\"node_total_api_calls\\\",\\n                    \\\"legendFormat\\\": \\\"__auto\\\",\\n                    \\\"range\\\": true\\n                }\\n            },\\n            {\\n                \\\"refId\\\": \\\"B\\\",\\n                \\\"datasourceUid\\\": \\\"__expr__\\\",\\n                \\\"queryType\\\": \\\"\\\",\\n                \\\"model\\\": {\\n                    \\\"refId\\\": \\\"B\\\",\\n                    \\\"hide\\\": false,\\n                    \\\"type\\\": \\\"reduce\\\",\\n                    \\\"datasource\\\": {\\n                        \\\"uid\\\": \\\"__expr__\\\",\\n                        \\\"type\\\": \\\"__expr__\\\"\\n                    },\\n                    \\\"conditions\\\": [\\n                        {\\n                            \\\"type\\\": \\\"query\\\",\\n                            \\\"evaluator\\\": {\\n                                \\\"params\\\": [],\\n                                \\\"type\\\": \\\"gt\\\"\\n                            },\\n                            \\\"operator\\\": {\\n                                \\\"type\\\": \\\"and\\\"\\n                            },\\n                            \\\"query\\\": {\\n                                \\\"params\\\": [\\n                                    \\\"B\\\"\\n                                ]\\n                            },\\n                            \\\"reducer\\\": {\\n                                \\\"params\\\": [],\\n                                \\\"type\\\": \\\"last\\\"\\n                            }\\n                        }\\n                    ],\\n                    \\\"reducer\\\": \\\"last\\\",\\n                    \\\"expression\\\": \\\"A\\\"\\n                },\\n                \\\"relativeTimeRange\\\": {\\n                    \\\"from\\\": 600,\\n                    \\\"to\\\": 0\\n                }\\n            },\\n            {\\n                \\\"refId\\\": \\\"C\\\",\\n                \\\"datasourceUid\\\": \\\"__expr__\\\",\\n                \\\"queryType\\\": \\\"\\\",\\n                \\\"model\\\": {\\n                    \\\"refId\\\": \\\"C\\\",\\n                    \\\"hide\\\": false,\\n                    \\\"type\\\": \\\"threshold\\\",\\n                    \\\"datasource\\\": {\\n                        \\\"uid\\\": \\\"__expr__\\\",\\n                        \\\"type\\\": \\\"__expr__\\\"\\n                    },\\n                    \\\"conditions\\\": [\\n                        {\\n                            \\\"type\\\": \\\"query\\\",\\n                            \\\"evaluator\\\": {\\n                                \\\"params\\\": [\\n                                    20\\n                                ],\\n                                \\\"type\\\": \\\"gt\\\"\\n                            },\\n                            \\\"operator\\\": {\\n                                \\\"type\\\": \\\"and\\\"\\n                            },\\n                            \\\"query\\\": {\\n                                \\\"params\\\": [\\n                                    \\\"C\\\"\\n                                ]\\n                            },\\n                            \\\"reducer\\\": {\\n                                \\\"params\\\": [],\\n                                \\\"type\\\": \\\"last\\\"\\n                            }\\n                        }\\n                    ],\\n                    \\\"expression\\\": \\\"B\\\"\\n                },\\n                \\\"relativeTimeRange\\\": {\\n                    \\\"from\\\": 600,\\n                    \\\"to\\\": 0\\n                }\\n            }\\n        ]\\n    }\\n}\""),
});
const data = await response.json();

Publish Alert Rules

GEThttp://localhost:3000/alerts/v1/publish/{alert_id}

Path parameters

alert_id*string

Unique identifier for the alert

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/publish/{alert_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Alert Rule

GEThttp://localhost:3000/alerts/v1/get/{alert_id}

Path parameters

alert_id*string

Unique identifier for the alert

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/get/{alert_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Search Alert Rule

POSThttp://localhost:3000/alerts/v1/search

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {}
    }),
});
const data = await response.json();

Update Rule

This URL will provide access to users to edit any properties in the Alert rule and save the changes.

PATCHhttp://localhost:3000/alerts/v1/update/{alert_id}

Path parameters

alert_id*string

Unique identifier for the alert

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/update/{alert_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "<p>This alert rule is designed to promptly notify you when one or more servers in your infrastructure become unresponsive or inaccessible.</p>",
      "labels": {
        "severity": "warning"
      },
      "__$markdownParsed": true
    }),
});
const data = await response.json();

Delete Configured Alert Rules

This URLwill provided access to user to delete any custom rule.

DELETEhttp://localhost:3000/alerts/v1/delete/{alert_id}

Path parameters

alert_id*string

Unique identifier for the alert

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/delete/{alert_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Alerts Silience APIs

Add Silence

POSThttp://localhost:3000/alerts/v1/silence/create

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/silence/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "startDate": "2024-01-11T07:56:23Z",
      "endDate": "2024-01-11T08:56:23Z",
      "alertId": "c7464d32-1d8d-4eaf-9b23-1313a3ff8149",
      "manager": "grafana"
    }),
});
const data = await response.json();

Get Silence

GEThttp://localhost:3000/alerts/v1/silence/get/{alert_id}

Path parameters

alert_id*string

Unique identifier for the alert

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/silence/get/{alert_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Fetch All Silences

GEThttp://localhost:3000/alerts/v1/silence/search

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/alerts/v1/silence/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();