Influxdata

InfluxDB OSS API Service

The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the /api/v2/ endpoint.

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the /api/v2/ endpoint.

Endpoints 225

Authorizations (API tokens)

  • GETList authorizations/authorizations?userID=string&user=string&orgID=string&org=string&token=stringLists authorizations. To limit which authorizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns…
  • POSTCreate an authorization/authorizationsCreates an authorization and returns the authorization with the generated API token. Use this endpoint to create an authorization, which generates an API…
  • GETRetrieve an authorization/authorizations/:authIDRetrieves an authorization. Use this endpoint to retrieve information about an API token, including the token's permissions and the user that the token is…
  • DELETEDelete an authorization/authorizations/:authIDDeletes an authorization. Use the endpoint to delete an API token. If you want to disable an API token instead of delete it, update the authorization's status…
  • PATCHUpdate an API token to be active or inactive/authorizations/:authIDUpdates an authorization. Use this endpoint to set an API token's status to be _active_ or _inactive_. InfluxDB rejects requests that use inactive API tokens.

Buckets

  • GETList buckets/buckets?offset=0&limit=20&after=string&org=string&orgID=string&name=string&id=stringLists buckets. InfluxDB retrieves buckets owned by the organization associated with the authorization (API token). To limit which buckets are returned, pass…
  • POSTCreate a bucket/bucketsCreates a bucket and returns the bucket resource. The default data retention period is 30 days. InfluxDB OSS A single InfluxDB OSS instance supports active…
  • GETRetrieve a bucket/buckets/:bucketIDRetrieves a bucket. Use this endpoint to retrieve information for a specific bucket.
  • DELETEDelete a bucket/buckets/:bucketIDDeletes a bucket and all associated records. InfluxDB Cloud Does the following when you send a delete request: 1. Validates the request and queues the delete.…
  • PATCHUpdate a bucket/buckets/:bucketIDUpdates a bucket. Use this endpoint to update properties (name, description, and retentionRules) of a bucket. InfluxDB Cloud Requires the retentionRules…
  • GETList all labels for a bucket/buckets/:bucketID/labelsLists all labels for a bucket. Labels are objects that contain labelID, name, description, and color key-value pairs. They may be used for grouping and…
  • POSTAdd a label to a bucket/buckets/:bucketID/labelsAdds a label to a bucket and returns the new label information. Labels are objects that contain labelID, name, description, and color key-value pairs. They…
  • DELETEDelete a label from a bucket/buckets/:bucketID/labels/:labelID
  • GETList all users with member privileges for a bucket/buckets/:bucketID/membersLists all users for a bucket. InfluxDB users have permission to access InfluxDB. Members are users in an organization with access to the specified resource.…
  • POSTAdd a member to a bucket/buckets/:bucketID/membersAdd a user to a bucket and return the new user information. InfluxDB users have permission to access InfluxDB. Members are users in an organization. Use this…
  • DELETERemove a member from a bucket/buckets/:bucketID/members/:userIDRemoves a member from a bucket. Use this endpoint to remove a user's member privileges from a bucket. This removes the user's read and write permissions for…
  • GETList all owners of a bucket/buckets/:bucketID/ownersLists all owners of a bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. InfluxDB Cloud Doesn't…
  • POSTAdd an owner to a bucket/buckets/:bucketID/ownersAdds an owner to a bucket and returns the owners with role and user detail. Use this endpoint to create a _resource owner_ for the bucket. Bucket owners have…
  • DELETERemove an owner from a bucket/buckets/:bucketID/owners/:userIDRemoves an owner from a bucket. Use this endpoint to remove a user's owner role for a bucket. InfluxDB Cloud Doesn't use owner and member roles. Use…

DBRPs

  • GETList database retention policy mappings/dbrps?orgID=string&org=string&id=string&bucketID=string&default=true&db=string&rp=stringLists database retention policy (DBRP) mappings. Related guide Database and retention policy mapping
  • POSTAdd a database retention policy mapping/dbrpsCreates a database retention policy (DBRP) mapping and returns the mapping. Use this endpoint to add InfluxDB 1.x API compatibility to your InfluxDB Cloud or…
  • GETRetrieve a database retention policy mapping/dbrps/:dbrpID?orgID=string&org=stringRetrieves the specified retention policy (DBRP) mapping. Related guide Database and retention policy mapping
  • DELETEDelete a database retention policy/dbrps/:dbrpID?orgID=string&org=stringDeletes the specified database retention policy (DBRP) mapping. Related guide Database and retention policy mapping
  • PATCHUpdate a database retention policy mapping/dbrps/:dbrpID?orgID=string&org=string

Debug

  • GETRetrieve all runtime profiles/debug/pprof/all?cpu=stringCollects samples and returns reports for the following Go runtime profiles: allocs: All past memory allocations block: Stack traces that led to blocking on…
  • GETRetrieve the memory allocations runtime profile/debug/pprof/allocs?debug=0&seconds=stringReturns a Go runtime profile report of all past memory allocations. allocs is the same as the heap profile, but changes the default pprof display to…
  • GETRetrieve the block runtime profile/debug/pprof/block?debug=0&seconds=stringCollects samples and returns a Go runtime profile report of stack traces that led to blocking on synchronization primitives.
  • GETRetrieve the command line invocation/debug/pprof/cmdlineReturns the command line that invoked InfluxDB.
  • GETRetrieve the goroutines runtime profile/debug/pprof/goroutine?debug=0&seconds=stringCollects statistics and returns a Go runtime profile report of all current goroutines.
  • GETRetrieve the heap runtime profile/debug/pprof/heap?debug=0&seconds=string&gc=0Collects statistics and returns a Go runtime profile report of memory allocations for live objects. To run garbage collection before sampling, pass the gc…
  • GETRetrieve the mutual exclusion (mutex) runtime profile/debug/pprof/mutex?debug=0&seconds=stringCollects statistics and returns a Go runtime profile report of lock contentions. The profile contains stack traces of holders of contended mutual exclusions…
  • GETRetrieve the CPU runtime profile/debug/pprof/profile?seconds=stringCollects statistics and returns a Go runtime profile report of program counters on the executing stack.
  • GETRetrieve the threadcreate runtime profile/debug/pprof/threadcreate?debug=0&seconds=stringCollects statistics and returns a Go runtime profile report of stack traces that led to the creation of new OS threads.
  • GETRetrieve the runtime execution trace/debug/pprof/trace?seconds=stringCollects profile data and returns trace execution events for the current program.

Organizations

  • GETList organizations/orgs?offset=0&limit=20&descending=false&org=string&orgID=string&userID=stringLists organizations. To limit which organizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all…
  • POSTCreate an organization/orgsCreates an organization and returns the newly created organization. InfluxDB Cloud Doesn't allow you to use this endpoint to create organizations. Related…
  • GETRetrieve an organization/orgs/:orgIDRetrieves an organization. Use this endpoint to retrieve information for a specific organization. Related guides View organizations
  • DELETEDelete an organization/orgs/:orgIDDeletes an organization. Deleting an organization from InfluxDB Cloud can't be undone. Once deleted, all data associated with the organization is removed.…
  • PATCHUpdate an organization/orgs/:orgIDUpdates an organization. Use this endpoint to update properties (name, description) of an organization. Updating an organization’s name affects all resources…
  • GETList all members of an organization/orgs/:orgID/membersLists all users that belong to an organization. InfluxDB users have permission to access InfluxDB. Members are users within the organization. InfluxDB Cloud…
  • POSTAdd a member to an organization/orgs/:orgID/membersAdd a user to an organization. InfluxDB users have permission to access InfluxDB. Members are users within the organization. InfluxDB Cloud Doesn't use owner…
  • DELETERemove a member from an organization/orgs/:orgID/members/:userIDRemoves a member from an organization. Use this endpoint to remove a user's member privileges for an organization. Removing member privileges removes the…
  • GETList all owners of an organization/orgs/:orgID/ownersLists all owners of an organization. InfluxDB Cloud Doesn't use owner and member roles. Use /api/v2/authorizations) to assign user permissions. Required…
  • POSTAdd an owner to an organization/orgs/:orgID/ownersAdds an owner to an organization. Use this endpoint to assign the organization owner role to a user. InfluxDB Cloud Doesn't use owner and member roles. Use…
  • DELETERemove an owner from an organization/orgs/:orgID/owners/:userIDRemoves an owner from the organization. Organization owners have permission to delete organizations and remove user and member permissions from the…

