InfluxDB Rules API
The Rules API from InfluxDB — 1 operation(s) for rules.
InfluxDB Rules API is one of 40 APIs that InfluxDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, and a getting-started guide.
This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.0.
Requests are made against the base URL https://cloud2.influxdata.com/api/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
InfluxDB Rules API declares
2 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuthentication).
An API key is passed in the header as Authorization (TokenAuthentication).
By default, every request must be authenticated.
BasicAuthentication— Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…TokenAuthentication— Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), FluxResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from InfluxDB 12
Other APIs InfluxDB publishes across the network.