Influxdata

InfluxData Invokable Scripts API

Manage and execute scripts as API endpoints in InfluxDB. An API Invokable Script assigns your custom Flux script to a new InfluxDB API endpoint for your…

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

Manage and execute scripts as API endpoints in InfluxDB.

An API Invokable Script assigns your custom Flux script to a new InfluxDB API endpoint for your organization.
Invokable scripts let you execute your script as an HTTP request to the endpoint.

Invokable scripts accept parameters. Add parameter references in your script as params.myparameter.
When you invoke your script, you send parameters as key-value pairs in the params object.
InfluxDB executes your script with the key-value pairs as arguments and returns the result.

For more information and examples, see Invoke custom scripts.

Endpoints 7

Data I/O endpoints

  • GETList scripts/scripts?offset=0&limit=100&name=stringLists scripts. Related guides Invoke custom scripts
  • GETRetrieve a script/scripts/:scriptIDRetrieves a script. Related Guides Invoke custom scripts
  • POSTInvoke a script/scripts/:scriptID/invokeRuns a script and returns the result. When the script runs, InfluxDB replaces params keys referenced in the script with params key-values passed in the…

Invokable Scripts

  • POSTCreate a script/scriptsCreates an invokable script and returns the script. Related guides Invokable scripts Creating custom InfluxDB endpoints
  • DELETEDelete a script/scripts/:scriptIDDeletes a script and all associated records. Limitations You can delete only one script per request. If the script ID you provide doesn't exist for the…
  • PATCHUpdate a script/scripts/:scriptIDUpdates an invokable script. Use this endpoint to modify values for script properties (description and script). To update a script, pass an object that…
  • GETFind script parameters./scripts/:scriptID/paramsAnalyzes a script and determines required parameters. Find all params keys referenced in a script and return a list of keys. If it is possible to determine…

API details

Authentication
None declared in the description
Operations
7 operations on 4 pathsGET 3POST 2PATCH 1DELETE 1
Main resources
Invokable Scripts 7Data I/O endpoints 3
Response formats
application/json text/csv
Description format
OpenAPI 3.0.0, API version 0.1.0

How to test the InfluxData Invokable Scripts API 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 InfluxData Invokable Scripts API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List scripts” (GET /scripts?offset=0&limit=100&name=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the InfluxData Invokable Scripts API?

Manage and execute scripts as API endpoints in InfluxDB. An API Invokable Script assigns your custom Flux script to a new InfluxDB API endpoint for your… It is listed under Data & analytics and has 7 endpoints.

Who publishes the InfluxData Invokable Scripts API?

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 InfluxData Invokable Scripts API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the InfluxData Invokable Scripts API have?

7 operations on 4 paths (3 GET, 2 POST, 1 PATCH, 1 DELETE). The largest groups are Invokable Scripts, Data I/O endpoints.

Is forking the InfluxData Invokable Scripts API 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.