Skip to content
Changelog

Report a bug

InfluxDB Cloud integration: operations for AI agents

InfluxDB Cloud connects to Type.com as an integration. This page lists the 171 operations documented for Claude and Codex in Type.com: 68 read, 61 write, 42 destructive.

About InfluxDB Cloud

InfluxDB Cloud is a fully managed, scalable, and secure time series database service designed for real-time analytics and monitoring.

Categories: Developer Tools & IT

How to connect InfluxDB Cloud to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

171 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

171 operations listed.

Security and access endpoints

  • Read

    List users

    Lists users. To limit which users are returned, pass query parameters in your request. InfluxDB Cloud - InfluxDB Cloud doesn't allow listing all users through the API. Use the InfluxDB Cloud user interface (UI) to manage account information.

  • Write

    Create a user session.

    Authenticates Basic authentication credentials for a user, and then, if successful, generates a user session. To authenticate a user, pass the HTTP Authorization header with the Basic scheme and the base64-encoded username and password.

  • Write

    Expire a user session

    Expires 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 InfluxDB Developer Console (UI) or the POST /api/v2/signin endpoint.

  • Write

    Update a password

    Updates 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 password. Related guides - InfluxDB Cloud - Change your password - InfluxDB OSS - Change your password

  • Destructive

    Update a password

    Updates a user password. Use this endpoint to let a user authenticate with Basic authentication credentials and set a new password. InfluxDB Cloud - Doesn't allow you to manage user passwords through the API. Use the InfluxDB Cloud user interface (UI) to update a password.

Ping

  • Read

    Get the status of the instance

    Retrieves 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 code to inform you the instance is available.

  • Read

    Get the status of the instance

    Returns 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 code to inform you the instance is available.

Routes

  • Read

    List 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 "tasks":"/api/v2/tasks", and doesn't contain resource-specific routes for tasks (/api/v2/tasks/TASKID/...).

DBRPs

  • Read

    List database retention policy mappings

    Lists database retention policy (DBRP) mappings. Related guide - Database and retention policy mapping

  • Read

    Retrieve a database retention policy mapping

    Retrieves the specified retention policy (DBRP) mapping. Related guide - Database and retention policy mapping

  • Write

    Add a database retention policy mapping

    Creates 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 InfluxDB OSS 2.x buckets. Your buckets must contain a DBRP mapping in order to query and write using the InfluxDB 1.x API.

  • Write

    Update a database retention policy mapping

    PATCH /dbrps/{dbrpID}

  • Destructive

    Delete a database retention policy

    Deletes the specified database retention policy (DBRP) mapping. Related guide - Database and retention policy mapping

Telegraf Plugins

  • Read

    List all Telegraf plugins

    GET /telegraf/plugins

Telegrafs

  • Read

    List all Telegraf configurations

    GET /telegrafs

  • Read

    Retrieve a Telegraf configuration

    GET /telegrafs/{telegrafID}

  • Read

    List all labels for a Telegraf config

    GET /telegrafs/{telegrafID}/labels

  • Read

    List all users with member privileges for a Telegraf config

    GET /telegrafs/{telegrafID}/members

  • Read

    List all owners of a Telegraf configuration

    GET /telegrafs/{telegrafID}/owners

  • Write

    Create a Telegraf configuration

    POST /telegrafs

  • Write

    Add a label to a Telegraf config

    POST /telegrafs/{telegrafID}/labels

  • Write

    Add a member to a Telegraf config

    POST /telegrafs/{telegrafID}/members

  • Write

    Add an owner to a Telegraf configuration

    POST /telegrafs/{telegrafID}/owners

  • Destructive

    Update a Telegraf configuration

    PUT /telegrafs/{telegrafID}

  • Destructive

    Delete a Telegraf configuration

    DELETE /telegrafs/{telegrafID}

  • Destructive

    Delete a label from a Telegraf config

    DELETE /telegrafs/{telegrafID}/labels/{labelID}

  • Destructive

    Remove a member from a Telegraf config

    DELETE /telegrafs/{telegrafID}/members/{userID}

  • Destructive

    Remove an owner from a Telegraf config

    DELETE /telegrafs/{telegrafID}/owners/{userID}

