InfluxDB Tasks API
Process and analyze your data with [tasks](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task)in the InfluxDB task engine.Use the `/api/v2/tasks` endpoints to schedule and manage tasks, retry task runs, and retrieve run logs.To configure a task, provide the script and the schedule to run the task.For examples, see how to create a task with the [`POST /api/v2/tasks` endpoint](#operation/PostTasks).### PropertiesA `task` object contains information about an InfluxDB task resource.The following table defines the properties that appear in this object:### Related guides- [Get started with tasks](https://docs.influxdata.com/influxdb/cloud/process-data/get-started/)- [Common data processing tasks](https://docs.influxdata.com/influxdb/cloud/process-data/common-tasks/)- [Create a script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/#create-an-invokable-script)
InfluxDB Tasks 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 Tasks. 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 21 operations across 13 paths, and defines 25 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 Tasks 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 21
Across 13 paths, the API surfaces 21 operations — 5 DELETE, 9 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.
Process and analyze your data with [tasks](https://docs.influxdata.com/influxdb/cloud/reference/glossary/task) in the InfluxDB task engine. Use the /api/v2/tasks endpoints to sche…
Schemas 25
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Task (21 properties), TaskCreateRequest (11 properties), Run (10 properties), TaskUpdateRequest (9 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 InfluxDB 12
Other APIs InfluxDB publishes across the network.