How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxDB Checks API

The Checks API from InfluxDB — 5 operation(s) for checks.

InfluxDB Checks 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 Checks. 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 10 operations across 5 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://cloud2.influxdata.com/api/v2.

10 operations 5 paths 32 schemas 2 DELETE4 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://cloud2.influxdata.com/api/v2
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

InfluxDB Checks 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 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.

Checks 10
GET
/api/v2/checks
List all checks
GetChecks 4 params → 200default
POST
/api/v2/checks
Add new check
CreateCheck body → 201default
DELETE
/api/v2/checks/{checkID}
Delete a check
DeleteChecksID 2 params → 204404default
GET
/api/v2/checks/{checkID}
Retrieve a check
GetChecksID 2 params → 200default
PATCH
/api/v2/checks/{checkID}
Update a check
PatchChecksID 2 params body → 200404default
PUT
/api/v2/checks/{checkID}
Update a check
PutChecksID 2 params body → 200404default
GET
/api/v2/checks/{checkID}/labels
List all labels for a check
GetChecksIDLabels 2 params → 200default
POST
/api/v2/checks/{checkID}/labels
Add a label to a check
PostChecksIDLabels 2 params body → 201default
DELETE
/api/v2/checks/{checkID}/labels/{labelID}
Delete label from a check
DeleteChecksIDLabelsID 3 params → 204404default
GET
/api/v2/checks/{checkID}/query
Retrieve a check query
GetChecksIDQuery 2 params → 200400404default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are CheckBase (15 properties), DashboardQuery (4 properties), Error (4 properties), BuilderConfig (4 properties). Each schema is shown below with its type and property counts.

PostCheck
CustomCheck
QueryEditMode
string
Check
Links
object
URI pointers for additional paged results.
3 properties 1 required
BuilderAggregateFunctionType
string
BuilderTagsType
object
3 properties
CheckPatch
object
3 properties
LesserThreshold
Threshold
ErrorCode
string
code is the machine-readable error code.
TaskStatusType
string
inactive cancels scheduled runs and prevents manual runs of the task.
CheckBase
object
15 properties 3 required
LabelsResponse
object
2 properties
BuilderConfig
object
4 properties
LabelMapping
object
A label mapping contains a label ID to attach to a resource.
1 property 1 required
CheckDiscriminator
RangeThreshold
CheckStatusLevel
string
The state to record if check matches a criteria.
DeadmanCheck
ThresholdCheck
Checks
object
2 properties
Error
object
4 properties 1 required
GreaterThreshold
FluxResponse
object
Rendered flux that backs the check or notification.
1 property
Label
object
4 properties
BuilderFunctionsType
object
1 property
Link
string
URI of resource.
LabelResponse
object
2 properties
DashboardQuery
object
4 properties
ThresholdBase
object
2 properties
Labels
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-checks-api-openapi.yml Raw ↑

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API
InfluxDB Bucket Schemas API
InfluxDB Buckets API
InfluxDB Cells API
InfluxDB Config API
InfluxDB Dashboards API
InfluxDB Data I/O endpoints API
InfluxDB DBRPs API
InfluxDB Delete API
InfluxDB Invokable Scripts API
InfluxDB Labels API
InfluxDB Legacy Authorizations API
Where this information came from

This is an independent, third-party profile of InfluxDB Checks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.