Query

  • POSTGenerate a query Abstract Syntax Tree (AST)/query/astAnalyzes a Flux query and returns a complete package source Abstract Syntax Tree (AST) for the query. Use this endpoint for deep query analysis such as…
  • GETList Flux query suggestions/query/suggestionsLists Flux query suggestions. Each suggestion contains a Flux function name and parameters. Use this endpoint to retrieve a list of Flux query suggestions…
  • GETRetrieve a query suggestion for a branching suggestion/query/suggestions/:nameRetrieves a query suggestion that contains the name and parameters of the requested function. Use this endpoint to pass a branching suggestion (a Flux…
  • POSTAnalyze a Flux query/query/analyzeAnalyzes a Flux query for syntax errors and returns the list of errors. In the following sample query, from() is missing the property key. { "query": "from(:…

Tasks

  • GETList runs for a task/tasks/:taskID/runs?after=string&limit=100&afterTime=2024-01-01T00:00:00Z&beforeTime=2024-01-01T00:00:00ZRetrieves a list of runs for a task. To limit which task runs are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB…
  • GETRetrieve a run for a task./tasks/:taskID/runs/:runIDRetrieves a specific run for a task. Use this endpoint to retrieve detail and logs for a specific task run.
  • DELETECancel a running task/tasks/:taskID/runs/:runIDCancels a running task. Use this endpoint with InfluxDB OSS to cancel a running task. InfluxDB Cloud Doesn't support this operation.
  • POSTRetry a task run/tasks/:taskID/runs/:runID/retryQueues a task run to retry and returns the scheduled run. To manually start a _new_ task run, use the POST /api/v2/tasks/{taskID}/runs endpoint. Limitations…
  • GETRetrieve all logs for a task/tasks/:taskID/logsRetrieves a list of all logs for a task. When an InfluxDB task runs, a “run” record is created in the task’s history. Logs associated with each run provide…
  • GETRetrieve all logs for a run/tasks/:taskID/runs/:runID/logsRetrieves all logs for a task run. A log is a list of run events with runID, time, and message properties. Use this endpoint to help analyze task performance…
  • GETList labels for a task/tasks/:taskID/labelsRetrieves a list of all labels for a task. Labels may be used for grouping and filtering tasks.
  • POSTAdd a label to a task/tasks/:taskID/labelsAdds a label to a task. Use this endpoint to add a label that you can use to filter tasks in the InfluxDB UI.
  • DELETEDelete a label from a task/tasks/:taskID/labels/:labelIDDeletes a label from a task.
  • GETList all task members/tasks/:taskID/membersDeprecated. Deprecated: Tasks don't use owner and member roles. Use /api/v2/authorizations) to assign user permissions. Lists all users that have the member…
  • POSTAdd a member to a task/tasks/:taskID/membersDeprecated. Deprecated: Tasks don't use owner and member roles. Use /api/v2/authorizations) to assign user permissions. Adds a user to members of a task and…
  • DELETERemove a member from a task/tasks/:taskID/members/:userIDDeprecated. Deprecated: Tasks don't use owner and member roles. Use /api/v2/authorizations) to assign user permissions. Removes a member from a task.
  • GETList all owners of a task/tasks/:taskID/ownersDeprecated. Deprecated: Tasks don't use owner and member roles. Use /api/v2/authorizations) to assign user permissions. Retrieves all users that have owner…
  • POSTAdd an owner for a task/tasks/:taskID/ownersDeprecated. Deprecated: Tasks don't use owner and member roles. Use /api/v2/authorizations) to assign user permissions. Assigns a task owner role to a user.…
  • DELETERemove an owner from a task/tasks/:taskID/owners/:userIDDeprecated. Deprecated: Tasks don't use owner and member roles. Use /api/v2/authorizations) to assign user permissions.
  • DELETEDelete a task/tasks/:taskIDDeletes a task and associated records. Use this endpoint to delete a task and all associated records (task runs, logs, and labels). Once the task is deleted,…
  • PATCHUpdate a task/tasks/:taskIDUpdates a task and then cancels all scheduled runs of the task. Use this endpoint to set, modify, and clear task properties (for example: cron, name, flux,…

Templates

  • GETList installed stacks/stacks?orgID=string&name=project-stack-0&stackID=09bd87cd33be3000Lists installed InfluxDB stacks. To limit stacks in the response, pass query parameters in your request. If no query parameters are passed, InfluxDB returns…
  • POSTCreate a stack/stacksCreates or initializes a stack. Use this endpoint to _manually_ initialize a new stack with the following optional information: Stack name Stack description…
  • GETRetrieve a stack/stacks/:stack_id
  • DELETEDelete a stack and associated resources/stacks/:stack_id?orgID=string
  • PATCHUpdate a stack/stacks/:stack_id
  • POSTUninstall a stack/stacks/:stack_id/uninstall
  • POSTApply or dry-run a template/templates/applyApplies a template to create or update a stack of InfluxDB resources. The response contains the diff of changes and the stack ID. Use this endpoint to install…
  • POSTExport a new template/templates/export

Users

  • GETRetrieve the currently authenticated user/me
  • PUTUpdate a password/me/passwordUpdates the password for the signed-in user. This endpoint represents the third step in the following three-step process to let a user with a user session…
  • POSTCreate a user/usersCreates a user that can access InfluxDB. Returns the user. Use this endpoint to create a user that can sign in to start a user session through one of the…
  • DELETEDelete a user/users/:userIDDeletes a user. Required permissions *USER_ID* is the ID of the user that you want to delete. Related guides Manage users
  • PATCHUpdate a user/users/:userIDUpdates a user and returns the user. Required permissions *USER_ID* is the ID of the user that you want to update. Related guides Manage users

Security and access endpoints

  • POSTCreate a user session./signinAuthenticates Basic authentication credentials for a user, and then, if successful, generates a user session. To authenticate a user, pass the HTTP…
  • POSTExpire a user session/signoutExpires a user session specified by a session cookie. Use this endpoint to expire a user session that was generated when the user authenticated with the…
  • PUTUpdate a password/users/:userID/passwordUpdates a user password. Use this endpoint to let a user authenticate with Basic authentication credentials and set a new password. InfluxDB Cloud Doesn't…
  • POSTUpdate a password/users/:userID/passwordUpdates a user password. InfluxDB Cloud Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a…
  • GETList users/users?offset=0&limit=20&after=string&name=string&id=stringLists users. Default limit is 20. To limit which users are returned, pass query parameters in your request. Required permissions for InfluxDB OSS *USER_ID* is…
  • GETRetrieve a user/users/:userIDRetrieves a user. Related guides Manage users

Ping

  • GETGet the status of the instance/pingRetrieves the status and InfluxDB version of the instance. Use this endpoint to monitor uptime for the InfluxDB instance. The response returns a HTTP 204…
  • HEADGet the status of the instance/pingReturns the status and InfluxDB version of the instance. Use this endpoint to monitor uptime for the InfluxDB instance. The response returns a HTTP 204 status…

Routes

  • GETList all top level routes/Retrieves all the top level routes for the InfluxDB API. Limitations Only returns top level routes--for example, the response contains…

Telegraf Plugins

  • GETList all Telegraf plugins/telegraf/plugins?type=string

Telegrafs

  • GETList all Telegraf configurations/telegrafs?orgID=string
  • POSTCreate a Telegraf configuration/telegrafs
  • GETRetrieve a Telegraf configuration/telegrafs/:telegrafID
  • PUTUpdate a Telegraf configuration/telegrafs/:telegrafID
  • DELETEDelete a Telegraf configuration/telegrafs/:telegrafID
  • GETList all labels for a Telegraf config/telegrafs/:telegrafID/labels
  • POSTAdd a label to a Telegraf config/telegrafs/:telegrafID/labels
  • DELETEDelete a label from a Telegraf config/telegrafs/:telegrafID/labels/:labelID
  • GETList all users with member privileges for a Telegraf config/telegrafs/:telegrafID/members
  • POSTAdd a member to a Telegraf config/telegrafs/:telegrafID/members
  • DELETERemove a member from a Telegraf config/telegrafs/:telegrafID/members/:userID
  • GETList all owners of a Telegraf configuration/telegrafs/:telegrafID/owners
  • POSTAdd an owner to a Telegraf configuration/telegrafs/:telegrafID/owners
  • DELETERemove an owner from a Telegraf config/telegrafs/:telegrafID/owners/:userID

Variables

  • GETList all labels for a variable/variables/:variableID/labels
  • POSTAdd a label to a variable/variables/:variableID/labels
  • DELETEDelete a label from a variable/variables/:variableID/labels/:labelID
  • GETList all variables/variables?org=string&orgID=string
  • POSTCreate a variable/variables
  • GETRetrieve a variable/variables/:variableID
  • PUTReplace a variable/variables/:variableID
  • DELETEDelete a variable/variables/:variableID
  • PATCHUpdate a variable/variables/:variableID

Data I/O endpoints

  • POSTWrite data/write?org=string&orgID=string&bucket=string&precision=msWrites data to a bucket. Use this endpoint to send data in line protocol format to InfluxDB. InfluxDB Cloud Does the following when you send a write request:…
  • POSTDelete data/delete?org=string&bucket=string&orgID=string&bucketID=stringDeletes data from a bucket. Use this endpoint to delete points from a bucket in a specified time range. InfluxDB Cloud Does the following when you send a…
  • POSTQuery data/query?org=string&orgID=stringRetrieves data from buckets. Use this endpoint to send a Flux query request and retrieve data from a bucket. Rate limits (with InfluxDB Cloud) read rate…
  • POSTStart a task run, overriding the schedule/tasks/:taskID/runsSchedules a task run to start immediately, ignoring scheduled runs. Use this endpoint to manually start a task run. Scheduled runs will continue to run as…
  • GETList tasks/tasks?name=string&after=string&user=string&org=string&orgID=string&status=active&limit=100&type=Retrieves a list of tasks. To limit which tasks are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all…
  • POSTCreate a task/tasksCreates a task and returns the task. Related guides Get started with tasks Create a task Common tasks Task configuration options
  • GETRetrieve a task/tasks/:taskIDRetrieves a task.

Labels

  • GETList all labels/labels?orgID=string
  • POSTCreate a label/labels
  • GETRetrieve a label/labels/:labelID
  • DELETEDelete a label/labels/:labelID
  • PATCHUpdate a label/labels/:labelID

Dashboards

  • GETRetrieve a dashboard/dashboards/:dashboardID?include=properties
  • DELETEDelete a dashboard/dashboards/:dashboardID
  • PATCHUpdate a dashboard/dashboards/:dashboardID
  • GETList all labels for a dashboard/dashboards/:dashboardID/labels
  • POSTAdd a label to a dashboard/dashboards/:dashboardID/labels
  • DELETEDelete a label from a dashboard/dashboards/:dashboardID/labels/:labelID
  • GETList all dashboard members/dashboards/:dashboardID/members
  • POSTAdd a member to a dashboard/dashboards/:dashboardID/members
  • DELETERemove a member from a dashboard/dashboards/:dashboardID/members/:userID
  • GETList all dashboard owners/dashboards/:dashboardID/owners
  • POSTAdd an owner to a dashboard/dashboards/:dashboardID/owners
  • DELETERemove an owner from a dashboard/dashboards/:dashboardID/owners/:userID
  • GETList dashboards/dashboards?offset=0&limit=20&descending=false&owner=string&sortBy=ID&id=string&orgID=string&org=stringLists dashboards. Related guides Manage dashboards.
  • POSTCreate a dashboard/dashboards

Cells

  • PUTReplace cells in a dashboard/dashboards/:dashboardID/cellsReplaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
  • POSTCreate a dashboard cell/dashboards/:dashboardID/cells
  • DELETEDelete a dashboard cell/dashboards/:dashboardID/cells/:cellID
  • PATCHUpdate the non-positional information related to a cell/dashboards/:dashboardID/cells/:cellIDUpdates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
  • GETRetrieve the view for a cell/dashboards/:dashboardID/cells/:cellID/view
  • PATCHUpdate the view for a cell/dashboards/:dashboardID/cells/:cellID/view

Secrets

  • GETList all secret keys for an organization/orgs/:orgID/secrets
  • PATCHUpdate secrets in an organization/orgs/:orgID/secrets
  • POSTDelete secrets from an organization/orgs/:orgID/secrets/deleteDeprecated.
  • DELETEDelete a secret from an organization/orgs/:orgID/secrets/:secretID

Resources

  • GETList all known resources/resources

Config

  • GETRetrieve feature flags/flagsRetrieves the feature flag key-value pairs configured for the InfluxDB instance. _Feature flags_ are configuration options used to develop and test…
  • GETRetrieve runtime configuration/configReturns the active runtime configuration of the InfluxDB instance. In InfluxDB v2.2+, use this endpoint to view your active runtime configuration, including…

Checks

  • GETList all checks/checks?offset=0&limit=20&orgID=string
  • POSTAdd new check/checks
  • GETRetrieve a check/checks/:checkID
  • PUTUpdate a check/checks/:checkID
  • DELETEDelete a check/checks/:checkID
  • PATCHUpdate a check/checks/:checkID
  • GETList all labels for a check/checks/:checkID/labels
  • POSTAdd a label to a check/checks/:checkID/labels
  • DELETEDelete label from a check/checks/:checkID/labels/:labelID
  • GETRetrieve a check query/checks/:checkID/query

NotificationRules

  • GETList all notification rules/notificationRules?offset=0&limit=20&orgID=string&checkID=string&tag=env:prod
  • POSTAdd a notification rule/notificationRules
  • GETRetrieve a notification rule/notificationRules/:ruleID
  • PUTUpdate a notification rule/notificationRules/:ruleID
  • DELETEDelete a notification rule/notificationRules/:ruleID
  • PATCHUpdate a notification rule/notificationRules/:ruleID
  • GETList all labels for a notification rule/notificationRules/:ruleID/labels
  • POSTAdd a label to a notification rule/notificationRules/:ruleID/labels
  • DELETEDelete label from a notification rule/notificationRules/:ruleID/labels/:labelID

Rules

  • GETRetrieve a notification rule query/notificationRules/:ruleID/query

NotificationEndpoints

  • GETList all notification endpoints/notificationEndpoints?offset=0&limit=20&orgID=string
  • POSTAdd a notification endpoint/notificationEndpoints
  • GETRetrieve a notification endpoint/notificationEndpoints/:endpointID
  • PUTUpdate a notification endpoint/notificationEndpoints/:endpointID
  • DELETEDelete a notification endpoint/notificationEndpoints/:endpointID
  • PATCHUpdate a notification endpoint/notificationEndpoints/:endpointID
  • GETList all labels for a notification endpoint/notificationEndpoints/:endpointID/labels
  • POSTAdd a label to a notification endpoint/notificationEndpoints/:endpointID/labels
  • DELETEDelete a label from a notification endpoint/notificationEndpoints/:endpointID/labels/:labelID

Health

  • GETRetrieve the health of the instance/healthReturns the health of the instance. --health-auth-mode and --hardening-enabled reduce the response body for callers without operator permissions. Those…

Metrics

  • GETRetrieve workload performance metrics/metricsReturns metrics about the workload performance of an InfluxDB instance. Use this endpoint to get performance, resource, and usage metrics. Related guides For…

Ready

  • GETGet the readiness of an instance at startup/readyReturns the readiness of the instance. --health-auth-mode and --hardening-enabled can withhold checks from callers without operator permissions. They never…

Setup

  • GETCheck if database has default user, org, bucket/setupReturns true if no default user, organization, or bucket has been created.
  • POSTSet up initial user, org and bucket/setupPost an onboarding request to set up initial user, org and bucket.

Sources

  • GETList all sources/sources?org=string
  • POSTCreate a source/sources
  • GETRetrieve a source/sources/:sourceID
  • DELETEDelete a source/sources/:sourceID
  • PATCHUpdate a Source/sources/:sourceID
  • GETGet the health of a source/sources/:sourceID/health
  • GETGet buckets in a source/sources/:sourceID/buckets?org=string

Scraper Targets

  • GETList all scraper targets/scrapers?name=string&id=string&orgID=string&org=string
  • POSTCreate a scraper target/scrapers
  • GETRetrieve a scraper target/scrapers/:scraperTargetID
  • DELETEDelete a scraper target/scrapers/:scraperTargetID
  • PATCHUpdate a scraper target/scrapers/:scraperTargetID
  • GETList all labels for a scraper target/scrapers/:scraperTargetID/labels
  • POSTAdd a label to a scraper target/scrapers/:scraperTargetID/labels
  • DELETEDelete a label from a scraper target/scrapers/:scraperTargetID/labels/:labelID
  • GETList all users with member privileges for a scraper target/scrapers/:scraperTargetID/members
  • POSTAdd a member to a scraper target/scrapers/:scraperTargetID/members
  • DELETERemove a member from a scraper target/scrapers/:scraperTargetID/members/:userID
  • GETList all owners of a scraper target/scrapers/:scraperTargetID/owners
  • POSTAdd an owner to a scraper target/scrapers/:scraperTargetID/owners
  • DELETERemove an owner from a scraper target/scrapers/:scraperTargetID/owners/:userID

Backup

  • GETDownload snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x./backup/kvDeprecated. Retrieves a snapshot of metadata stored in the server's embedded KV store. InfluxDB versions greater than 2.1.x don't include metadata stored in…
  • GETDownload snapshot of all metadata in the server/backup/metadata
  • GETDownload snapshot of all TSM data in a shard/backup/shards/:shardID?since=2006-01-02T15:04:05Z07:00

Restore

  • POSTOverwrite the embedded KV store on the server with a backed-up snapshot./restore/kv
  • POSTOverwrite the embedded SQL store on the server with a backed-up snapshot./restore/sql
  • POSTOverwrite storage metadata for a bucket with shard info from a backup./restore/bucket/:bucketIDDeprecated.
  • POSTCreate a new bucket pre-seeded with shard info from a backup./restore/bucketMetadata
  • POSTRestore a TSM snapshot into a shard./restore/shards/:shardID

RemoteConnections

  • GETList all remote connections/remotes?orgID=string&name=string&remoteURL=https://example.com
  • POSTRegister a new remote connection/remotes
  • GETRetrieve a remote connection/remotes/:remoteID
  • DELETEDelete a remote connection/remotes/:remoteID
  • PATCHUpdate a remote connection/remotes/:remoteID

Replications

  • GETList all replications/replications?orgID=string&name=string&remoteID=string&localBucketID=string
  • POSTRegister a new replication/replications?validate=false
  • GETRetrieve a replication/replications/:replicationID
  • DELETEDelete a replication/replications/:replicationID
  • PATCHUpdate a replication/replications/:replicationID?validate=false
  • POSTValidate a replication/replications/:replicationID/validate

API details

Authentication
An API key in the Authorization header
HTTP Basic authentication (username and password)
Operations
225 operations on 137 pathsGET 93POST 61DELETE 42PATCH 20PUT 8HEAD 1
9 marked deprecated
Main resources
Tasks 21Dashboards 20Security and access endpoints 20System information endpoints 17Buckets 15Scraper Targets 14Telegrafs 14Organizations 11Checks 10Debug 10
Response formats
application/json application/octet-stream text/plain application/csv
Description format
OpenAPI 3.0.0, API version 2.0.0

How to test the InfluxDB OSS API Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the InfluxDB OSS API Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List authorizations” (GET /authorizations?userID=string&user=string&orgID=string&org=string&token=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the InfluxDB OSS API Service?

The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the /api/v2/ endpoint. It is listed under Data & analytics and has 225 endpoints.

Who publishes the InfluxDB OSS API Service?

It is listed from Influxdata's public API description (an OpenAPI document), not published by Influxdata on Swastik Codes. Anyone who controls influxdata.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the InfluxDB OSS API Service?

It accepts 2 methods: an API key in the Authorization header; HTTP Basic authentication (username and password).

How many endpoints does the InfluxDB OSS API Service have?

225 operations on 137 paths (93 GET, 61 POST, 42 DELETE, 20 PATCH, 8 PUT, 1 HEAD). The largest groups are Tasks, Dashboards, Security and access endpoints, System information endpoints.

Is forking the InfluxDB OSS API Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.