InfluxData Checks API
The Checks API from InfluxData — 5 operation(s) for checks.
InfluxData Checks API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Checks. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes 10 operations across 5 paths, and defines 31 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.
Requests are made against a single base URL, /api/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
InfluxData Checks 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 10
Across 5 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 31
The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are CheckBase (15 properties), DashboardQuery (4 properties), Label (4 properties), BuilderConfig (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from InfluxData 12
Other APIs InfluxData publishes across the network.