Variables

  • Read

    List all labels for a variable

    GET /variables/{variableID}/labels

  • Read

    List all variables

    GET /variables

  • Read

    Retrieve a variable

    GET /variables/{variableID}

  • Write

    Add a label to a variable

    POST /variables/{variableID}/labels

  • Write

    Create a variable

    POST /variables

  • Write

    Update a variable

    PATCH /variables/{variableID}

  • Destructive

    Delete a label from a variable

    DELETE /variables/{variableID}/labels/{labelID}

  • Destructive

    Replace a variable

    PUT /variables/{variableID}

  • Destructive

    Delete a variable

    DELETE /variables/{variableID}

Data I/O endpoints

  • Read

    Query data

    Retrieves 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 limits apply. For more information, see limits and adjustable quotas.

  • Read

    List all tasks

    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 tasks up to the default limit.

  • Read

    Retrieve a task

    Retrieves a task.

  • Write

    Write data

    Writes 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: 1. Validates the request and queues the write. 2.

  • Write

    Start a task run, overriding the schedule

    Schedules 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 scheduled. This may result in concurrently running tasks.

  • Write

    Create a task

    Creates a task and returns the task. Use this endpoint to create a scheduled task that runs a Flux script. InfluxDB Cloud - You can use either flux or scriptID to provide the task script.

  • Destructive

    Delete data

    Deletes 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 delete request: 1. Validates the request and queues the delete. 2.

Labels

  • Read

    List all labels

    GET /labels

  • Read

    Retrieve a label

    GET /labels/{labelID}

  • Write

    Create a label

    POST /labels

  • Write

    Update a label

    PATCH /labels/{labelID}

  • Destructive

    Delete a label

    DELETE /labels/{labelID}

Dashboards

  • Read

    Retrieve a dashboard

    GET /dashboards/{dashboardID}

  • Read

    List all labels for a dashboard

    GET /dashboards/{dashboardID}/labels

  • Read

    List all dashboard members

    GET /dashboards/{dashboardID}/members

  • Read

    List all dashboard owners

    GET /dashboards/{dashboardID}/owners

  • Read

    List dashboards

    Lists dashboards. Related guides - Manage dashboards.

  • Write

    Update a dashboard

    PATCH /dashboards/{dashboardID}

  • Write

    Add a label to a dashboard

    POST /dashboards/{dashboardID}/labels

  • Write

    Add a member to a dashboard

    POST /dashboards/{dashboardID}/members

  • Write

    Add an owner to a dashboard

    POST /dashboards/{dashboardID}/owners

  • Write

    Create a dashboard

    POST /dashboards

  • Destructive

    Delete a dashboard

    DELETE /dashboards/{dashboardID}

  • Destructive

    Delete a label from a dashboard

    DELETE /dashboards/{dashboardID}/labels/{labelID}

  • Destructive

    Remove a member from a dashboard

    DELETE /dashboards/{dashboardID}/members/{userID}

  • Destructive

    Remove an owner from a dashboard

    DELETE /dashboards/{dashboardID}/owners/{userID}

Cells

  • Read

    Retrieve the view for a cell

    GET /dashboards/{dashboardID}/cells/{cellID}/view

  • Write

    Create a dashboard cell

    POST /dashboards/{dashboardID}/cells

  • Write

    Update the non-positional information related to a cell

    Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

  • Write

    Update the view for a cell

    PATCH /dashboards/{dashboardID}/cells/{cellID}/view

  • Destructive

    Replace cells in a dashboard

    Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

  • Destructive

    Delete a dashboard cell

    DELETE /dashboards/{dashboardID}/cells/{cellID}

Query

  • Read

    List Flux query suggestions

    Lists Flux query suggestions. Each suggestion contains a Flux function name and parameters. Use this endpoint to retrieve a list of Flux query suggestions used in the InfluxDB Flux Query Builder.

  • Read

    Retrieve a query suggestion for a branching suggestion

    Retrieves a query suggestion that contains the name and parameters of the requested function. Use this endpoint to pass a branching suggestion (a Flux function name) and retrieve the parameters of the requested function.

  • Write

    Generate a query Abstract Syntax Tree (AST)

    Analyzes 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 debugging unexpected query results.

  • Write

    Analyze a Flux query

    Analyzes a Flux query for syntax errors and returns the list of errors. In the following sample query, from() is missing the property key.

