Influx OSS API Service
Authentication
<!-- ReDoc-Inject: <security-definitions> -->
- Homepage
- https://api.apis.guru/v2/specs/influxdata.com/2.0.0.json
- Provider
- influxdata.com
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/influxdata.com/2.0.0/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/influxdata.com/2.0.0/openapi.yaml
Tools (199)
Extracted live via the executor SDK.
-
authorizations.deleteAuthorizationsIdDelete an authorization
-
authorizations.getAuthorizationsList all authorizations
-
authorizations.getAuthorizationsIdRetrieve an authorization
-
authorizations.patchAuthorizationsIdUpdate an authorization to be active or inactive
-
authorizations.postAuthorizationsCreate an authorization
-
buckets.deleteBucketsIdDelete a bucket
-
buckets.deleteBucketsIdLabelsIdDelete a label from a bucket
-
buckets.deleteBucketsIdMembersIdRemove a member from a bucket
-
buckets.deleteBucketsIdOwnersIdRemove an owner from a bucket
-
buckets.getBucketsList all buckets
-
buckets.getBucketsIdRetrieve a bucket
-
buckets.getBucketsIdLabelsList all labels for a bucket
-
buckets.getBucketsIdMembersList all users with member privileges for a bucket
-
buckets.getBucketsIdOwnersList all owners of a bucket
-
buckets.patchBucketsIdUpdate a bucket
-
buckets.postBucketsCreate a bucket
-
buckets.postBucketsIdLabelsAdd a label to a bucket
-
buckets.postBucketsIdMembersAdd a member to a bucket
-
buckets.postBucketsIdOwnersAdd an owner to a bucket
-
cells.deleteDashboardsIdCellsIdDelete a dashboard cell
-
cells.getDashboardsIdCellsIdViewRetrieve the view for a cell
-
cells.patchDashboardsIdCellsIdUpdates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
-
cells.patchDashboardsIdCellsIdViewUpdate the view for a cell
-
cells.postDashboardsIdCellsCreate a dashboard cell
-
cells.putDashboardsIdCellsReplaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
-
checks.createCheckAdd new check
-
checks.deleteChecksIdDelete a check
-
checks.deleteChecksIdLabelsIdDelete label from a check
-
checks.getChecksList all checks
-
checks.getChecksIdRetrieve a check
-
checks.getChecksIdLabelsList all labels for a check
-
checks.getChecksIdQueryRetrieve a check query
-
checks.patchChecksIdUpdate a check
-
checks.postChecksIdLabelsAdd a label to a check
-
checks.putChecksIdUpdate a check
-
dashboards.deleteDashboardsIdDelete a dashboard
-
dashboards.deleteDashboardsIdLabelsIdDelete a label from a dashboard
-
dashboards.deleteDashboardsIdMembersIdRemove a member from a dashboard
-
dashboards.deleteDashboardsIdOwnersIdRemove an owner from a dashboard
-
dashboards.getDashboardsList all dashboards
-
dashboards.getDashboardsIdRetrieve a Dashboard
-
dashboards.getDashboardsIdLabelsList all labels for a dashboard
-
dashboards.getDashboardsIdMembersList all dashboard members
-
dashboards.getDashboardsIdOwnersList all dashboard owners
-
dashboards.patchDashboardsIdUpdate a dashboard
-
dashboards.postDashboardsCreate a dashboard
-
dashboards.postDashboardsIdLabelsAdd a label to a dashboard
-
dashboards.postDashboardsIdMembersAdd a member to a dashboard
-
dashboards.postDashboardsIdOwnersAdd an owner to a dashboard
-
dbrPs.deleteDbrpidDelete a database retention policy
-
dbrPs.getDbrPsList all database retention policy mappings
-
dbrPs.getDbrPsIdRetrieve a database retention policy mapping
-
dbrPs.patchDbrpidUpdate a database retention policy mapping
-
dbrPs.postDbrpAdd a database retention policy mapping
-
delete.postDeleteDelete time series data from InfluxDB
-
health.getHealthGet the health of an instance
-
influxDbTemplates.applyTemplateApply or dry-run an InfluxDB Template
-
influxDbTemplates.createStackCreate a new stack
-
influxDbTemplates.deleteStackDelete a stack and associated resources
-
influxDbTemplates.exportTemplateExport a new Influx Template
-
influxDbTemplates.listStacksList all installed InfluxDB templates
-
influxDbTemplates.readStackRetrieve a stack
-
influxDbTemplates.uninstallStackUninstall an InfluxDB Stack
-
influxDbTemplates.updateStackUpdate an InfluxDB Stack
-
labels.deleteLabelsIdDelete a label
-
labels.getLabelsList all labels
-
labels.getLabelsIdRetrieve a label
-
labels.patchLabelsIdUpdate a label
-
labels.postLabelsCreate a label
-
notificationEndpoints.createNotificationEndpointAdd a notification endpoint
-
notificationEndpoints.deleteNotificationEndpointsIdDelete a notification endpoint
-
notificationEndpoints.deleteNotificationEndpointsIdLabelsIdDelete a label from a notification endpoint
-
notificationEndpoints.getNotificationEndpointsList all notification endpoints
-
notificationEndpoints.getNotificationEndpointsIdRetrieve a notification endpoint
-
notificationEndpoints.getNotificationEndpointsIdLabelsList all labels for a notification endpoint
-
notificationEndpoints.patchNotificationEndpointsIdUpdate a notification endpoint
-
notificationEndpoints.postNotificationEndpointIdLabelsAdd a label to a notification endpoint
-
notificationEndpoints.putNotificationEndpointsIdUpdate a notification endpoint
-
notificationRules.createNotificationRuleAdd a notification rule
-
notificationRules.deleteNotificationRulesIdDelete a notification rule
-
notificationRules.deleteNotificationRulesIdLabelsIdDelete label from a notification rule
-
notificationRules.getNotificationRulesList all notification rules
-
notificationRules.getNotificationRulesIdRetrieve a notification rule
-
notificationRules.getNotificationRulesIdLabelsList all labels for a notification rule
-
notificationRules.patchNotificationRulesIdUpdate a notification rule
-
notificationRules.postNotificationRuleIdLabelsAdd a label to a notification rule
-
notificationRules.putNotificationRulesIdUpdate a notification rule
-
organizations.deleteOrgsIdDelete an organization
-
organizations.deleteOrgsIdMembersIdRemove a member from an organization
-
organizations.deleteOrgsIdOwnersIdRemove an owner from an organization
-
organizations.getOrgsList all organizations
-
organizations.getOrgsIdRetrieve an organization
-
organizations.getOrgsIdMembersList all members of an organization
-
organizations.getOrgsIdOwnersList all owners of an organization
-
organizations.patchOrgsIdUpdate an organization
-
organizations.postOrgsCreate an organization
-
organizations.postOrgsIdMembersAdd a member to an organization
-
organizations.postOrgsIdOwnersAdd an owner to an organization
-
query.getQuerySuggestionsRetrieve query suggestions
-
query.getQuerySuggestionsNameRetrieve query suggestions for a branching suggestion
-
query.postQueryQuery InfluxDB
-
query.postQueryAnalyzeAnalyze an InfluxQL or Flux query
-
query.postQueryAstAnalyzes flux query and generates a query specification.
-
ready.getReadyGet the readiness of an instance at startup
-
routes.getRoutesList all top level routes
-
rules.getNotificationRulesIdQueryRetrieve a notification rule query
-
scraperTargets.deleteScrapersIdDelete a scraper target
-
scraperTargets.deleteScrapersIdLabelsIdDelete a label from a scraper target
-
scraperTargets.deleteScrapersIdMembersIdRemove a member from a scraper target
-
scraperTargets.deleteScrapersIdOwnersIdRemove an owner from a scraper target
-
scraperTargets.getScrapersList all scraper targets
-
scraperTargets.getScrapersIdRetrieve a scraper target
-
scraperTargets.getScrapersIdLabelsList all labels for a scraper target
-
scraperTargets.getScrapersIdMembersList all users with member privileges for a scraper target
-
scraperTargets.getScrapersIdOwnersList all owners of a scraper target
-
scraperTargets.patchScrapersIdUpdate a scraper target
-
scraperTargets.postScrapersCreate a scraper target
-
scraperTargets.postScrapersIdLabelsAdd a label to a scraper target
-
scraperTargets.postScrapersIdMembersAdd a member to a scraper target
-
scraperTargets.postScrapersIdOwnersAdd an owner to a scraper target
-
secrets.getOrgsIdSecretsList all secret keys for an organization
-
secrets.patchOrgsIdSecretsUpdate secrets in an organization
-
secrets.postOrgsIdSecretsDelete secrets from an organization
-
setup.getSetupReturns
trueif no default user, organization, or bucket has been created. -
setup.postSetupPost an onboarding request to set up initial user, org and bucket.
-
signin.postSigninExchange basic auth credentials for session
-
signout.postSignoutExpire the current session
-
sources.deleteSourcesIdDelete a source
-
sources.getSourcesList all sources
-
sources.getSourcesIdRetrieve a source
-
sources.getSourcesIdBucketsGet buckets in a source
-
sources.getSourcesIdHealthGet the health of a source
-
sources.patchSourcesIdUpdate a Source
-
sources.postSourcesCreate a source
-
tasks.deleteTasksIdDeletes a task and all associated records
-
tasks.deleteTasksIdLabelsIdDelete a label from a task
-
tasks.deleteTasksIdMembersIdRemove a member from a task
-
tasks.deleteTasksIdOwnersIdRemove an owner from a task
-
tasks.deleteTasksIdRunsIdCancel a running task
-
tasks.getTasksList all tasks
-
tasks.getTasksIdRetrieve a task
-
tasks.getTasksIdLabelsList all labels for a task
-
tasks.getTasksIdLogsRetrieve all logs for a task
-
tasks.getTasksIdMembersList all task members
-
tasks.getTasksIdOwnersList all owners of a task
-
tasks.getTasksIdRunsList runs for a task
-
tasks.getTasksIdRunsIdRetrieve a single run for a task
-
tasks.getTasksIdRunsIdLogsRetrieve all logs for a run
-
tasks.patchTasksIdUpdate a task. This will cancel all queued runs.
-
tasks.postTasksCreate a new task
-
tasks.postTasksIdLabelsAdd a label to a task
-
tasks.postTasksIdMembersAdd a member to a task
-
tasks.postTasksIdOwnersAdd an owner to a task
-
tasks.postTasksIdRunsManually start a task run, overriding the current schedule
-
tasks.postTasksIdRunsIdRetryRetry a task run
-
telegrafPlugins.getTelegrafPluginsList all Telegraf plugins
-
telegrafs.deleteTelegrafsIdDelete a Telegraf configuration
-
telegrafs.deleteTelegrafsIdLabelsIdDelete a label from a Telegraf config
-
telegrafs.deleteTelegrafsIdMembersIdRemove a member from a Telegraf config
-
telegrafs.deleteTelegrafsIdOwnersIdRemove an owner from a Telegraf config
-
telegrafs.getTelegrafsList all Telegraf configurations
-
telegrafs.getTelegrafsIdRetrieve a Telegraf configuration
-
telegrafs.getTelegrafsIdLabelsList all labels for a Telegraf config
-
telegrafs.getTelegrafsIdMembersList all users with member privileges for a Telegraf config
-
telegrafs.getTelegrafsIdOwnersList all owners of a Telegraf configuration
-
telegrafs.postTelegrafsCreate a Telegraf configuration
-
telegrafs.postTelegrafsIdLabelsAdd a label to a Telegraf config
-
telegrafs.postTelegrafsIdMembersAdd a member to a Telegraf config
-
telegrafs.postTelegrafsIdOwnersAdd an owner to a Telegraf configuration
-
telegrafs.putTelegrafsIdUpdate a Telegraf configuration
-
templates.deleteDocumentsTemplatesIdDelete a template
-
templates.deleteDocumentsTemplatesIdLabelsIdDelete a label from a template
-
templates.getDocumentsTemplatesList all templates
-
templates.getDocumentsTemplatesIdRetrieve a template
-
templates.getDocumentsTemplatesIdLabelsList all labels for a template
-
templates.postDocumentsTemplatesCreate a template
-
templates.postDocumentsTemplatesIdLabelsAdd a label to a template
-
templates.putDocumentsTemplatesIdUpdate a template
-
users.deleteUsersIdDelete a user
-
users.getFlagsReturn the feature flags for the currently authenticated user
-
users.getMeRetrieve the currently authenticated user
-
users.getUsersList all users
-
users.getUsersIdRetrieve a user
-
users.patchUsersIdUpdate a user
-
users.postUsersCreate a user
-
users.postUsersIdPasswordUpdate a password
-
users.putMePasswordUpdate a password
-
variables.deleteVariablesIdDelete a variable
-
variables.deleteVariablesIdLabelsIdDelete a label from a variable
-
variables.getVariablesList all variables
-
variables.getVariablesIdRetrieve a variable
-
variables.getVariablesIdLabelsList all labels for a variable
-
variables.patchVariablesIdUpdate a variable
-
variables.postVariablesCreate a variable
-
variables.postVariablesIdLabelsAdd a label to a variable
-
variables.putVariablesIdReplace a variable
-
write.postWriteWrite time series data into InfluxDB
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools