docs-v2/content/influxdb3/cloud-serverless/api/invokable-scripts/_index.md

2.4 KiB

title description type layout staticFilePath weight tag isConceptual menuGroup operations related alt_links
Invokable Scripts Store, manage, and execute scripts in InfluxDB. A script stores your custom Flux script and provides an invokable endpoint that accepts runtime parameters. In a script, you can specify custom runtime parameters (`params`)--for example, `params.myparameter`. Once you create a script, InfluxDB generates an `/api/v2/scripts/SCRIPT_ID/invoke` endpoint for your organization. You can run the script from API requests and tasks, defining parameter values for each run. When the script runs, InfluxDB replaces `params` references in the script with the runtime parameter values you define. Use the `/api/v2/scripts` endpoints to create and manage scripts. See related guides to learn how to define parameters and execute scripts. <!-- TSM-only --> api list /openapi/influxdb-cloud-serverless/ref/tags/influxdb-cloud-serverless-ref-invokable-scripts.yaml 100 Invokable Scripts false Other
operationId method path summary tags
GetScripts GET /api/v2/scripts List scripts
Invokable Scripts
operationId method path summary tags
PostScripts POST /api/v2/scripts Create a script
Invokable Scripts
operationId method path summary tags
GetScriptsID GET /api/v2/scripts/{scriptID} Retrieve a script
Invokable Scripts
operationId method path summary tags
PatchScriptsID PATCH /api/v2/scripts/{scriptID} Update a script
Invokable Scripts
operationId method path summary tags
DeleteScriptsID DELETE /api/v2/scripts/{scriptID} Delete a script
Invokable Scripts
operationId method path summary tags
PostScriptsIDInvoke POST /api/v2/scripts/{scriptID}/invoke Invoke a script
Invokable Scripts
operationId method path summary tags
GetScriptsIDParams GET /api/v2/scripts/{scriptID}/params Find script parameters.
Invokable Scripts
title href
InfluxDB 3 API client libraries /influxdb3/cloud-serverless/reference/client-libraries/v3/
core enterprise cloud-serverless cloud-dedicated clustered v2 cloud
/influxdb3/core/api/ /influxdb3/enterprise/api/ /influxdb3/cloud-serverless/api/ /influxdb3/cloud-dedicated/api/ /influxdb3/clustered/api/ /influxdb/v2/api/ /influxdb/cloud/api/