Buckets

  • Read

    List buckets

    Lists buckets. InfluxDB retrieves buckets owned by the organization associated with the authorization (API token). To limit which buckets are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all buckets up to the default limit.

  • Read

    Retrieve a bucket

    Retrieves a bucket. Use this endpoint to retrieve information for a specific bucket.

  • Read

    List all labels for a bucket

    Lists 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 filtering InfluxDB resources.

  • Read

    List all users with member privileges for a bucket

    Lists all users for a bucket. InfluxDB users have permission to access InfluxDB. Members are users in an organization with access to the specified resource. Use this endpoint to retrieve all users with access to a bucket. Related guides - Manage users - Manage members

  • Read

    List all owners of a bucket

    Lists 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 use owner and member roles. Use /api/v2/authorizations) to assign user permissions.

  • Write

    Create a bucket

    Creates a bucket and returns the bucket resource. The default data retention period is 30 days. InfluxDB OSS - A single InfluxDB OSS instance supports active writes or queries for approximately 20 buckets across all organizations at a given time.

  • Write

    Update a bucket

    Updates a bucket. Use this endpoint to update properties (name, description, and retentionRules) of a bucket. InfluxDB Cloud - Requires the retentionRules property in the request body. If you don't provide retentionRules, InfluxDB responds with an HTTP 403 status code.

  • Write

    Add a label to a bucket

    Adds a label to a bucket and returns the new label information. Labels are objects that contain labelID, name, description, and color key-value pairs.

  • Write

    Add a member to a bucket

    Add 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 endpoint to give a user member privileges to a bucket. Related guides - Manage users - Manage members

  • Write

    Add an owner to a bucket

    Adds 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 permission to delete buckets and remove user and member permissions from the bucket.

  • Destructive

    Delete a bucket

    Deletes 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. 2. Returns an HTTP 204 status code if queued; error otherwise. 3. Handles the delete asynchronously.

  • Destructive

    Delete a label from a bucket

    DELETE /buckets/{bucketID}/labels/{labelID}

  • Destructive

    Remove a member from a bucket

    Removes 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 the bucket. Related guides - Manage users - Manage members

  • Destructive

    Remove an owner from a bucket

    Removes 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 /api/v2/authorizations) to assign user permissions. Limitations - Owner permissions are separate from API token permissions.

Organizations

  • Read

    List organizations

    Lists organizations. To limit which organizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all organizations up to the default limit.

  • Read

    Retrieve an organization

    Retrieves an organization. Use this endpoint to retrieve information for a specific organization. Related guides - View organizations

  • Read

    List all members of an organization

    Lists all users that belong to an organization. InfluxDB users have permission to access InfluxDB. Members are users within the organization. InfluxDB Cloud - Doesn't use owner and member roles. Use /api/v2/authorizations) to assign user permissions.

  • Read

    List all owners of an organization

    Lists all owners of an organization. InfluxDB Cloud - Doesn't use owner and member roles. Use /api/v2/authorizations) to assign user permissions.

  • Write

    Create an organization

    Creates an organization and returns the newly created organization. InfluxDB Cloud - Doesn't allow you to use this endpoint to create organizations. Related guides - Manage organizations

  • Write

    Update an organization

    Updates an organization. Use this endpoint to update properties (name, description) of an organization.

  • Write

    Add a member to an organization

    Add a user to an organization. InfluxDB users have permission to access InfluxDB. Members are users within the organization. InfluxDB Cloud - Doesn't use owner and member roles. Use /api/v2/authorizations) to assign user permissions.

  • Write

    Add an owner to an organization

    Adds 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 /api/v2/authorizations) to assign user permissions.

  • Destructive

    Delete an organization

    Deletes an organization. Deleting an organization from InfluxDB Cloud can't be undone. Once deleted, all data associated with the organization is removed. InfluxDB Cloud - Does the following when you send a delete request: 1. Validates the request and queues the delete. 2.

  • Destructive

    Remove a member from an organization

    Removes a member from an organization. Use this endpoint to remove a user's member privileges for an organization. Removing member privileges removes the user's read and write permissions from the organization. InfluxDB Cloud - Doesn't use owner and member roles.

  • Destructive

    Remove an owner from an organization

    Removes an owner from the organization. Organization owners have permission to delete organizations and remove user and member permissions from the organization. InfluxDB Cloud - Doesn't use owner and member roles. Use /api/v2/authorizations) to assign user permissions.

