InfluxData NotificationRules API

openapi: 3.0.0
info:
  title: InfluxDB Cloud API Service Authorizations (API tokens) Authorizations (API tokens) NotificationRules API
  version: 2.0.1
  description: 'The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: /api/v2
security:
- TokenAuthentication: []
tags:
- name: NotificationRules
paths:
  /notificationRules:
    get:
      operationId: GetNotificationRules
      tags:
      - NotificationRules
      summary: List all notification rules
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Limit'
      - in: query
        name: orgID
        required: true
        description: Only show notification rules that belong to a specific organization ID.
        schema:
          type: string
      - in: query
        name: checkID
        description: Only show notifications that belong to the specific check ID.
        schema:
          type: string
      - in: query
        name: tag
        description: Only return notification rules that "would match" statuses which contain the tag key value pairs provided.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$
          example: env:prod
      responses:
        '200':
          description: A list of notification rules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRules'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: CreateNotificationRule
      tags:
      - NotificationRules
      summary: Add a notification rule
      requestBody:
        description: Notification rule to create
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostNotificationRule'
      responses:
        '201':
          description: Notification rule created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRule'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /notificationRules/{ruleID}:
    get:
      operationId: GetNotificationRulesID
      tags:
      - NotificationRules
      summary: Retrieve a notification rule
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - in: path
        name: ruleID
        schema:
          type: string
        required: true
        description: The notification rule ID.
      responses:
        '200':
          description: The notification rule requested
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRule'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      operationId: PutNotificationRulesID
      tags:
      - NotificationRules
      summary: Update a notification rule
      requestBody:
        description: Notification rule update to apply
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRule'
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - in: path
        name: ruleID
        schema:
          type: string
        required: true
        description: The notification rule ID.
      responses:
        '200':
          description: An updated notification rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRule'
        '404':
          description: The notification rule was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    patch:
      operationId: PatchNotificationRulesID
      tags:
      - NotificationRules
      summary: Update a notification rule
      requestBody:
        description: Notification rule update to apply
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRuleUpdate'
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - in: path
        name: ruleID
        schema:
          type: string
        required: true
        description: The notification rule ID.
      responses:
        '200':
          description: An updated notification rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRule'
        '404':
          description: The notification rule was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: DeleteNotificationRulesID
      tags:
      - NotificationRules
      summary: Delete a notification rule
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - in: path
        name: ruleID
        schema:
          type: string
        required: true
        description: The notification rule ID.
      responses:
        '204':
          description: Delete has been accepted
        '404':
          description: The check was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /notificationRules/{ruleID}/labels:
    get:
      operationId: GetNotificationRulesIDLabels
      tags:
      - NotificationRules
      summary: List all labels for a notification rule
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - in: path
        name: ruleID
        schema:
          type: string
        required: true
        description: The notification rule ID.
      responses:
        '200':
          description: A list of all labels for a notification rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelsResponse'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: PostNotificationRuleIDLabels
      tags:
      - NotificationRules
      summary: Add a label to a notification rule
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - in: path
        name: ruleID
        schema:
          type: string
        required: true
        description: The notification rule ID.
      requestBody:
        description: Label to add
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelMapping'
      responses:
        '201':
          description: The label was added to the notification rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelResponse'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /notificationRules/{ruleID}/labels/{labelID}:
    delete:
      operationId: DeleteNotificationRulesIDLabelsID
      tags:
      - NotificationRules
      summary: Delete label from a notification rule
      parameters:
      - $ref: '#/components/parameters/TraceSpan'
      - in: path
        name: ruleID
        schema:
          type: string
        required: true
        description: The notification rule ID.
      - in: path
        name: labelID
        schema:
          type: string
        required: true
        description: The ID of the label to delete.
      responses:
        '204':
          description: Delete has been accepted
        '404':
          description: Rule or label not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    StatusRule:
      type: object
      properties:
        currentLevel:
          $ref: '#/components/schemas/RuleStatusLevel'
        previousLevel:
          $ref: '#/components/schemas/RuleStatusLevel'
        count:
          type: integer
        period:
          type: string
    PagerDutyNotificationRule:
      allOf:
      - $ref: '#/components/schemas/NotificationRuleBase'
      - $ref: '#/components/schemas/PagerDutyNotificationRuleBase'
    Link:
      type: string
      format: uri
      readOnly: true
      description: URI of resource.
    TagRule:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
        operator:
          type: string
          enum:
          - equal
          - notequal
          - equalregex
          - notequalregex
    SMTPNotificationRule:
      allOf:
      - $ref: '#/components/schemas/NotificationRuleBase'
      - $ref: '#/components/schemas/SMTPNotificationRuleBase'
    Links:
      type: object
      description: 'URI pointers for additional paged results.

        '
      properties:
        next:
          $ref: '#/components/schemas/Link'
        self:
          $ref: '#/components/schemas/Link'
        prev:
          $ref: '#/components/schemas/Link'
      required:
      - self
    SMTPNotificationRuleBase:
      type: object
      required:
      - type
      - subjectTemplate
      - to
      properties:
        type:
          type: string
          enum:
          - smtp
        subjectTemplate:
          type: string
        bodyTemplate:
          type: string
        to:
          type: string
    HTTPNotificationRule:
      allOf:
      - $ref: '#/components/schemas/NotificationRuleBase'
      - $ref: '#/components/schemas/HTTPNotificationRuleBase'
    TaskStatusType:
      type: string
      enum:
      - active
      - inactive
      description: '`inactive` cancels scheduled runs and prevents manual runs of the task.

        '
    Label:
      type: object
      properties:
        id:
          readOnly: true
          type: string
        orgID:
          readOnly: true
          type: string
        name:
          type: string
        properties:
          type: object
          additionalProperties:
            type: string
          description: 'Key-value pairs associated with this label.

            To remove a property, send an update with an empty value (`""`) for the key.

            '
          example:
            color: ffb3b3
            description: this is a description
    SlackNotificationRule:
      allOf:
      - $ref: '#/components/schemas/NotificationRuleBase'
      - $ref: '#/components/schemas/SlackNotificationRuleBase'
    TelegramNotificationRule:
      allOf:
      - $ref: '#/components/schemas/NotificationRuleBase'
      - $ref: '#/components/schemas/TelegramNotificationRuleBase'
    NotificationRule:
      allOf:
      - $ref: '#/components/schemas/NotificationRuleDiscriminator'
    NotificationRuleBase:
      type: object
      required:
      - orgID
      - status
      - name
      - statusRules
      - endpointID
      properties:
        latestCompleted:
          description: A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.
          type: string
          format: date-time
          readOnly: true
        lastRunStatus:
          readOnly: true
          type: string
          enum:
          - failed
          - success
          - canceled
        lastRunError:
          readOnly: true
          type: string
        id:
          readOnly: true
          type: string
        endpointID:
          type: string
        orgID:
          description: The ID of the organization that owns this notification rule.
          type: string
        taskID:
          description: The ID of the task associated with this notification rule.
          type: string
        ownerID:
          description: The ID of creator used to create this notification rule.
          type: string
          readOnly: true
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        status:
          $ref: '#/components/schemas/TaskStatusType'
        name:
          description: Human-readable name describing the notification rule.
          type: string
        sleepUntil:
          type: string
        every:
          description: The notification repetition interval.
          type: string
        offset:
          description: Duration to delay after the schedule, before executing check.
          type: string
        runbookLink:
          type: string
        limitEvery:
          description: Don't notify me more than <limit> times every <limitEvery> seconds. If set, limit cannot be empty.
          type: integer
        limit:
          description: Don't notify me more than <limit> times every <limitEvery> seconds. If set, limitEvery cannot be empty.
          type: integer
        tagRules:
          description: List of tag rules the notification rule attempts to match.
          type: array
          items:
            $ref: '#/components/schemas/TagRule'
        description:
          description: An optional description of the notification rule.
          type: string
        statusRules:
          description: List of status rules the notification rule attempts to match.
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/StatusRule'
        labels:
          $ref: '#/components/schemas/Labels'
        links:
          type: object
          readOnly: true
          example:
            self: /api/v2/notificationRules/1
            labels: /api/v2/notificationRules/1/labels
            members: /api/v2/notificationRules/1/members
            owners: /api/v2/notificationRules/1/owners
            query: /api/v2/notificationRules/1/query
          properties:
            self:
              description: The URL for this endpoint.
              $ref: '#/components/schemas/Link'
            labels:
              description: The URL to retrieve labels for this notification rule.
              $ref: '#/components/schemas/Link'
            members:
              description: The URL to retrieve members for this notification rule.
              $ref: '#/components/schemas/Link'
            owners:
              description: The URL to retrieve owners for this notification rule.
              $ref: '#/components/schemas/Link'
            query:
              description: The URL to retrieve the Flux script for this notification rule.
              $ref: '#/components/schemas/Link'
    LabelMapping:
      type: object
      description: A _label mapping_ contains a `label` ID to attach to a resource.
      properties:
        labelID:
          description: 'A label ID.

            Specifies the label to attach.

            '
          type: string
      required:
      - labelID
    NotificationRuleDiscriminator:
      oneOf:
      - $ref: '#/components/schemas/SlackNotificationRule'
      - $ref: '#/components/schemas/SMTPNotificationRule'
      - $ref: '#/components/schemas/PagerDutyNotificationRule'
      - $ref: '#/components/schemas/HTTPNotificationRule'
      - $ref: '#/components/schemas/TelegramNotificationRule'
      discriminator:
        propertyName: type
        mapping:
          slack: '#/components/schemas/SlackNotificationRule'
          smtp: '#/components/schemas/SMTPNotificationRule'
          pagerduty: '#/components/schemas/PagerDutyNotificationRule'
          http: '#/components/schemas/HTTPNotificationRule'
          telegram: '#/components/schemas/TelegramNotificationRule'
    Labels:
      type: array
      items:
        $ref: '#/components/schemas/Label'
    PostNotificationRule:
      allOf:
      - $ref: '#/components/schemas/NotificationRuleDiscriminator'
    NotificationRules:
      properties:
        notificationRules:
          type: array
          items:
            $ref: '#/components/schemas/NotificationRule'
        links:
          $ref: '#/components/schemas/Links'
    TelegramNotificationRuleBase:
      type: object
      required:
      - type
      - messageTemplate
      - channel
      properties:
        type:
          description: The discriminator between other types of notification rules is "telegram".
          type: string
          enum:
          - telegram
        messageTemplate:
          description: The message template as a flux interpolated string.
          type: string
        parseMode:
          description: Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2".
          type: string
          enum:
          - MarkdownV2
          - HTML
          - Markdown
        disableWebPagePreview:
          description: Disables preview of web links in the sent messages when "true". Defaults to "false".
          type: boolean
    RuleStatusLevel:
      description: The state to record if check matches a criteria.
      type: string
      enum:
      - UNKNOWN
      - OK
      - INFO
      - CRIT
      - WARN
      - ANY
    PagerDutyNotificationRuleBase:
      type: object
      required:
      - type
      - messageTemplate
      properties:
        type:
          type: string
          enum:
          - pagerduty
        messageTemplate:
          type: string
    SlackNotificationRuleBase:
      type: object
      required:
      - type
      - messageTemplate
      properties:
        type:
          type: string
          enum:
          - slack
        channel:
          type: string
        messageTemplate:
          type: string
    HTTPNotificationRuleBase:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          enum:
          - http
        url:
          type: string
    NotificationRuleUpdate:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        status:
          type: string
          enum:
          - active
          - inactive
    LabelsResponse:
      type: object
      properties:
        labels:
          $ref: '#/components/schemas/Labels'
        links:
          $ref: '#/components/schemas/Links'
    LabelResponse:
      type: object
      properties:
        label:
          $ref: '#/components/schemas/Label'
        links:
          $ref: '#/components/schemas/Links'
    Error:
      properties:
        code:
          description: code is the machine-readable error code.
          readOnly: true
          type: string
          enum:
          - internal error
          - not implemented
          - not found
          - conflict
          - invalid
          - unprocessable entity
          - empty value
          - unavailable
          - forbidden
          - too many requests
          - unauthorized
          - method not allowed
          - request too large
          - unsupported media type
        message:
          readOnly: true
          description: Human-readable message.
          type: string
        op:
          readOnly: true
          description: Describes the logical code operation when the error occurred. Useful for debugging.
          type: string
        err:
          readOnly: true
          description: Stack of errors that occurred during processing of the request. Useful for debugging.
          type: string
      required:
      - code
  parameters:
    Limit:
      in: query
      name: limit
      required: false
      description: 'Limits the number of records returned. Default is `20`.

        '
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    Offset:
      in: query
      name: offset
      required: false
      description: 'The offset for pagination.

        The number of records to skip.


        For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).

        '
      schema:
        type: integer
        minimum: 0
    TraceSpan:
      in: header
      name: Zap-Trace-Span
      description: OpenTracing span context
      example:
        trace_id: '1'
        span_id: '1'
        baggage:
          key: value
      required: false
      schema:
        type: string
  securitySchemes:
    TokenAuthentication:
      type: apiKey
      name: Authorization
      in: header
      description: "Use the [Token authentication](#section/Authentication/TokenAuthentication)\nscheme to authenticate to the InfluxDB API.\n\nIn your API requests, send an `Authorization` header.\nFor the header value, provide the word `Token` followed by a space and an InfluxDB API token.\nThe word `Token` is case-sensitive.\n\n### Syntax\n\n`Authorization: Token INFLUX_API_TOKEN`\n\n### Example\n\n#### Use Token authentication with cURL\n\nThe following example shows how to use cURL to send an API request that uses Token authentication:\n\n```sh\ncurl --request GET \"INFLUX_URL/api/v2/buckets\" \\\n     --header \"Authorization: Token INFLUX_API_TOKEN\"\n```\n\nReplace the following:\n\n  - *`INFLUX_URL`*: your InfluxDB Cloud URL\n  - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\n\n### Related endpoints\n\n- [`/authorizations` endpoints](#tag/Authorizations-(API-tokens))\n\n### Related guides\n\n- [Authorize API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication)\n- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/)\n"
    BasicAuthentication:
      type: http
      scheme: basic
      description: "### Basic authentication scheme\n\nUse the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it:\n\n### Syntax\n\n`Authorization: Basic BASE64_ENCODED_CREDENTIALS`\n\nTo construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and\nthe password with a colon (`USERNAME:PASSWORD`), and then encode the\nresulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64).\nMany HTTP clients encode the credentials for you before sending the\nrequest.\n\n_**Warning**: Base64-encoding can easily be reversed to obtain the original\nusername and password. It is used to keep the data intact and does not provide\nsecurity. You should always use HTTPS when authenticating or sending a request with\nsensitive information._\n\n### Examples\n\nIn the examples, replace the following:\n\n- **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with)\n- **`PASSWORD`**: InfluxDB Cloud [API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\n- **`INFLUX_URL`**: your InfluxDB Cloud URL\n\n#### Encode credentials with cURL\n\nThe following example shows how to use cURL to send an API request that uses Basic authentication.\nWith the `--user` option, cURL encodes the credentials and passes them\nin the `Authorization: Basic` header.\n\n```sh\ncurl --get \"INFLUX_URL/api/v2/signin\"\n    --user \"EMAIL_ADDRESS\":\"PASSWORD\"\n```\n\n#### Encode credentials with Flux\n\nThe Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded\nbasic authentication header using a specified username and password combination.\n\n#### Encode credentials with JavaScript\n\nThe following example shows how to use the JavaScript `btoa()` function\nto create a Base64-encoded string:\n\n```js\nbtoa('EMAIL_ADDRESS:PASSWORD')\n```\n\nThe output is the following:\n\n```js\n'VVNFUk5BTUU6UEFTU1dPUkQ='\n```\n\nOnce you have the Base64-encoded credentials, you can pass them in the\n`Authorization` header--for example:\n\n```sh\ncurl --get \"INFLUX_URL/api/v2/signin\"\n    --header \"Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=\"\n```\n\nTo learn more about HTTP authentication, see\n[Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._\n"
x-tagGroups:
- name: Overview
  tags:
  - Quick start
  - Authentication
  - Supported operations
  - Headers
  - Pagination
  - Response codes
- name: Popular endpoints
  tags:
  - Data I/O endpoints
  - Security and access endpoints
  - System information endpoints
- name: All endpoints
  tags: []