InfluxData Data I/O endpoints API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Data I/O endpoints. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes
7 operations
across 6 paths,
and defines 61 schemas.
It is described by OpenAPI 3.0.0, at version 2.0.1.
Requests are made against a single base URL, /api/v2.
7 operations6 paths61 schemas2 GET5 POST
Metadata
The identity and technical contract details declared by the specification.
InfluxData Data I/O endpoints 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 7
Across 6 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Data I/O endpoints 7
POST
/write
Write data
PostWrite9 paramsbody→ 204400401404413429500503
POST
/delete
Delete data
PostDelete5 paramsbody→ 204400401404500default
POST
/query
Query data
PostQuery5 paramsbody→ 200400401404429500default
POST
/tasks/{taskID}/runs
Start a task run, overriding the schedule
PostTasksIDRuns2 paramsbody→ 201401500default
GET
/tasks
List all tasks
GetTasks12 params→ 200401500default
POST
/tasks
Create a task
PostTasks1 parambody→ 201400401500default
GET
/tasks/{taskID}
Retrieve a task
GetTasksID2 params→ 200400401404500default
Schemas 61
The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are Task (21 properties), TaskCreateRequest (11 properties), Run (10 properties), Query (6 properties). Each schema is shown below with its type and property counts.
LogEvent
object
3 properties
MemberExpression
object
Represents accessing a property of an object
3 properties
MemberAssignment
object
Object property assignment
3 properties
LineProtocolError
object
5 properties1 required
WritePrecision
string
TestStatement
object
Declares a Flux test case
2 properties
DictItem
object
A key-value pair in a dictionary.
3 properties
Link
string
URI of resource.
NodeType
string
Type of AST node
Error
object
4 properties1 required
BinaryExpression
object
uses binary operators to act on two operands in an expression
4 properties
PipeLiteral
object
Represents a specialized literal value, indicating the left hand value of a pipe expression
1 property
Links
object
URI pointers for additional paged results.
3 properties1 required
ObjectExpression
object
Allows the declaration of an anonymous object within a declaration
2 properties
Expression
Block
object
A set of statements
2 properties
ConditionalExpression
object
Selects one of two expressions, Alternate or Consequent, depending on a third boolean expression, Test
4 properties
VariableAssignment
object
Represents the declaration of a variable
3 properties
TaskCreateRequest
object
11 properties
TaskStatusType
string
inactive cancels scheduled runs and prevents manual runs of the task.
ImportDeclaration
object
Declares a package import
3 properties
ReturnStatement
object
Defines an expression to return
2 properties
DeletePredicateRequest
object
The delete predicate request.
3 properties2 required
UnaryExpression
object
Uses operators to act on a single operand in an expression
3 properties
Tasks
object
2 properties
Statement
Property
object
The value associated with a key
3 properties
CallExpression
object
Represents a function call
3 properties
ExpressionStatement
object
May consist of an expression that doesn't return a value and is executed solely for its side-effects
2 properties
Node
BooleanLiteral
object
Represents boolean values
2 properties
DateTimeLiteral
object
Represents an instant in time with nanosecond precision in [RFC3339Nano date/time format](https://docs.influxdata.com/influxdb/cloud/reference/glossary/rfc3339…
2 properties
Labels
array
FloatLiteral
object
Represents floating point numbers according to the double representations defined by the IEEE-754-1985
2 properties
UnsignedIntegerLiteral
object
Represents integer numbers
2 properties
Dialect
object
Options for tabular data output. Default output is [annotated CSV](https://docs.influxdata.com/influxdb/cloud/reference/syntax/annotated-csv/csv-response-forma…
5 properties
BuiltinStatement
object
Declares a builtin identifier and its type
2 properties
Query
object
Query InfluxDB with the Flux language
6 properties1 required
RunManually
object
1 property
Duration
object
A pair consisting of length of time and the unit of time measured. It is the atomic unit from which all duration literals are composed.
3 properties
Task
object
21 properties3 required
LineProtocolLengthError
object
2 properties2 required
Run
object
10 properties
PropertyKey
ArrayExpression
object
Used to create and directly specify the elements of an array object
2 properties
PackageClause
object
Defines a package identifier
2 properties
ParenExpression
object
Represents an expression wrapped in parenthesis
2 properties
File
object
Represents a source from a single file
5 properties
DurationLiteral
object
Represents the elapsed time between two instants as an int64 nanosecond count with syntax of golang's time.Duration
2 properties
FunctionExpression
object
Function expression
3 properties
OptionStatement
object
A single variable declaration
2 properties
BadStatement
object
A placeholder for statements for which no correct statement nodes can be created
2 properties
IndexExpression
object
Represents indexing into an array
3 properties
Identifier
object
A valid Flux identifier
2 properties
IntegerLiteral
object
Represents integer numbers
2 properties
DictExpression
object
Used to create and directly specify the elements of a dictionary
2 properties
PipeExpression
object
Call expression with pipe argument
3 properties
RegexpLiteral
object
Expressions begin and end with / and are regular expressions with syntax accepted by RE2
2 properties
StringLiteral
object
Expressions begin and end with double quote marks
2 properties
LogicalExpression
object
Represents the rule conditions that collectively evaluate to either true or false
4 properties
Label
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