Secrets

  • Read

    List all secret keys for an organization

    GET /orgs/{orgID}/secrets

  • Write

    Update secrets in an organization

    PATCH /orgs/{orgID}/secrets

  • Destructive

    Delete a secret from an organization

    DELETE /orgs/{orgID}/secrets/{secretID}

Resources

  • Read

    List all known resources

    GET /resources

Templates

  • Read

    List installed stacks

    Lists installed InfluxDB stacks. To limit stacks in the response, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all installed stacks for the organization. Related guides - View InfluxDB stacks.

  • Read

    Retrieve a stack

    GET /stacks/{stack_id}

  • Read

    Export a new template

    POST /templates/export

  • Write

    Create a stack

    Creates or initializes a stack. Use this endpoint to manually initialize a new stack with the following optional information: - Stack name - Stack description - URLs for template manifest files To automatically create a stack when applying templates, use the /api/v2/templates/ap…

  • Write

    Update a stack

    PATCH /stacks/{stack_id}

  • Write

    Uninstall a stack

    POST /stacks/{stack_id}/uninstall

  • Write

    Apply or dry-run a template

    Applies 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 an InfluxDB template to an organization. Provide template URLs or template objects in your request.

  • Destructive

    Delete a stack and associated resources

    DELETE /stacks/{stack_id}

Tasks

  • Read

    List runs for a task

    Retrieves 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 returns all task runs up to the default limit.

  • Read

    Retrieve a run for a task.

    Retrieves a specific run for a task. Use this endpoint to retrieve detail and logs for a specific task run.

  • Read

    Retrieve all logs for a task

    Retrieves 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 relevant log messages, timestamps, and the exit status of the run attempt.

  • Read

    Retrieve all logs for a run

    Retrieves 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 and troubleshoot failed task runs.

  • Read

    List labels for a task

    Retrieves a list of all labels for a task. Labels may be used for grouping and filtering tasks.

  • Write

    Retry a task run

    Queues 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 - The task must be active (status: "active").

  • Write

    Add a label to a task

    Adds a label to a task. Use this endpoint to add a label that you can use to filter tasks in the InfluxDB UI.

  • Write

    Update a task

    Updates a task, and then cancels all scheduled runs of the task. Use this endpoint to set, modify, or clear task properties--for example: cron, name, flux, status. Once InfluxDB applies the update, it cancels all previously scheduled runs of the task.

  • Destructive

    Cancel a running task

    Cancels a running task. Use this endpoint with InfluxDB OSS to cancel a running task. InfluxDB Cloud - Doesn't support this operation.

  • Destructive

    Delete a label from a task

    Deletes a label from a task.

  • Destructive

    Delete a task

    Deletes 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, InfluxDB cancels all scheduled runs of the task.

Config

  • Read

    Retrieve feature flags

    Retrieves the feature flag key-value pairs configured for the InfluxDB instance. Feature flags are configuration options used to develop and test experimental InfluxDB features and are intended for internal use only.

Users

  • Read

    Retrieve the currently authenticated user

    GET /me

  • Read

    Retrieve a user

    Retrieves a user. Related guides - Manage users

  • Write

    Create a user

    (InfluxData internal use only) Creates and returns a user that can access InfluxDB. InfluxDB Cloud - InfluxDB Cloud Doesn't let you manage users through the API. Use the InfluxDB Cloud user interface (UI) to manage account information.

  • Write

    Update a user

    (InfluxData internal use only) Updates a user and returns the user. InfluxDB Cloud - Doesn't let you manage users through the API. Use the InfluxDB Cloud user interface (UI) to manage account information.

  • Destructive

    Update a password

    Updates 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 update their password: 1.

  • Destructive

    Delete a user

    (InfluxData internal use only) Deletes a user. For security purposes, once an InfluxDB user account is deleted from an organization, the user (and their token) cannot be reactivated. InfluxDB Cloud - Doesn't let you manage users through the API.

Checks

  • Read

    List all checks

    GET /checks

  • Read

    Retrieve a check

    GET /checks/{checkID}

  • Read

    List all labels for a check

    GET /checks/{checkID}/labels

  • Read

    Retrieve a check query

    GET /checks/{checkID}/query

  • Write

    Add new check

    POST /checks

  • Write

    Update a check

    PATCH /checks/{checkID}

  • Write

    Add a label to a check

    POST /checks/{checkID}/labels

  • Destructive

    Update a check

    PUT /checks/{checkID}

  • Destructive

    Delete a check

    DELETE /checks/{checkID}

  • Destructive

    Delete label from a check

    DELETE /checks/{checkID}/labels/{labelID}

