{ "opencollection": "1.0.0", "info": { "name": "Complete InfluxDB Cloud API" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Routes", "type": "folder" }, "items": [ { "info": { "name": "List all top level routes", "type": "http" }, "http": { "method": "GET", "url": "/api/v2", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ] }, "docs": "Retrieves all the top level routes for the InfluxDB API.\n\n#### Limitations\n\n- Only returns top level routes--for example, the response contains\n`\"tasks\":\"/api/v2/tasks\"`, and doesn't contain resource-specific routes\nfor tasks (`/api/v2/tasks/TASK_ID/...`).\n" } ] }, { "info": { "name": "Authorizations (API tokens)", "type": "folder" }, "items": [ { "info": { "name": "List authorizations", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/authorizations", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "query", "description": "A user ID.\nOnly returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n" }, { "name": "user", "value": "", "type": "query", "description": "A user name.\nOnly returns authorizations scoped to the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID. Only returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization)." }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\nOnly returns authorizations that belong to the specified [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).\n" }, { "name": "token", "value": "", "type": "query", "description": "An API [token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token) value.\nSpecifies an authorization by its `token` property value\nand returns the authorization.\n\n#### InfluxDB OSS\n\n- Doesn't support this parameter. InfluxDB OSS ignores the `token=` parameter,\n applies other parameters, and then returns the result.\n\n#### Limitations\n\n- The parameter is non-repeatable. If you specify more than one,\n only the first one is used. If a resource with the specified\n property value doesn't exist, then the response body contains an empty list.\n" } ] }, "docs": "Lists authorizations.\n\nTo limit which authorizations are returned, pass query parameters in your request.\nIf no query parameters are passed, InfluxDB returns all authorizations.\n\n#### InfluxDB Cloud\n\n- InfluxDB Cloud doesn't expose [API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\n values in `GET /api/v2/authorizations` responses;\n returns `token: redacted` for all authorizations.\n\n#### Required permissions\n\nTo retrieve an authorization, the request must use an " }, { "info": { "name": "Create an authorization", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/authorizations", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an authorization and returns the authorization with the\ngenerated API [token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token).\n\nUse this endpoint to create an authorization, which generates an API token\nwith permissions to `read` or `write` to a specific resource or `type` of resource.\nThe API token is the authorization's `token` property value.\n\nTo follow best practices for secure API token generation and retrieval,\nInfluxDB enforces access restrictions on API toke" }, { "info": { "name": "Retrieve an authorization", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/authorizations/:authID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "authID", "value": "", "type": "path", "description": "An authorization ID. Specifies the authorization to retrieve." } ] }, "docs": "Retrieves an authorization.\n\nUse this endpoint to retrieve information about an API token, including\nthe token's permissions and the user that the token is scoped to.\n\n#### InfluxDB OSS\n\n- InfluxDB OSS returns\n [API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token) values in authorizations.\n- If the request uses an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_,\n InfluxDB OSS returns authorizations for all organization" }, { "info": { "name": "Update an API token to be active or inactive", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/authorizations/:authID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "authID", "value": "", "type": "path", "description": "An authorization ID. Specifies the authorization to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an authorization.\n\nUse this endpoint to set an API token's status to be _active_ or _inactive_.\nInfluxDB rejects requests that use inactive API tokens.\n" }, { "info": { "name": "Delete an authorization", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/authorizations/:authID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "authID", "value": "", "type": "path", "description": "An authorization ID. Specifies the authorization to delete." } ] }, "docs": "Deletes an authorization.\n\nUse the endpoint to delete an API token.\n\nIf you want to disable an API token instead of delete it,\n[update the authorization's status to `inactive`](#operation/PatchAuthorizationsID).\n" } ] }, { "info": { "name": "Buckets", "type": "folder" }, "items": [ { "info": { "name": "List buckets", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/buckets", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination.\nThe number of records to skip.\n\nFor more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limits the number of records returned. Default is `20`.\n" }, { "name": "after", "value": "", "type": "query", "description": "A resource ID to seek from.\nReturns records created after the specified record;\nresults don't include the specified record.\n\nUse `after` instead of the `offset` parameter.\nFor more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).\n" }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\n\n#### InfluxDB Cloud\n\n- Doesn't use the `org` parameter or `orgID` parameter.\n- Lists buckets for the organization associated with the authorization (API token).\n\n#### InfluxDB OSS\n\n- Lists buckets for the specified organization.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\n\n#### InfluxDB Cloud\n\n- Doesn't use the `org` parameter or `orgID` parameter.\n- Lists buckets for the organization associated with the authorization (API token).\n\n#### InfluxDB OSS\n\n- Requires either the `org` parameter or `orgID` parameter.\n- Lists buckets for the specified organization.\n" }, { "name": "name", "value": "", "type": "query", "description": "A bucket name.\nOnly returns buckets with the specified name.\n" }, { "name": "id", "value": "", "type": "query", "description": "A bucket ID.\nOnly returns the bucket with the specified ID.\n" } ] }, "docs": "Lists [buckets](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#bucket).\n\nInfluxDB retrieves buckets owned by the\n[organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization)\nassociated with the authorization\n([API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)).\nTo limit which buckets are returned, pass query parameters in your request.\nIf no query parameters are passed, InfluxDB returns all buckets up to the\ndefault `l" }, { "info": { "name": "Create a bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/buckets", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a [bucket](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#bucket)\nand returns the bucket resource.\nThe default data\n[retention period](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#retention-period)\nis 30 days.\n\n#### InfluxDB OSS\n\n- A single InfluxDB OSS instance supports active writes or queries for\napproximately 20 buckets across all organizations at a given time.\nReading or writing to more than 20 buckets at a time can adversely affect\nperformance.\n\n##" }, { "info": { "name": "Retrieve a bucket", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/buckets/:bucketID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "The ID of the bucket to retrieve.\n" } ] }, "docs": "Retrieves a bucket.\n\nUse this endpoint to retrieve information for a specific bucket.\n" }, { "info": { "name": "Update a bucket", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/buckets/:bucketID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "The bucket ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a bucket.\n\nUse this endpoint to update properties\n(`name`, `description`, and `retentionRules`) of a bucket.\n\n#### InfluxDB Cloud\n\n- Requires the `retentionRules` property in the request body. If you don't\nprovide `retentionRules`, InfluxDB responds with an HTTP `403` status code.\n\n#### InfluxDB OSS\n\n- Doesn't require `retentionRules`.\n\n#### Related Guides\n\n- [Update a bucket](https://docs.influxdata.com/influxdb/cloud/organizations/buckets/update-bucket/)\n" }, { "info": { "name": "Delete a bucket", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/buckets/:bucketID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "Bucket ID.\nThe ID of the bucket to delete.\n" } ] }, "docs": "Deletes a bucket and all associated records.\n\n#### InfluxDB Cloud\n\n- Does the following when you send a delete request:\n\n 1. Validates the request and queues the delete.\n 2. Returns an HTTP `204` status code if queued; _error_ otherwise.\n 3. Handles the delete asynchronously.\n\n#### InfluxDB OSS\n\n- Validates the request, handles the delete synchronously,\nand then responds with success or failure.\n\n#### Limitations\n\n- Only one bucket can be deleted per request.\n\n#### Related Guides\n\n- [Delete a" }, { "info": { "name": "List all labels for a bucket", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/buckets/:bucketID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "The ID of the bucket to retrieve labels for.\n" } ] }, "docs": "Lists all labels for a bucket.\n\nLabels are objects that contain `labelID`, `name`, `description`, and `color`\nkey-value pairs. They may be used for grouping and filtering InfluxDB\nresources.\nLabels are also capable of grouping across different resources--for example,\nyou can apply a label named `air_sensor` to a bucket and a task to quickly\norganize resources.\n\n#### Related guides\n\n- Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels.\n- [Manage labels in " }, { "info": { "name": "Add a label to a bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/buckets/:bucketID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "Bucket ID.\nThe ID of the bucket to label.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a label to a bucket and returns the new label information.\n\nLabels are objects that contain `labelID`, `name`, `description`, and `color`\nkey-value pairs. They may be used for grouping and filtering across one or\nmore kinds of **resources**--for example, you can apply a label named\n`air_sensor` to a bucket and a task to quickly organize resources.\n\n#### Limitations\n\n- Before adding a label to a bucket, you must create the label if you\n haven't already. To create a label with the InfluxDB A" }, { "info": { "name": "Delete a label from a bucket", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/buckets/:bucketID/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "The bucket ID." }, { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to delete." } ] }, "docs": "Delete a label from a bucket" }, { "info": { "name": "List all users with member privileges for a bucket", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/buckets/:bucketID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "The ID of the bucket to retrieve users for.\n" } ] }, "docs": "Lists all users for a bucket.\n\nInfluxDB [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) have\npermission to access InfluxDB.\n\n[Members](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#member) are users in\nan organization with access to the specified resource.\n\nUse this endpoint to retrieve all users with access to a bucket.\n\n#### Related guides\n\n- [Manage users](https://docs.influxdata.com/influxdb/cloud/users/)\n- [Manage members](https://docs.influxdat" }, { "info": { "name": "Add a member to a bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/buckets/:bucketID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "The ID of the bucket to retrieve users for.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user to a bucket and return the new user information.\n\nInfluxDB [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) have\npermission to access InfluxDB.\n\n[Members](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#member) are users in\nan organization.\n\nUse this endpoint to give a user member privileges to a bucket.\n\n#### Related guides\n\n- [Manage users](https://docs.influxdata.com/influxdb/cloud/users/)\n- [Manage members](https://docs.influxdata.com/inf" }, { "info": { "name": "Remove a member from a bucket", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/buckets/:bucketID/members/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the user to remove.\n" }, { "name": "bucketID", "value": "", "type": "path", "description": "The ID of the bucket to remove a user from.\n" } ] }, "docs": "Removes a member from a bucket.\n\nUse this endpoint to remove a user's member privileges from a bucket. This\nremoves the user's `read` and `write` permissions for the bucket.\n\n#### Related guides\n\n- [Manage users](https://docs.influxdata.com/influxdb/cloud/users/)\n- [Manage members](https://docs.influxdata.com/influxdb/cloud/organizations/members/)\n" }, { "info": { "name": "List all owners of a bucket", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/buckets/:bucketID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "The ID of the bucket to retrieve owners for.\n" } ] }, "docs": "Lists all [owners](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#owner)\nof a bucket.\n\nBucket owners have permission to delete buckets and remove user and member\npermissions from the bucket.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Owner permissions are separate from API token permissions.\n- Owner permissions are used in the context of the Inf" }, { "info": { "name": "Add an owner to a bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/buckets/:bucketID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "bucketID", "value": "", "type": "path", "description": "The ID of the bucket to add an owner for.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#owner)\nwith role and user detail.\n\nUse this endpoint to create a _resource owner_ for the bucket.\nBucket owners have permission to delete buckets and remove user and member\npermissions from the bucket.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Owne" }, { "info": { "name": "Remove an owner from a bucket", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/buckets/:bucketID/owners/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the owner to remove.\n" }, { "name": "bucketID", "value": "", "type": "path", "description": "The ID of the bucket to remove an owner from.\n" } ] }, "docs": "Removes an owner from a bucket.\n\nUse this endpoint to remove a user's `owner` role for a bucket.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Owner permissions are separate from API token permissions.\n- Owner permissions are used in the context of the InfluxDB UI.\n\n#### Required permissions\n\n- `write-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organiz" } ] }, { "info": { "name": "Bucket Schemas", "type": "folder" }, "items": [ { "info": { "name": "List measurement schemas of a bucket", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/buckets/:bucketID/schema/measurements", "params": [ { "name": "org", "value": "", "type": "query", "description": "An organization name.\nSpecifies the organization that owns the schema.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nSpecifies the organization that owns the schema.\n" }, { "name": "name", "value": "", "type": "query", "description": "A measurement name.\nOnly returns measurement schemas with the specified name.\n" }, { "name": "bucketID", "value": "", "type": "path", "description": "A bucket ID.\nLists measurement schemas for the specified bucket.\n" } ] }, "docs": "Lists _explicit_\n[schemas](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#schema)\n(`\"schemaType\": \"explicit\"`) for a bucket.\n\n_Explicit_ schemas are used to enforce column names, tags, fields, and data\ntypes for your data.\n\nBy default, buckets have an _implicit_ schema-type (`\"schemaType\": \"implicit\"`)\nthat conforms to your data.\n\n#### Related guides\n\n- [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwanted-schema-changes/)\n" }, { "info": { "name": "Create a measurement schema for a bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/buckets/:bucketID/schema/measurements", "params": [ { "name": "org", "value": "", "type": "query", "description": "An organization name.\nSpecifies the organization that owns the schema.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nSpecifies the organization that owns the schema.\n" }, { "name": "bucketID", "value": "", "type": "path", "description": "A bucket ID.\nAdds a schema for the specified bucket.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an _explict_ measurement [schema](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#schema)\nfor a bucket.\n\n_Explicit_ schemas are used to enforce column names, tags, fields, and data\ntypes for your data.\n\nBy default, buckets have an _implicit_ schema-type (`\"schemaType\": \"implicit\"`)\nthat conforms to your data.\n\nUse this endpoint to create schemas that prevent non-conforming write requests.\n\n#### Limitations\n\n- Buckets must be created with the \"explict\" `schemaType` in order" }, { "info": { "name": "Retrieve a measurement schema", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/buckets/:bucketID/schema/measurements/:measurementID", "params": [ { "name": "org", "value": "", "type": "query", "description": "Organization name.\nSpecifies the organization that owns the schema.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "Organization ID.\nSpecifies the organization that owns the schema.\n" }, { "name": "bucketID", "value": "", "type": "path", "description": "A bucket ID.\nRetrieves schemas for the specified bucket.\n" }, { "name": "measurementID", "value": "", "type": "path", "description": "The measurement schema ID.\nSpecifies the measurement schema to retrieve.\n" } ] }, "docs": "Retrieves an explicit measurement [schema](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#schema).\n" }, { "info": { "name": "Update a measurement schema", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/buckets/:bucketID/schema/measurements/:measurementID", "params": [ { "name": "org", "value": "", "type": "query", "description": "An organization name.\nSpecifies the organization that owns the schema.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nSpecifies the organization that owns the schema.\n" }, { "name": "bucketID", "value": "", "type": "path", "description": "A bucket ID.\nSpecifies the bucket to retrieve schemas for.\n" }, { "name": "measurementID", "value": "", "type": "path", "description": "A measurement schema ID.\nRetrieves the specified measurement schema.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a measurement [schema](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#schema).\n\nUse this endpoint to update the fields (`name`, `type`, and `dataType`) of a\nmeasurement schema.\n\n#### Limitations\n\n- You can't update the `name` of a measurement.\n\n#### Related guides\n\n- [Manage bucket schemas](https://docs.influxdata.com/influxdb/cloud/organizations/buckets/bucket-schema/).\n- [Using bucket schemas](https://www.influxdata.com/blog/new-bucket-schema-option-protect-from-unwante" } ] }, { "info": { "name": "Checks", "type": "folder" }, "items": [ { "info": { "name": "List all checks", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/checks", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination.\nThe number of records to skip.\n\nFor more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limits the number of records returned. Default is `20`.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "Only show checks that belong to a specific organization ID." } ] }, "docs": "List all checks" }, { "info": { "name": "Add new check", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/checks", "body": { "type": "json", "data": "{}" } }, "docs": "Add new check" }, { "info": { "name": "Retrieve a check", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/checks/:checkID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "checkID", "value": "", "type": "path", "description": "The check ID." } ] }, "docs": "Retrieve a check" }, { "info": { "name": "Update a check", "type": "http" }, "http": { "method": "PUT", "url": "/api/v2/checks/:checkID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "checkID", "value": "", "type": "path", "description": "The check ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a check" }, { "info": { "name": "Update a check", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/checks/:checkID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "checkID", "value": "", "type": "path", "description": "The check ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a check" }, { "info": { "name": "Delete a check", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/checks/:checkID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "checkID", "value": "", "type": "path", "description": "The check ID." } ] }, "docs": "Delete a check" }, { "info": { "name": "List all labels for a check", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/checks/:checkID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "checkID", "value": "", "type": "path", "description": "The check ID." } ] }, "docs": "List all labels for a check" }, { "info": { "name": "Add a label to a check", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/checks/:checkID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "checkID", "value": "", "type": "path", "description": "The check ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a label to a check" }, { "info": { "name": "Delete label from a check", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/checks/:checkID/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "checkID", "value": "", "type": "path", "description": "The check ID." }, { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to delete." } ] }, "docs": "Delete label from a check" }, { "info": { "name": "Retrieve a check query", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/checks/:checkID/query", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "checkID", "value": "", "type": "path", "description": "The check ID." } ] }, "docs": "Retrieve a check query" } ] }, { "info": { "name": "Dashboards", "type": "folder" }, "items": [ { "info": { "name": "List dashboards", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/dashboards", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination.\nThe number of records to skip.\n\nFor more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).\n" }, { "name": "descending", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard) to return.\nDefault is `20`.\nThe minimum is `-1` and the maximum is `100`.\n" }, { "name": "owner", "value": "", "type": "query", "description": "A user ID. Only returns [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard) where the specified user has the `owner` role." }, { "name": "sortBy", "value": "", "type": "query", "description": "The column to sort by." }, { "name": "id", "value": "", "type": "query", "description": "A list of dashboard IDs.\nReturns only the specified [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard).\nIf you specify `id` and `owner`, only `id` is used.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nOnly returns [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard) that belong to the specified\n[organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).\n" }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\nOnly returns [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard) that belong to the specified\n[organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).\n" } ] }, "docs": "Lists [dashboards](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#dashboard).\n\n#### Related guides\n\n- [Manage dashboards](https://docs.influxdata.com/influxdb/cloud/visualize-data/dashboards/).\n" }, { "info": { "name": "Create a dashboard", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/dashboards", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a dashboard" }, { "info": { "name": "Retrieve a dashboard", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/dashboards/:dashboardID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The ID of the dashboard to update." }, { "name": "include", "value": "", "type": "query", "description": "If `properties`, includes the cell view properties in the response." } ] }, "docs": "Retrieve a dashboard" }, { "info": { "name": "Update a dashboard", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/dashboards/:dashboardID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The ID of the dashboard to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a dashboard" }, { "info": { "name": "Delete a dashboard", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/dashboards/:dashboardID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The ID of the dashboard to update." } ] }, "docs": "Delete a dashboard" }, { "info": { "name": "List all labels for a dashboard", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/dashboards/:dashboardID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." } ] }, "docs": "List all labels for a dashboard" }, { "info": { "name": "Add a label to a dashboard", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/dashboards/:dashboardID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a label to a dashboard" }, { "info": { "name": "Delete a label from a dashboard", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/dashboards/:dashboardID/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." }, { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to delete." } ] }, "docs": "Delete a label from a dashboard" }, { "info": { "name": "List all dashboard members", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/dashboards/:dashboardID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." } ] }, "docs": "List all dashboard members" }, { "info": { "name": "Add a member to a dashboard", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/dashboards/:dashboardID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a member to a dashboard" }, { "info": { "name": "Remove a member from a dashboard", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/dashboards/:dashboardID/members/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the member to remove." }, { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." } ] }, "docs": "Remove a member from a dashboard" }, { "info": { "name": "List all dashboard owners", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/dashboards/:dashboardID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." } ] }, "docs": "List all dashboard owners" }, { "info": { "name": "Add an owner to a dashboard", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/dashboards/:dashboardID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an owner to a dashboard" }, { "info": { "name": "Remove an owner from a dashboard", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/dashboards/:dashboardID/owners/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the owner to remove." }, { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." } ] }, "docs": "Remove an owner from a dashboard" } ] }, { "info": { "name": "Cells", "type": "folder" }, "items": [ { "info": { "name": "Create a dashboard cell", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/dashboards/:dashboardID/cells", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The ID of the dashboard to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a dashboard cell" }, { "info": { "name": "Replace cells in a dashboard", "type": "http" }, "http": { "method": "PUT", "url": "/api/v2/dashboards/:dashboardID/cells", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The ID of the dashboard to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells." }, { "info": { "name": "Update the non-positional information related to a cell", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/dashboards/:dashboardID/cells/:cellID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The ID of the dashboard to update." }, { "name": "cellID", "value": "", "type": "path", "description": "The ID of the cell to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts." }, { "info": { "name": "Delete a dashboard cell", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/dashboards/:dashboardID/cells/:cellID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The ID of the dashboard to delete." }, { "name": "cellID", "value": "", "type": "path", "description": "The ID of the cell to delete." } ] }, "docs": "Delete a dashboard cell" }, { "info": { "name": "Retrieve the view for a cell", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/dashboards/:dashboardID/cells/:cellID/view", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The dashboard ID." }, { "name": "cellID", "value": "", "type": "path", "description": "The cell ID." } ] }, "docs": "Retrieve the view for a cell" }, { "info": { "name": "Update the view for a cell", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/dashboards/:dashboardID/cells/:cellID/view", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "dashboardID", "value": "", "type": "path", "description": "The ID of the dashboard to update." }, { "name": "cellID", "value": "", "type": "path", "description": "The ID of the cell to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the view for a cell" } ] }, { "info": { "name": "DBRPs", "type": "folder" }, "items": [ { "info": { "name": "List database retention policy mappings", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/dbrps", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nOnly returns DBRP mappings for the specified organization.\n" }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\nOnly returns DBRP mappings for the specified organization.\n" }, { "name": "id", "value": "", "type": "query", "description": "A DBPR mapping ID.\nOnly returns the specified DBRP mapping.\n" }, { "name": "bucketID", "value": "", "type": "query", "description": "A bucket ID.\nOnly returns DBRP mappings that belong to the specified bucket.\n" }, { "name": "default", "value": "", "type": "query", "description": "Specifies filtering on default" }, { "name": "db", "value": "", "type": "query", "description": "A database.\nOnly returns DBRP mappings that belong to the 1.x database.\n" }, { "name": "rp", "value": "", "type": "query", "description": "A [retention policy](https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/#retention-policy-rp).\nSpecifies the 1.x retention policy to filter on.\n" } ] }, "docs": "Lists database retention policy (DBRP) mappings.\n\n#### Related guide\n\n- [Database and retention policy mapping](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/dbrp/)\n" }, { "info": { "name": "Add a database retention policy mapping", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/dbrps", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a database retention policy (DBRP) mapping and returns the mapping.\n\nUse this endpoint to add InfluxDB 1.x API compatibility to your\nInfluxDB Cloud or InfluxDB OSS 2.x buckets. Your buckets must contain a\nDBRP mapping in order to query and write using the InfluxDB 1.x API.\nobject.\n\n#### Related guide\n\n- [Database and retention policy mapping](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/dbrp/)\n" }, { "info": { "name": "Retrieve a database retention policy mapping", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/dbrps/:dbrpID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nSpecifies the organization that owns the DBRP mapping.\n" }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\nSpecifies the organization that owns the DBRP mapping.\n" }, { "name": "dbrpID", "value": "", "type": "path", "description": "A DBRP mapping ID.\nSpecifies the DBRP mapping.\n" } ] }, "docs": "Retrieves the specified retention policy (DBRP) mapping.\n\n#### Related guide\n\n- [Database and retention policy mapping](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/dbrp/)\n" }, { "info": { "name": "Update a database retention policy mapping", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/dbrps/:dbrpID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nSpecifies the organization that owns the DBRP mapping.\n" }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\nSpecifies the organization that owns the DBRP mapping.\n" }, { "name": "dbrpID", "value": "", "type": "path", "description": "A DBRP mapping ID.\nSpecifies the DBRP mapping.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a database retention policy mapping" }, { "info": { "name": "Delete a database retention policy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/dbrps/:dbrpID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nSpecifies the organization that owns the DBRP mapping.\n" }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\nSpecifies the organization that owns the DBRP mapping.\n" }, { "name": "dbrpID", "value": "", "type": "path", "description": "A DBRP mapping ID.\nOnly returns the specified DBRP mapping.\n" } ] }, "docs": "Deletes the specified database retention policy (DBRP) mapping.\n\n#### Related guide\n\n- [Database and retention policy mapping](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/dbrp/)\n" } ] }, { "info": { "name": "Data I/O endpoints", "type": "folder" }, "items": [ { "info": { "name": "Delete data", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/delete", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "org", "value": "", "type": "query", "description": "An organization name or ID.\n\n#### InfluxDB Cloud\n\n- Doesn't use the `org` parameter or `orgID` parameter.\n- Deletes data from the bucket in the organization\n associated with the authorization (API token).\n\n#### InfluxDB OSS\n\n- Requires either the `org` parameter or the `orgID` parameter.\n- Deletes data from the bucket in the specified organization.\n- If you pass both `orgID` and `org`, they must both be valid.\n" }, { "name": "bucket", "value": "", "type": "query", "description": "A bucket name or ID.\nSpecifies the bucket to delete data from.\nIf you pass both `bucket` and `bucketID`, `bucketID` takes precedence.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\n\n#### InfluxDB Cloud\n\n- Doesn't use the `org` parameter or `orgID` parameter.\n- Deletes data from the bucket in the organization\n associated with the authorization (API token).\n\n#### InfluxDB OSS\n\n- Requires either the `org` parameter or the `orgID` parameter.\n- Deletes data from the bucket in the specified organization.\n- If you pass both `orgID` and `org`, they must both be valid.\n" }, { "name": "bucketID", "value": "", "type": "query", "description": "A bucket ID.\nSpecifies the bucket to delete data from.\nIf you pass both `bucket` and `bucketID`, `bucketID` takes precedence.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes data from a bucket.\n\nUse this endpoint to delete points from a bucket in a specified time range.\n\n#### InfluxDB Cloud\n\n- Does the following when you send a delete request:\n\n 1. Validates the request and queues the delete.\n 2. If queued, responds with _success_ (HTTP `2xx` status code); _error_ otherwise.\n 3. Handles the delete asynchronously and reaches eventual consistency.\n\nTo ensure that InfluxDB Cloud handles writes and deletes in the order you request them,\nwait for a success res" }, { "info": { "name": "Query data", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/query", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "org", "value": "", "type": "query", "description": "An organization name or ID.\n\n#### InfluxDB Cloud\n\n- Doesn't use the `org` parameter or `orgID` parameter.\n- Queries the bucket in the organization associated with the authorization (API token).\n\n#### InfluxDB OSS\n\n- Requires either the `org` parameter or `orgID` parameter.\n- Queries the bucket in the specified organization.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\n\n#### InfluxDB Cloud\n\n- Doesn't use the `org` parameter or `orgID` parameter.\n- Queries the bucket in the organization associated with the authorization (API token).\n\n#### InfluxDB OSS\n\n- Requires either the `org` parameter or `orgID` parameter.\n- Queries the bucket in the specified organization.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves data from buckets.\n\nUse this endpoint to send a Flux query request and retrieve data from a bucket.\n\n#### Rate limits (with InfluxDB Cloud)\n\n`read` rate limits apply.\nFor more information, see [limits and adjustable quotas](https://docs.influxdata.com/influxdb/cloud/account-management/limits/).\n\n#### Related guides\n\n- [Query with the InfluxDB API](https://docs.influxdata.com/influxdb/cloud/query-data/execute-queries/influx-api/)\n- [Get started with Flux](https://docs.influxdata.com/flu" }, { "info": { "name": "List scripts", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/scripts", "params": [ { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination.\nThe number of records to skip.\n\nFor more information about pagination parameters, see [Pagination]({{% INFLUXDB_DOCS_URL %}}/api/#tag/Pagination).\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of scripts to return. Default is `100`.\n" }, { "name": "name", "value": "", "type": "query", "description": "The script name. Lists scripts with the specified name." } ] }, "docs": "Lists [scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/).\n\n#### Related guides\n\n- [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/)\n" }, { "info": { "name": "Retrieve a script", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/scripts/:scriptID", "params": [ { "name": "scriptID", "value": "", "type": "path", "description": "A script ID.\nRetrieves the specified script.\n" } ] }, "docs": "Retrieves a [script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/).\n\n#### Related Guides\n\n- [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/)\n" }, { "info": { "name": "Invoke a script", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/scripts/:scriptID/invoke", "params": [ { "name": "scriptID", "value": "", "type": "path", "description": "A script ID.\nRuns the specified script.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Runs a script and returns the result.\nWhen the script runs, InfluxDB replaces `params` keys referenced in the script with\n`params` key-values passed in the request body--for example:\n\nThe following sample script contains a _`mybucket`_ parameter :\n\n```json\n\"script\": \"from(bucket: params.mybucket)\n |> range(start: -7d)\n |> limit(n:1)\"\n```\n\nThe following example `POST /api/v2/scripts/SCRIPT_ID/invoke` request body\npasses a value for the _`mybucket`_ parameter:\n\n```json\n{\n \"p" }, { "info": { "name": "List all tasks", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "name", "value": "", "type": "query", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) name.\nOnly returns tasks with the specified name.\nDifferent tasks may have the same name.\n" }, { "name": "after", "value": "", "type": "query", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) ID.\nOnly returns tasks created after the specified task.\n" }, { "name": "user", "value": "", "type": "query", "description": "A [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) ID.\nOnly returns tasks owned by the specified user.\n" }, { "name": "org", "value": "", "type": "query", "description": "An [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization) name.\nOnly returns tasks owned by the specified organization.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization) ID.\nOnly returns tasks owned by the specified organization.\n" }, { "name": "status", "value": "", "type": "query", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) status.\nOnly returns tasks that have the specified status (`active` or `inactive`).\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of [tasks](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) to return.\nDefault is `100`.\nThe minimum is `1` and the maximum is `500`.\n\nTo reduce the payload size, combine _`type=basic`_ and _`limit`_ (see _Request samples_).\nFor more information about the `basic` response, see the _`type`_ parameter.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The number of records to skip." }, { "name": "sortBy", "value": "", "type": "query", "description": "The sort field. Only `name` is supported.\nSpecifies the field used to sort records in the list.\n" }, { "name": "type", "value": "", "type": "query", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) type (`basic` or `system`).\nDefault is `system`.\nSpecifies the level of detail for tasks in the response.\nThe default (`system`) response contains all the metadata properties for tasks.\nTo reduce the response size, pass `basic` to omit some task properties (`flux`, `createdAt`, `updatedAt`).\n" }, { "name": "scriptID", "value": "", "type": "query", "description": "A [script](#tag/Invokable-Scripts) ID.\nOnly returns tasks that use the specified invokable script.\n" } ] }, "docs": "Retrieves a list of [tasks](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task).\n\nTo limit which tasks are returned, pass query parameters in your request.\nIf no query parameters are passed, InfluxDB returns all tasks up to the default `limit`.\n" }, { "info": { "name": "Create a task", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/tasks", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) and returns the task.\n\nUse this endpoint to create a scheduled task that runs a Flux script.\n\n#### InfluxDB Cloud\n\n- You can use either `flux` or `scriptID` to provide the task script.\n\n - `flux`: a string of \"raw\" Flux that contains task options and the script--for example:\n\n ```json\n {\n \"flux\": \"option task = {name: \\\"CPU Total 1 Hour New\\\", every: 1h}\\\n from(bucket: \\\"telegraf\\\")\n |> " }, { "info": { "name": "Retrieve a task", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks/:taskID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) ID.\nSpecifies the task to retrieve.\n" } ] }, "docs": "Retrieves a [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task).\n" }, { "info": { "name": "Start a task run, overriding the schedule", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/tasks/:taskID/runs", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedules a task run to start immediately, ignoring scheduled runs.\n\nUse this endpoint to manually start a task run.\nScheduled runs will continue to run as scheduled.\nThis may result in concurrently running tasks.\n\nTo _retry_ a previous run (and avoid creating a new run),\nuse the [`POST /api/v2/tasks/{taskID}/runs/{runID}/retry` endpoint](#operation/PostTasksIDRunsIDRetry).\n" }, { "info": { "name": "Write data", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/write", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" }, { "name": "Content-Encoding", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "Content-Length", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "org", "value": "", "type": "query", "description": "An organization name or ID.\n\n#### InfluxDB Cloud\n\n- Doesn't use the `org` parameter or `orgID` parameter.\n- Writes data to the bucket in the organization\n associated with the authorization (API token).\n\n#### InfluxDB OSS\n\n- Requires either the `org` parameter or the `orgID` parameter.\n- If you pass both `orgID` and `org`, they must both be valid.\n- Writes data to the bucket in the specified organization.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\n\n#### InfluxDB Cloud\n\n- Doesn't use the `org` parameter or `orgID` parameter.\n- Writes data to the bucket in the organization\n associated with the authorization (API token).\n\n#### InfluxDB OSS\n\n- Requires either the `org` parameter or the `orgID` parameter.\n- If you pass both `orgID` and `org`, they must both be valid.\n- Writes data to the bucket in the specified organization.\n" }, { "name": "bucket", "value": "", "type": "query", "description": "A bucket name or ID.\nInfluxDB writes all points in the batch to the specified bucket.\n" }, { "name": "precision", "value": "", "type": "query", "description": "The precision for unix timestamps in the line protocol batch." } ] }, "docs": "Writes data to a bucket.\n\nUse this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol/) format to InfluxDB.\n\n#### InfluxDB Cloud\n\n- Does the following when you send a write request:\n\n 1. Validates the request and queues the write.\n 2. If queued, responds with _success_ (HTTP `2xx` status code); _error_ otherwise.\n 3. Handles the delete asynchronously and reaches eventual consistency.\n\n To ensure that InfluxDB Cloud handles write" } ] }, { "info": { "name": "Config", "type": "folder" }, "items": [ { "info": { "name": "Retrieve feature flags", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/flags", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ] }, "docs": "Retrieves the feature flag key-value pairs configured for the InfluxDB\ninstance.\n_Feature flags_ are configuration options used to develop and test\nexperimental InfluxDB features and are intended for internal use only.\n\nThis endpoint represents the first step in the following three-step process\nto configure feature flags:\n\n1. Use [token authentication](#section/Authentication/TokenAuthentication) or a [user session](#tag/Signin) with this endpoint to retrieve\n feature flags and their values.\n2" } ] }, { "info": { "name": "Labels", "type": "folder" }, "items": [ { "info": { "name": "List all labels", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "query", "description": "The organization ID." } ] }, "docs": "List all labels" }, { "info": { "name": "Create a label", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/labels", "body": { "type": "json", "data": "{}" } }, "docs": "Create a label" }, { "info": { "name": "Retrieve a label", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to update." } ] }, "docs": "Retrieve a label" }, { "info": { "name": "Update a label", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a label" }, { "info": { "name": "Delete a label", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to delete." } ] }, "docs": "Delete a label" } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "Get a mapbox token", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/maps/mapToken" }, "docs": "Get a mapbox token" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the currently authenticated user", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/me", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ] }, "docs": "Retrieve the currently authenticated user" }, { "info": { "name": "Update a password", "type": "http" }, "http": { "method": "PUT", "url": "/api/v2/me/password", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates the password for the signed-in [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n\nThis endpoint represents the third step in the following three-step process to let a\nuser with a user session update their password:\n 1. Pass the user's [Basic authentication credentials](#section/Authentication/BasicAuthentication) to the `POST /api/v2/signin`\n endpoint to create a user session and generate a session cookie.\n 2. From the response in the first step, extract " }, { "info": { "name": "Create a user", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/users", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "(InfluxData internal use only)\n\nCreates and returns a [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user)\nthat can access InfluxDB.\n\n#### InfluxDB Cloud\n\n- InfluxDB Cloud Doesn't let you manage users through the API.\n Use the InfluxDB Cloud user interface (UI) to manage account information.\n\n#### Required permissions for InfluxDB Cloud\n\n| Action | Permission required | Restriction |\n|:-------|:--------------------|:------------|\n| Create user | Operator token | InfluxDat" }, { "info": { "name": "Retrieve a user", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/users/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "A user ID.\nRetrieves the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n" } ] }, "docs": "Retrieves a [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n\n#### Related guides\n\n- [Manage users](https://docs.influxdata.com/influxdb/cloud/organizations/users/)\n" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/users/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "A user ID.\nUpdates the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "(InfluxData internal use only)\n\nUpdates a [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) and returns the user.\n\n#### InfluxDB Cloud\n\n- Doesn't let you manage users through the API.\n Use the InfluxDB Cloud user interface (UI) to manage account information.\n\n#### Required permissions for InfluxDB Cloud\n\n| Action | Permission required | Restriction |\n|:-------|:--------------------|:------------|\n| Update user | Operator token | InfluxData internal use only |\n\n#### Rel" }, { "info": { "name": "Delete a user", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/users/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "A user ID.\nDeletes the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n" } ] }, "docs": "(InfluxData internal use only)\n\nDeletes a [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n\nFor security purposes, once an InfluxDB user account is deleted from an\norganization, the user (and their token) cannot be reactivated.\n\n#### InfluxDB Cloud\n\n- Doesn't let you manage users through the API.\n Use the InfluxDB Cloud user interface (UI) to manage account information.\n\n#### Required permissions\n\n| Action | Permission required | Restriction |\n|:-------|:------------" } ] }, { "info": { "name": "NotificationEndpoints", "type": "folder" }, "items": [ { "info": { "name": "List all notification endpoints", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/notificationEndpoints", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination.\nThe number of records to skip.\n\nFor more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limits the number of records returned. Default is `20`.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "Only show notification endpoints that belong to specific organization ID." } ] }, "docs": "List all notification endpoints" }, { "info": { "name": "Add a notification endpoint", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/notificationEndpoints", "body": { "type": "json", "data": "{}" } }, "docs": "Add a notification endpoint" }, { "info": { "name": "Retrieve a notification endpoint", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/notificationEndpoints/:endpointID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "endpointID", "value": "", "type": "path", "description": "The notification endpoint ID." } ] }, "docs": "Retrieve a notification endpoint" }, { "info": { "name": "Update a notification endpoint", "type": "http" }, "http": { "method": "PUT", "url": "/api/v2/notificationEndpoints/:endpointID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "endpointID", "value": "", "type": "path", "description": "The notification endpoint ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a notification endpoint" }, { "info": { "name": "Update a notification endpoint", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/notificationEndpoints/:endpointID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "endpointID", "value": "", "type": "path", "description": "The notification endpoint ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a notification endpoint" }, { "info": { "name": "Delete a notification endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/notificationEndpoints/:endpointID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "endpointID", "value": "", "type": "path", "description": "The notification endpoint ID." } ] }, "docs": "Delete a notification endpoint" }, { "info": { "name": "List all labels for a notification endpoint", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/notificationEndpoints/:endpointID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "endpointID", "value": "", "type": "path", "description": "The notification endpoint ID." } ] }, "docs": "List all labels for a notification endpoint" }, { "info": { "name": "Add a label to a notification endpoint", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/notificationEndpoints/:endpointID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "endpointID", "value": "", "type": "path", "description": "The notification endpoint ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a label to a notification endpoint" }, { "info": { "name": "Delete a label from a notification endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/notificationEndpoints/:endpointID/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "endpointID", "value": "", "type": "path", "description": "The notification endpoint ID." }, { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to delete." } ] }, "docs": "Delete a label from a notification endpoint" } ] }, { "info": { "name": "NotificationRules", "type": "folder" }, "items": [ { "info": { "name": "List all notification rules", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/notificationRules", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination.\nThe number of records to skip.\n\nFor more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limits the number of records returned. Default is `20`.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "Only show notification rules that belong to a specific organization ID." }, { "name": "checkID", "value": "", "type": "query", "description": "Only show notifications that belong to the specific check ID." }, { "name": "tag", "value": "", "type": "query", "description": "Only return notification rules that \"would match\" statuses which contain the tag key value pairs provided." } ] }, "docs": "List all notification rules" }, { "info": { "name": "Add a notification rule", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/notificationRules", "body": { "type": "json", "data": "{}" } }, "docs": "Add a notification rule" }, { "info": { "name": "Retrieve a notification rule", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/notificationRules/:ruleID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "ruleID", "value": "", "type": "path", "description": "The notification rule ID." } ] }, "docs": "Retrieve a notification rule" }, { "info": { "name": "Update a notification rule", "type": "http" }, "http": { "method": "PUT", "url": "/api/v2/notificationRules/:ruleID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "ruleID", "value": "", "type": "path", "description": "The notification rule ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a notification rule" }, { "info": { "name": "Update a notification rule", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/notificationRules/:ruleID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "ruleID", "value": "", "type": "path", "description": "The notification rule ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a notification rule" }, { "info": { "name": "Delete a notification rule", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/notificationRules/:ruleID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "ruleID", "value": "", "type": "path", "description": "The notification rule ID." } ] }, "docs": "Delete a notification rule" }, { "info": { "name": "List all labels for a notification rule", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/notificationRules/:ruleID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "ruleID", "value": "", "type": "path", "description": "The notification rule ID." } ] }, "docs": "List all labels for a notification rule" }, { "info": { "name": "Add a label to a notification rule", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/notificationRules/:ruleID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "ruleID", "value": "", "type": "path", "description": "The notification rule ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a label to a notification rule" }, { "info": { "name": "Delete label from a notification rule", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/notificationRules/:ruleID/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "ruleID", "value": "", "type": "path", "description": "The notification rule ID." }, { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to delete." } ] }, "docs": "Delete label from a notification rule" } ] }, { "info": { "name": "Rules", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a notification rule query", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/notificationRules/:ruleID/query", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "ruleID", "value": "", "type": "path", "description": "The notification rule ID." } ] }, "docs": "Retrieve a notification rule query" } ] }, { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "List organizations", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/orgs", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "offset", "value": "", "type": "query", "description": "The offset for pagination.\nThe number of records to skip.\n\nFor more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/cloud/api/#tag/Pagination).\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limits the number of records returned. Default is `20`.\n" }, { "name": "descending", "value": "", "type": "query" }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\nOnly returns the specified organization.\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nOnly returns the specified organization.\n" }, { "name": "userID", "value": "", "type": "query", "description": "A user ID.\nOnly returns organizations where the specified user is a member or owner.\n" } ] }, "docs": "Lists [organizations](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization/).\n\nTo limit which organizations are returned, pass query parameters in your request.\nIf no query parameters are passed, InfluxDB returns all organizations up to the default `limit`.\n\n#### InfluxDB Cloud\n\n- Only returns the organization that owns the token passed in the request.\n\n#### Related guides\n\n- [View organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/)\n" }, { "info": { "name": "Create an organization", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/orgs", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization)\nand returns the newly created organization.\n\n#### InfluxDB Cloud\n\n- Doesn't allow you to use this endpoint to create organizations.\n\n#### Related guides\n\n- [Manage organizations](https://docs.influxdata.com/influxdb/cloud/organizations)\n" }, { "info": { "name": "Retrieve an organization", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/orgs/:orgID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization to retrieve.\n" } ] }, "docs": "Retrieves an organization.\n\nUse this endpoint to retrieve information for a specific organization.\n\n#### Related guides\n\n- [View organizations](https://docs.influxdata.com/influxdb/cloud/organizations/view-orgs/)\n" }, { "info": { "name": "Update an organization", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/orgs/:orgID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization to update.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an organization.\n\nUse this endpoint to update properties\n(`name`, `description`) of an organization.\n\nUpdating an organization’s name affects all resources that reference the\norganization by name, including the following:\n\n- Queries\n- Dashboards\n- Tasks\n- Telegraf configurations\n- Templates\n\nIf you change an organization name, be sure to update the organization name\nin these resources as well.\n\n#### Related Guides\n\n- [Update an organization](https://docs.influxdata.com/influxdb/cloud/org" }, { "info": { "name": "Delete an organization", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/orgs/:orgID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization to delete.\n" } ] }, "docs": "Deletes an organization.\n\nDeleting an organization from InfluxDB Cloud can't be undone.\nOnce deleted, all data associated with the organization is removed.\n\n#### InfluxDB Cloud\n\n- Does the following when you send a delete request:\n\n 1. Validates the request and queues the delete.\n 2. Returns an HTTP `204` status code if queued; _error_ otherwise.\n 3. Handles the delete asynchronously.\n\n#### InfluxDB OSS\n\n- Validates the request, handles the delete synchronously,\nand then responds with success" }, { "info": { "name": "List all members of an organization", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/orgs/:orgID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization to retrieve users for.\n" } ] }, "docs": "Lists all users that belong to an organization.\n\nInfluxDB [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) have\npermission to access InfluxDB.\n\n[Members](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#member) are users\nwithin the organization.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Member permissions are separate " }, { "info": { "name": "Add a member to an organization", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/orgs/:orgID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user to an organization.\n\nInfluxDB [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user) have\npermission to access InfluxDB.\n\n[Members](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#member) are users\nwithin the organization.\n\n#### InfluxDB Cloud\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Member permissions are separate from API token per" }, { "info": { "name": "Remove a member from an organization", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/orgs/:orgID/members/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the user to remove." }, { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization to remove a user from." } ] }, "docs": "Removes a member from an organization.\n\nUse this endpoint to remove a user's member privileges for an organization.\nRemoving member privileges removes the user's `read` and `write` permissions\nfrom the organization.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Member permissions are separate from API token permissions.\n- Member permissions are used in the context" }, { "info": { "name": "List all owners of an organization", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/orgs/:orgID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization to list owners for.\n" } ] }, "docs": "Lists all owners of an organization.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Required permissions\n\n- `read-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organization that you want to retrieve a\nlist of owners from.\n" }, { "info": { "name": "Add an owner to an organization", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/orgs/:orgID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization that you want to add an owner for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an owner to an organization.\n\nUse this endpoint to assign the organization `owner` role to a user.\n\n#### InfluxDB Cloud\n\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Required permissions\n\n- `write-orgs INFLUX_ORG_ID`\n\n*`INFLUX_ORG_ID`* is the ID of the organization that you want to add an owner for.\n\n#### Related endpoints\n\n- [Authorizations](#tag/Authorizations-(API-tokens))\n" }, { "info": { "name": "Remove an owner from an organization", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/orgs/:orgID/owners/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the user to remove." }, { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization to remove an owner from.\n" } ] }, "docs": "Removes an [owner](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#owner) from\nthe organization.\n\nOrganization owners have permission to delete organizations and remove user and member\npermissions from the organization.\n\n#### InfluxDB Cloud\n- Doesn't use `owner` and `member` roles.\n Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\n#### Limitations\n\n- Owner permissions are separate from API token permissions.\n- Owner permissions are use" } ] }, { "info": { "name": "Limits", "type": "folder" }, "items": [ { "info": { "name": "Retrieve limits for an organization", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/orgs/:orgID/limits", "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization." } ] }, "docs": "Retrieve limits for an organization" } ] }, { "info": { "name": "Secrets", "type": "folder" }, "items": [ { "info": { "name": "List all secret keys for an organization", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/orgs/:orgID/secrets", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The organization ID." } ] }, "docs": "List all secret keys for an organization" }, { "info": { "name": "Update secrets in an organization", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/orgs/:orgID/secrets", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The organization ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update secrets in an organization" }, { "info": { "name": "Delete a secret from an organization", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/orgs/:orgID/secrets/:secretID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The organization ID." }, { "name": "secretID", "value": "", "type": "path", "description": "The secret ID." } ] }, "docs": "Delete a secret from an organization" }, { "info": { "name": "Delete secrets from an organization", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/orgs/:orgID/secrets/delete", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The organization ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete secrets from an organization" } ] }, { "info": { "name": "Usage", "type": "folder" }, "items": [ { "info": { "name": "Retrieve usage for an organization", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/orgs/:orgID/usage", "params": [ { "name": "orgID", "value": "", "type": "path", "description": "The ID of the organization." }, { "name": "start", "value": "", "type": "query", "description": "Earliest time to include in results.\nFor more information about timestamps, see [Manipulate timestamps with Flux](https://docs.influxdata.com/influxdb/cloud/query-data/flux/manipulate-timestamps/).\n" }, { "name": "stop", "value": "", "type": "query", "description": "Latest time to include in results.\nFor more information about timestamps, see [Manipulate timestamps with Flux](https://docs.influxdata.com/influxdb/cloud/query-data/flux/manipulate-timestamps/).\n" }, { "name": "raw", "value": "", "type": "query", "description": "return raw usage data" } ] }, "docs": "Retrieve usage for an organization" } ] }, { "info": { "name": "Ping", "type": "folder" }, "items": [ { "info": { "name": "Get the status of the instance", "type": "http" }, "http": { "method": "GET", "url": "/ping" }, "docs": "Retrieves the status and InfluxDB version of the instance.\n\nUse this endpoint to monitor uptime for the InfluxDB instance. The response\nreturns a HTTP `204` status code to inform you the instance is available.\n\n#### InfluxDB Cloud\n\n- Isn't versioned and doesn't return `X-Influxdb-Version` in the headers.\n\n#### Related guides\n\n- [Influx ping](https://docs.influxdata.com/influxdb/cloud/reference/cli/influx/ping/)\n" }, { "info": { "name": "Get the status of the instance", "type": "http" }, "http": { "method": "HEAD", "url": "/ping" }, "docs": "Returns the status and InfluxDB version of the instance.\n\nUse this endpoint to monitor uptime for the InfluxDB instance. The response\nreturns a HTTP `204` status code to inform you the instance is available.\n\n#### InfluxDB Cloud\n\n- Isn't versioned and doesn't return `X-Influxdb-Version` in the headers.\n\n#### Related guides\n\n- [Influx ping](https://docs.influxdata.com/influxdb/cloud/reference/cli/influx/ping/)\n" } ] }, { "info": { "name": "Query", "type": "folder" }, "items": [ { "info": { "name": "Analyze a Flux query", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/query/analyze", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Analyzes a [Flux query](https://docs.influxdata.com/flux/v0.x/) for syntax\nerrors and returns the list of errors.\n\nIn the following sample query, `from()` is missing the property key.\n\n ```json\n { \"query\": \"from(: \\\"iot_center\\\")\\\n |> range(start: -90d)\\\n |> filter(fn: (r) => r._measurement == \\\"environment\\\")\",\n \"type\": \"flux\"\n }\n ```\n\nIf you pass this in a request to the `/api/v2/analyze` endpoint,\nInfluxDB returns an `errors` list that contains a" }, { "info": { "name": "Generate a query Abstract Syntax Tree (AST)", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/query/ast", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Analyzes a Flux query and returns a complete package source [Abstract Syntax\nTree (AST)](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#abstract-syntax-tree-ast)\nfor the query.\n\nUse this endpoint for deep query analysis such as debugging unexpected query\nresults.\n\nA Flux query AST provides a semantic, tree-like representation with contextual\ninformation about the query. The AST illustrates how the query is distributed\ninto different components for execution.\n\n#### Limitations\n\n- " }, { "info": { "name": "List Flux query suggestions", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/query/suggestions", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ] }, "docs": "Lists Flux query suggestions. Each suggestion contains a\n[Flux function](https://docs.influxdata.com/flux/v0.x/stdlib/all-functions/)\nname and parameters.\n\nUse this endpoint to retrieve a list of Flux query suggestions used in the\nInfluxDB Flux Query Builder.\n\n#### Limitations\n\n- When writing a query, avoid using `_functionName()` helper functions\nexposed by this endpoint. Helper function names have an underscore (`_`)\nprefix and aren't meant to be used directly in queries--for example:\n\n - To" }, { "info": { "name": "Retrieve a query suggestion for a branching suggestion", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/query/suggestions/:name", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "A [Flux function](https://docs.influxdata.com/flux/v0.x/stdlib/all-functions/) name.\n" } ] }, "docs": "Retrieves a query suggestion that contains the name and parameters of the\nrequested function.\n\nUse this endpoint to pass a branching suggestion (a Flux function name) and\nretrieve the parameters of the requested function.\n\n#### Limitations\n\n- Use `/api/v2/query/suggestions/{name}` (without a trailing slash).\n`/api/v2/query/suggestions/{name}/` (note the trailing slash) results in a\nHTTP `301 Moved Permanently` status.\n\n- The function `name` must exist and must be spelled correctly.\n\n#### Related" } ] }, { "info": { "name": "Resources", "type": "folder" }, "items": [ { "info": { "name": "List all known resources", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/resources", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ] }, "docs": "List all known resources" } ] }, { "info": { "name": "Invokable Scripts", "type": "folder" }, "items": [ { "info": { "name": "Create a script", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/scripts", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an [invokable script](https://docs.influxdata.com/resources/videos/api-invokable-scripts/)\nand returns the script.\n\n#### Related guides\n\n- [Invokable scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/)\n- [Creating custom InfluxDB endpoints](https://docs.influxdata.com/resources/videos/api-invokable-scripts/)\n" }, { "info": { "name": "Update a script", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/scripts/:scriptID", "params": [ { "name": "scriptID", "value": "", "type": "path", "description": "A script ID.\nUpdates the specified script.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an invokable script.\n\nUse this endpoint to modify values for script properties (`description` and `script`).\n\nTo update a script, pass an object that contains the updated key-value pairs.\n\n#### Limitations\n\n- If you send an empty request body, the script will neither update nor\nstore an empty script, but InfluxDB will respond with an HTTP `200` status\ncode.\n\n#### Related Guides\n\n- [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/)\n" }, { "info": { "name": "Delete a script", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/scripts/:scriptID", "params": [ { "name": "scriptID", "value": "", "type": "path", "description": "A script ID.\nDeletes the specified script.\n" } ] }, "docs": "Deletes a [script](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/) and all associated records.\n\n#### Limitations\n\n- You can delete only one script per request.\n- If the script ID you provide doesn't exist for the organization, InfluxDB\nresponds with an HTTP `204` status code.\n\n#### Related Guides\n\n- [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invokable-scripts/)\n" }, { "info": { "name": "Find script parameters.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/scripts/:scriptID/params", "params": [ { "name": "scriptID", "value": "", "type": "path", "description": "A script ID.\nThe script to analyze for params.\n" } ] }, "docs": "Analyzes a script and determines required parameters.\nFind all `params` keys referenced in a script and return a list\nof keys. If it is possible to determine the type of the value\nfrom the context then the type is also returned -- for example:\n\nThe following sample script contains a _`mybucket`_ parameter :\n\n```json\n\"script\": \"from(bucket: params.mybucket)\n |> range(start: -7d)\n |> limit(n:1)\"\n```\n\nRequesting the parameters using `GET /api/v2/scripts/SCRIPT_ID/params`\nretur" } ] }, { "info": { "name": "Setup", "type": "folder" }, "items": [ { "info": { "name": "Retrieve setup status", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/setup", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ] }, "docs": "Check if setup is allowed. Returns `true` if no default user, organization, or bucket have been created." }, { "info": { "name": "Create an initial user, organization, and bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/setup", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Post an onboarding request to create an initial user, organization, and bucket." }, { "info": { "name": "Create a new user, organization, and bucket", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/setup/user", "body": { "type": "json", "data": "{}" } }, "docs": "Post an onboarding request to create a new user, organization, and bucket." } ] }, { "info": { "name": "Security and access endpoints", "type": "folder" }, "items": [ { "info": { "name": "Create a user session.", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/signin", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Authenticates [Basic authentication credentials](#section/Authentication/BasicAuthentication)\nfor a [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user),\nand then, if successful, generates a user session.\n\nTo authenticate a user, pass the HTTP `Authorization` header with the\n`Basic` scheme and the base64-encoded username and password.\nFor syntax and more information, see [Basic Authentication](#section/Authentication/BasicAuthentication) for\nsyntax and more information.\n\nI" }, { "info": { "name": "Expire a user session", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/signout", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ] }, "docs": "Expires a user session specified by a session cookie.\n\nUse this endpoint to expire a user session that was generated when the user\nauthenticated with the InfluxDB Developer Console (UI) or the `POST /api/v2/signin` endpoint.\n\nFor example, the `POST /api/v2/signout` endpoint represents the third step\nin the following three-step process\nto authenticate a user, retrieve the `user` resource, and then expire the session:\n\n1. Send a request with the user's [Basic authentication credentials](#section/A" }, { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/users", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "name", "value": "", "type": "query", "description": "A user name.\nOnly lists the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n" }, { "name": "id", "value": "", "type": "query", "description": "A user id.\nOnly lists the specified [user](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n" } ] }, "docs": "Lists [users](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#user).\n\nTo limit which users are returned, pass query parameters in your request.\n\n#### InfluxDB Cloud\n\n- InfluxDB Cloud doesn't allow listing all users through the API.\n Use the InfluxDB Cloud user interface (UI) to manage account information.\n\n#### Required permissions for InfluxDB Cloud\n\n| Action | Permission required | Restriction |\n|:-------|:--------------------|:------------|\n| List all users | Operator token | " }, { "info": { "name": "Update a password", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/users/:userID/password", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the user to set the password for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user password.\n\n#### InfluxDB Cloud\n\n- Doesn't allow you to manage user passwords through the API.\n Use the InfluxDB Cloud user interface (UI) to update a password.\n\n#### Related guides\n\n- [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/)\n- [InfluxDB OSS - Change your password](https://docs.influxdata.com/influxdb/latest/users/change-password/)\n" }, { "info": { "name": "Update a password", "type": "http" }, "http": { "method": "PUT", "url": "/api/v2/users/:userID/password", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the user to set the password for." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates a user password.\n\nUse this endpoint to let a user authenticate with\n[Basic authentication credentials](#section/Authentication/BasicAuthentication)\nand set a new password.\n\n#### InfluxDB Cloud\n\n- Doesn't allow you to manage user passwords through the API.\n Use the InfluxDB Cloud user interface (UI) to update a password.\n\n#### Related guides\n\n- [InfluxDB Cloud - Change your password](https://docs.influxdata.com/influxdb/cloud/account-management/change-password/)\n- [InfluxDB OSS - Change " } ] }, { "info": { "name": "Templates", "type": "folder" }, "items": [ { "info": { "name": "List installed stacks", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/stacks", "params": [ { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nOnly returns stacks owned by the specified [organization](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#organization).\n\n#### InfluxDB Cloud\n\n- Doesn't require this parameter;\n InfluxDB only returns resources allowed by the API token.\n" }, { "name": "name", "value": "", "type": "query", "description": "A stack name.\nFinds stack `events` with this name and returns the stacks.\n\nRepeatable.\nTo filter for more than one stack name,\nrepeat this parameter with each name--for example:\n\n- `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1`\n" }, { "name": "stackID", "value": "", "type": "query", "description": "A stack ID.\nOnly returns the specified stack.\n\nRepeatable.\nTo filter for more than one stack ID,\nrepeat this parameter with each ID--for example:\n\n- `INFLUX_URL/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000`\n" } ] }, "docs": "Lists installed InfluxDB stacks.\n\nTo limit stacks in the response, pass query parameters in your request.\nIf no query parameters are passed, InfluxDB returns all installed stacks\nfor the organization.\n\n#### Related guides\n\n- [View InfluxDB stacks](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/).\n" }, { "info": { "name": "Create a stack", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/stacks", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or initializes a stack.\n\nUse this endpoint to _manually_ initialize a new stack with the following\noptional information:\n\n - Stack name\n - Stack description\n - URLs for template manifest files\n\nTo automatically create a stack when applying templates,\nuse the [/api/v2/templates/apply endpoint](#operation/ApplyTemplate).\n\n#### Required permissions\n\n- `write` permission for the organization\n\n#### Related guides\n\n- [Initialize an InfluxDB stack](https://docs.influxdata.com/influxdb/cloud/" }, { "info": { "name": "Retrieve a stack", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/stacks/:stack_id", "params": [ { "name": "stack_id", "value": "", "type": "path", "description": "The identifier of the stack." } ] }, "docs": "Retrieve a stack" }, { "info": { "name": "Update a stack", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/stacks/:stack_id", "params": [ { "name": "stack_id", "value": "", "type": "path", "description": "The identifier of the stack." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a stack" }, { "info": { "name": "Delete a stack and associated resources", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/stacks/:stack_id", "params": [ { "name": "stack_id", "value": "", "type": "path", "description": "The identifier of the stack." }, { "name": "orgID", "value": "", "type": "query", "description": "The identifier of the organization." } ] }, "docs": "Delete a stack and associated resources" }, { "info": { "name": "Uninstall a stack", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/stacks/:stack_id/uninstall", "params": [ { "name": "stack_id", "value": "", "type": "path", "description": "The identifier of the stack." } ] }, "docs": "Uninstall a stack" }, { "info": { "name": "Apply or dry-run a template", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/templates/apply", "body": { "type": "json", "data": "{}" } }, "docs": "Applies a template to\ncreate or update a [stack](https://docs.influxdata.com/influxdb/cloud/influxdb-templates/stacks/) of InfluxDB\n[resources](https://docs.influxdata.com/influxdb/cloud/reference/cli/influx/export/all/#resources).\nThe response contains the diff of changes and the stack ID.\n\nUse this endpoint to install an InfluxDB template to an organization.\nProvide template URLs or template objects in your request.\nTo customize which template resources are installed, use the `actions`\nparamet" }, { "info": { "name": "Export a new template", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/templates/export", "body": { "type": "json", "data": "{}" } }, "docs": "Export a new template" } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "Update a task", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/tasks/:taskID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) ID.\nSpecifies the task to update.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task),\nand then cancels all scheduled runs of the task.\n\nUse this endpoint to set, modify, or clear task properties--for example: `cron`, `name`, `flux`, `status`.\nOnce InfluxDB applies the update, it cancels all previously scheduled runs of the task.\n\nTo update a task, pass an object that contains the updated key-value pairs.\nTo activate or inactivate a task, set the `status` property.\n_`\"status\": \"inactive\"`_ cance" }, { "info": { "name": "Delete a task", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/tasks/:taskID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) ID. Specifies the task to delete." } ] }, "docs": "Deletes a [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) and associated records.\n\nUse this endpoint to delete a task and all associated records (task runs, logs, and labels).\nOnce the task is deleted, InfluxDB cancels all scheduled runs of the task.\n\nIf you want to disable a task instead of delete it, [update the task status to `inactive`](#operation/PatchTasksID).\n" }, { "info": { "name": "List labels for a task", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks/:taskID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The ID of the task to retrieve labels for." } ] }, "docs": "Retrieves a list of all labels for a task.\n\nLabels may be used for grouping and filtering tasks.\n" }, { "info": { "name": "Add a label to a task", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/tasks/:taskID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The ID of the task to label." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a label to a task.\n\nUse this endpoint to add a label that you can use to filter tasks in the InfluxDB UI.\n" }, { "info": { "name": "Delete a label from a task", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/tasks/:taskID/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The ID of the task to delete the label from." }, { "name": "labelID", "value": "", "type": "path", "description": "The ID of the label to delete." } ] }, "docs": "Deletes a label from a task.\n" }, { "info": { "name": "Retrieve all logs for a task", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks/:taskID/logs", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The task ID." } ] }, "docs": "Retrieves a list of all logs for a [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task).\n\nWhen an InfluxDB task runs, a “run” record is created in the task’s history.\nLogs associated with each run provide relevant log messages, timestamps, and the exit status of the run attempt.\n\nUse this endpoint to retrieve only the log events for a task,\nwithout additional task metadata.\n" }, { "info": { "name": "List all task members", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks/:taskID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The task ID." } ] }, "docs": "**Deprecated**: Tasks don't use `owner` and `member` roles.\nUse [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\nLists all users that have the `member` role for the specified [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task).\n" }, { "info": { "name": "Add a member to a task", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/tasks/:taskID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The task ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated**: Tasks don't use `owner` and `member` roles.\nUse [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\nAdds a user to members of a task and returns the member.\n" }, { "info": { "name": "Remove a member from a task", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/tasks/:taskID/members/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the member to remove." }, { "name": "taskID", "value": "", "type": "path", "description": "The task ID." } ] }, "docs": "**Deprecated**: Tasks don't use `owner` and `member` roles.\nUse [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\nRemoves a member from a [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task).\n" }, { "info": { "name": "List all owners of a task", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks/:taskID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The ID of the task to retrieve owners for." } ] }, "docs": "**Deprecated**: Tasks don't use `owner` and `member` roles.\nUse [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\nRetrieves all users that have owner permission for a task.\n" }, { "info": { "name": "Add an owner for a task", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/tasks/:taskID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The task ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated**: Tasks don't use `owner` and `member` roles.\nUse [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n\nAssigns a task `owner` role to a user.\n\nUse this endpoint to create a _resource owner_ for the task.\nA _resource owner_ is a user with `role: owner` for a specific resource.\n" }, { "info": { "name": "Remove an owner from a task", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/tasks/:taskID/owners/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the owner to remove." }, { "name": "taskID", "value": "", "type": "path", "description": "The task ID." } ] }, "docs": "**Deprecated**: Tasks don't use `owner` and `member` roles.\nUse [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions.\n" }, { "info": { "name": "List runs for a task", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks/:taskID/runs", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The ID of the task to get runs for.\nOnly returns runs for this task.\n" }, { "name": "after", "value": "", "type": "query", "description": "A task run ID. Only returns runs created after this run." }, { "name": "limit", "value": "", "type": "query", "description": "Limits the number of task runs returned. Default is `100`.\n" }, { "name": "afterTime", "value": "", "type": "query", "description": "A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#rfc3339-timestamp)).\nOnly returns runs scheduled after this time.\n" }, { "name": "beforeTime", "value": "", "type": "query", "description": "A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#rfc3339-timestamp)).\nOnly returns runs scheduled before this time.\n" } ] }, "docs": "Retrieves a list of runs for a [task](https://docs.influxdata.com/influxdb/cloud/process-data/).\n\nTo limit which task runs are returned, pass query parameters in your request.\nIf no query parameters are passed, InfluxDB returns all task runs up to the default `limit`.\n" }, { "info": { "name": "Retrieve a run for a task.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks/:taskID/runs/:runID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The ID of the task to retrieve runs for." }, { "name": "runID", "value": "", "type": "path", "description": "The ID of the run to retrieve." } ] }, "docs": "Retrieves a specific run for a [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task).\n\nUse this endpoint to retrieve detail and logs for a specific task run.\n" }, { "info": { "name": "Cancel a running task", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/tasks/:taskID/runs/:runID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The ID of the task to cancel." }, { "name": "runID", "value": "", "type": "path", "description": "The ID of the task run to cancel." } ] }, "docs": "Cancels a running [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task).\n\nUse this endpoint with InfluxDB OSS to cancel a running task.\n\n#### InfluxDB Cloud\n\n- Doesn't support this operation.\n" }, { "info": { "name": "Retrieve all logs for a run", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/tasks/:taskID/runs/:runID/logs", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "The ID of the task to get logs for." }, { "name": "runID", "value": "", "type": "path", "description": "The ID of the run to get logs for." } ] }, "docs": "Retrieves all logs for a task run.\nA log is a list of run events with `runID`, `time`, and `message` properties.\n\nUse this endpoint to help analyze task performance and troubleshoot failed task runs.\n" }, { "info": { "name": "Retry a task run", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/tasks/:taskID/runs/:runID/retry", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "taskID", "value": "", "type": "path", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) ID.\nSpecifies the task to retry.\n" }, { "name": "runID", "value": "", "type": "path", "description": "A [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) run ID.\nSpecifies the task run to retry.\n\nTo find a task run ID, use the\n[`GET /api/v2/tasks/{taskID}/runs` endpoint](#operation/GetTasksIDRuns)\nto list task runs.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Queues a [task](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#task) run to\nretry and returns the scheduled run.\n\nTo manually start a _new_ task run, use the\n[`POST /api/v2/tasks/{taskID}/runs` endpoint](#operation/PostTasksIDRuns).\n\n#### Limitations\n\n- The task must be _active_ (`status: \"active\"`).\n" } ] }, { "info": { "name": "Telegraf Plugins", "type": "folder" }, "items": [ { "info": { "name": "List all Telegraf plugins", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/telegraf/plugins", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "type", "value": "", "type": "query", "description": "The type of plugin desired." } ] }, "docs": "List all Telegraf plugins" } ] }, { "info": { "name": "Telegrafs", "type": "folder" }, "items": [ { "info": { "name": "List all Telegraf configurations", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/telegrafs", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "orgID", "value": "", "type": "query", "description": "The organization ID the Telegraf config belongs to." } ] }, "docs": "List all Telegraf configurations" }, { "info": { "name": "Create a Telegraf configuration", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/telegrafs", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Telegraf configuration" }, { "info": { "name": "Retrieve a Telegraf configuration", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/telegrafs/:telegrafID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf configuration ID." } ] }, "docs": "Retrieve a Telegraf configuration" }, { "info": { "name": "Update a Telegraf configuration", "type": "http" }, "http": { "method": "PUT", "url": "/api/v2/telegrafs/:telegrafID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf config ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Telegraf configuration" }, { "info": { "name": "Delete a Telegraf configuration", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/telegrafs/:telegrafID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf configuration ID." } ] }, "docs": "Delete a Telegraf configuration" }, { "info": { "name": "List all labels for a Telegraf config", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/telegrafs/:telegrafID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf config ID." } ] }, "docs": "List all labels for a Telegraf config" }, { "info": { "name": "Add a label to a Telegraf config", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/telegrafs/:telegrafID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf config ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a label to a Telegraf config" }, { "info": { "name": "Delete a label from a Telegraf config", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/telegrafs/:telegrafID/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf config ID." }, { "name": "labelID", "value": "", "type": "path", "description": "The label ID." } ] }, "docs": "Delete a label from a Telegraf config" }, { "info": { "name": "List all users with member privileges for a Telegraf config", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/telegrafs/:telegrafID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf config ID." } ] }, "docs": "List all users with member privileges for a Telegraf config" }, { "info": { "name": "Add a member to a Telegraf config", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/telegrafs/:telegrafID/members", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf config ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a member to a Telegraf config" }, { "info": { "name": "Remove a member from a Telegraf config", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/telegrafs/:telegrafID/members/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the member to remove." }, { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf config ID." } ] }, "docs": "Remove a member from a Telegraf config" }, { "info": { "name": "List all owners of a Telegraf configuration", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/telegrafs/:telegrafID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf configuration ID." } ] }, "docs": "List all owners of a Telegraf configuration" }, { "info": { "name": "Add an owner to a Telegraf configuration", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/telegrafs/:telegrafID/owners", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf configuration ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an owner to a Telegraf configuration" }, { "info": { "name": "Remove an owner from a Telegraf config", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/telegrafs/:telegrafID/owners/:userID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "path", "description": "The ID of the owner to remove." }, { "name": "telegrafID", "value": "", "type": "path", "description": "The Telegraf config ID." } ] }, "docs": "Remove an owner from a Telegraf config" } ] }, { "info": { "name": "Variables", "type": "folder" }, "items": [ { "info": { "name": "List all variables", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/variables", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization." }, { "name": "orgID", "value": "", "type": "query", "description": "The organization ID." } ] }, "docs": "List all variables" }, { "info": { "name": "Create a variable", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/variables", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a variable" }, { "info": { "name": "Retrieve a variable", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/variables/:variableID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "variableID", "value": "", "type": "path", "description": "The variable ID." } ] }, "docs": "Retrieve a variable" }, { "info": { "name": "Replace a variable", "type": "http" }, "http": { "method": "PUT", "url": "/api/v2/variables/:variableID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "variableID", "value": "", "type": "path", "description": "The variable ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace a variable" }, { "info": { "name": "Update a variable", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/variables/:variableID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "variableID", "value": "", "type": "path", "description": "The variable ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a variable" }, { "info": { "name": "Delete a variable", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/variables/:variableID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "variableID", "value": "", "type": "path", "description": "The variable ID." } ] }, "docs": "Delete a variable" }, { "info": { "name": "List all labels for a variable", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/variables/:variableID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "variableID", "value": "", "type": "path", "description": "The variable ID." } ] }, "docs": "List all labels for a variable" }, { "info": { "name": "Add a label to a variable", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/variables/:variableID/labels", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "variableID", "value": "", "type": "path", "description": "The variable ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a label to a variable" }, { "info": { "name": "Delete a label from a variable", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/variables/:variableID/labels/:labelID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "variableID", "value": "", "type": "path", "description": "The variable ID." }, { "name": "labelID", "value": "", "type": "path", "description": "The label ID to delete." } ] }, "docs": "Delete a label from a variable" } ] }, { "info": { "name": "Legacy Authorizations", "type": "folder" }, "items": [ { "info": { "name": "List all legacy authorizations", "type": "http" }, "http": { "method": "GET", "url": "/legacy/authorizations", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "userID", "value": "", "type": "query", "description": "A user ID.\nOnly returns legacy authorizations scoped to the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).\n" }, { "name": "user", "value": "", "type": "query", "description": "A user name.\nOnly returns legacy authorizations scoped to the specified [user]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#user).\n" }, { "name": "orgID", "value": "", "type": "query", "description": "An organization ID.\nOnly returns legacy authorizations that belong to the specified [organization]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#organization).\n" }, { "name": "org", "value": "", "type": "query", "description": "An organization name.\nOnly returns legacy authorizations that belong to the specified [organization]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#organization).\n" }, { "name": "token", "value": "", "type": "query", "description": "An authorization name token.\nOnly returns legacy authorizations with the specified name.\n" }, { "name": "authID", "value": "", "type": "query", "description": "An authorization ID.\nReturns the specified legacy authorization.\n" } ] }, "docs": "List all legacy authorizations" }, { "info": { "name": "Create a legacy authorization", "type": "http" }, "http": { "method": "POST", "url": "/legacy/authorizations", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a legacy authorization and returns the legacy authorization.\n\n#### Required permissions\n\n- `write-users USER_ID` if you pass the `userID` property in the request body.\n\n*`USER_ID`* is the ID of the user that you want to scope the authorization to.\n" }, { "info": { "name": "Retrieve a legacy authorization", "type": "http" }, "http": { "method": "GET", "url": "/legacy/authorizations/:authID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "authID", "value": "", "type": "path", "description": "The ID of the legacy authorization to get." } ] }, "docs": "Retrieve a legacy authorization" }, { "info": { "name": "Update a legacy authorization to be active or inactive", "type": "http" }, "http": { "method": "PATCH", "url": "/legacy/authorizations/:authID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "authID", "value": "", "type": "path", "description": "The ID of the legacy authorization to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a legacy authorization to be active or inactive" }, { "info": { "name": "Delete a legacy authorization", "type": "http" }, "http": { "method": "DELETE", "url": "/legacy/authorizations/:authID", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "authID", "value": "", "type": "path", "description": "The ID of the legacy authorization to delete." } ] }, "docs": "Delete a legacy authorization" }, { "info": { "name": "Set a legacy authorization password", "type": "http" }, "http": { "method": "POST", "url": "/legacy/authorizations/:authID/password", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" } ], "params": [ { "name": "authID", "value": "", "type": "path", "description": "The ID of the legacy authorization to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set a legacy authorization password" } ] }, { "info": { "name": "Legacy Query", "type": "folder" }, "items": [ { "info": { "name": "Query with the 1.x compatibility API", "type": "http" }, "http": { "method": "GET", "url": "/query", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" }, { "name": "Accept", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "u", "value": "", "type": "query", "description": "The InfluxDB 1.x username to authenticate the request." }, { "name": "p", "value": "", "type": "query", "description": "The InfluxDB 1.x password to authenticate the request." }, { "name": "db", "value": "", "type": "query", "description": "The database to query data from.\nThis is mapped to an InfluxDB [bucket]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#bucket).\nFor more information, see [Database and retention policy mapping]({{% INFLUXDB_DOCS_URL %}}/api/influxdb-1x/dbrp/).\n" }, { "name": "rp", "value": "", "type": "query", "description": "The retention policy to query data from.\nThis is mapped to an InfluxDB [bucket]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#bucket).\nFor more information, see [Database and retention policy mapping]({{% INFLUXDB_DOCS_URL %}}/api/influxdb-1x/dbrp/).\n" }, { "name": "q", "value": "", "type": "query", "description": "The InfluxQL query to execute. To execute multiple queries, delimit queries with a semicolon (`;`)." }, { "name": "epoch", "value": "", "type": "query", "description": "A unix timestamp precision.\nFormats timestamps as [unix (epoch) timestamps]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#unix-timestamp) the specified precision\ninstead of [RFC3339 timestamps]({{% INFLUXDB_DOCS_URL %}}/reference/glossary/#rfc3339-timestamp) with nanosecond precision.\n" } ] }, "docs": "Queries InfluxDB using InfluxQL." } ] }, { "info": { "name": "Legacy Write", "type": "folder" }, "items": [ { "info": { "name": "Write time series data into InfluxDB in a V1-compatible format", "type": "http" }, "http": { "method": "POST", "url": "/write", "headers": [ { "name": "Zap-Trace-Span", "value": "[object Object]" }, { "name": "Content-Encoding", "value": "" } ], "params": [ { "name": "u", "value": "", "type": "query", "description": "The InfluxDB 1.x username to authenticate the request." }, { "name": "p", "value": "", "type": "query", "description": "The InfluxDB 1.x password to authenticate the request." }, { "name": "db", "value": "", "type": "query", "description": "Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy." }, { "name": "rp", "value": "", "type": "query", "description": "Retention policy name." }, { "name": "precision", "value": "", "type": "query", "description": "Write precision." } ] }, "docs": "Write time series data into InfluxDB in a V1-compatible format" } ] } ], "bundled": true }