Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxData NotificationRules API

The NotificationRules API from InfluxData — 4 operation(s) for notificationrules.

InfluxData NotificationRules API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NotificationRules. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 9 operations across 4 paths, and defines 28 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

9 operations 4 paths 28 schemas 2 DELETE3 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

InfluxData NotificationRules API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (TokenAuthentication). It accepts HTTP basic authentication (BasicAuthentication). By default, every request must be authenticated.

  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…
  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

NotificationRules 9
GET
/notificationRules
List all notification rules
GetNotificationRules 6 params → 200default
POST
/notificationRules
Add a notification rule
CreateNotificationRule body → 201default
GET
/notificationRules/{ruleID}
Retrieve a notification rule
GetNotificationRulesID 2 params → 200default
PUT
/notificationRules/{ruleID}
Update a notification rule
PutNotificationRulesID 2 params body → 200404default
PATCH
/notificationRules/{ruleID}
Update a notification rule
PatchNotificationRulesID 2 params body → 200404default
DELETE
/notificationRules/{ruleID}
Delete a notification rule
DeleteNotificationRulesID 2 params → 204404default
GET
/notificationRules/{ruleID}/labels
List all labels for a notification rule
GetNotificationRulesIDLabels 2 params → 200default
POST
/notificationRules/{ruleID}/labels
Add a label to a notification rule
PostNotificationRuleIDLabels 2 params body → 201default
DELETE
/notificationRules/{ruleID}/labels/{labelID}
Delete label from a notification rule
DeleteNotificationRulesIDLabelsID 3 params → 204404default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are NotificationRuleBase (23 properties), StatusRule (4 properties), TelegramNotificationRuleBase (4 properties), Label (4 properties). Each schema is shown below with its type and property counts.

StatusRule
object
4 properties
PagerDutyNotificationRule
Link
string
URI of resource.
TagRule
object
3 properties
SMTPNotificationRule
Links
object
URI pointers for additional paged results.
3 properties 1 required
SMTPNotificationRuleBase
object
4 properties 3 required
HTTPNotificationRule
TaskStatusType
string
inactive cancels scheduled runs and prevents manual runs of the task.
Label
object
4 properties
SlackNotificationRule
TelegramNotificationRule
NotificationRule
NotificationRuleBase
object
23 properties 5 required
LabelMapping
object
A label mapping contains a label ID to attach to a resource.
1 property 1 required
NotificationRuleDiscriminator
Labels
array
PostNotificationRule
NotificationRules
object
2 properties
TelegramNotificationRuleBase
object
4 properties 3 required
RuleStatusLevel
string
The state to record if check matches a criteria.
PagerDutyNotificationRuleBase
object
2 properties 2 required
SlackNotificationRuleBase
object
3 properties 2 required
HTTPNotificationRuleBase
object
2 properties 1 required
NotificationRuleUpdate
object
3 properties
LabelsResponse
object
2 properties
LabelResponse
object
2 properties
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-notificationrules-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API