Notification Rules

  • Read

    List all notification rules

    GET /notificationRules

  • Read

    Retrieve a notification rule

    GET /notificationRules/{ruleID}

  • Read

    List all labels for a notification rule

    GET /notificationRules/{ruleID}/labels

  • Write

    Add a notification rule

    POST /notificationRules

  • Write

    Update a notification rule

    PATCH /notificationRules/{ruleID}

  • Write

    Add a label to a notification rule

    POST /notificationRules/{ruleID}/labels

  • Destructive

    Update a notification rule

    PUT /notificationRules/{ruleID}

  • Destructive

    Delete a notification rule

    DELETE /notificationRules/{ruleID}

  • Destructive

    Delete label from a notification rule

    DELETE /notificationRules/{ruleID}/labels/{labelID}

Rules

  • Read

    Retrieve a notification rule query

    GET /notificationRules/{ruleID}/query

Notification Endpoints

  • Read

    List all notification endpoints

    GET /notificationEndpoints

  • Read

    Retrieve a notification endpoint

    GET /notificationEndpoints/{endpointID}

  • Read

    List all labels for a notification endpoint

    GET /notificationEndpoints/{endpointID}/labels

  • Write

    Add a notification endpoint

    POST /notificationEndpoints

  • Write

    Update a notification endpoint

    PATCH /notificationEndpoints/{endpointID}

  • Write

    Add a label to a notification endpoint

    POST /notificationEndpoints/{endpointID}/labels

  • Destructive

    Update a notification endpoint

    PUT /notificationEndpoints/{endpointID}

  • Destructive

    Delete a notification endpoint

    DELETE /notificationEndpoints/{endpointID}

  • Destructive

    Delete a label from a notification endpoint

    DELETE /notificationEndpoints/{endpointID}/labels/{labelID}

Authorizations (API tokens)

  • Read

    List authorizations

    Lists authorizations. To limit which authorizations are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all authorizations.

  • Read

    Retrieve an authorization

    Retrieves an authorization. Use this endpoint to retrieve information about an API token, including the token's permissions and the user that the token is scoped to. InfluxDB OSS - InfluxDB OSS returns API token values in authorizations.

  • Write

    Create an authorization

    Creates an authorization and returns the authorization with the generated API token. Use this endpoint to create an authorization, which generates an API token with permissions to read or write to a specific resource or type of resource.

  • Write

    Update an API token to be active or inactive

    Updates 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.

  • Destructive

    Delete an authorization

    Deletes 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 to inactive.

Setup

  • Read

    Retrieve setup status

    Check if setup is allowed. Returns true if no default user, organization, or bucket have been created.

  • Write

    Create an initial user, organization, and bucket

    Post an onboarding request to create an initial user, organization, and bucket.

  • Write

    Create a new user, organization, and bucket

    Post an onboarding request to create a new user, organization, and bucket.

Bucket Schemas

  • Read

    List measurement schemas of a bucket

    Lists explicit schemas ("schemaType": "explicit") for a bucket. Explicit schemas are used to enforce column names, tags, fields, and data types for your data. By default, buckets have an implicit schema-type ("schemaType": "implicit") that conforms to your data.

  • Read

    Retrieve a measurement schema

    Retrieves an explicit measurement schema.

  • Write

    Create a measurement schema for a bucket

    Creates an explict measurement schema for a bucket. Explicit schemas are used to enforce column names, tags, fields, and data types for your data. By default, buckets have an implicit schema-type ("schemaType": "implicit") that conforms to your data.

  • Write

    Update a measurement schema

    Updates a measurement schema. Use this endpoint to update the fields (name, type, and dataType) of a measurement schema. Limitations - You can't update the name of a measurement. Related guides - Manage bucket schemas. - Using bucket schemas.

Limits

  • Read

    Retrieve limits for an organization

    GET /orgs/{orgID}/limits

Usage

  • Read

    Retrieve usage for an organization

    GET /orgs/{orgID}/usage

See How connections work for access and permissions, or browse all integrations.