openapi: 3.0.0 info: title: InfluxDB Cloud API Service Authorizations (API tokens) Authorizations (API tokens) Sources API version: 2.0.1 description: 'The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. ' license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: /api/v2 security: - TokenAuthentication: [] tags: - name: Sources paths: /sources: post: operationId: PostSources tags: - Sources summary: Create a source parameters: - $ref: '#/components/parameters/TraceSpan' requestBody: description: Source to create required: true content: application/json: schema: $ref: '#/components/schemas/Source' responses: '201': description: Created Source content: application/json: schema: $ref: '#/components/schemas/Source' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' get: operationId: GetSources tags: - Sources summary: List all sources parameters: - $ref: '#/components/parameters/TraceSpan' - in: query name: org description: The name of the organization. schema: type: string responses: '200': description: A list of sources content: application/json: schema: $ref: '#/components/schemas/Sources' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /sources/{sourceID}: delete: operationId: DeleteSourcesID tags: - Sources summary: Delete a source parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: sourceID schema: type: string required: true description: The source ID. responses: '204': description: Delete has been accepted '404': description: View not found content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: operationId: PatchSourcesID tags: - Sources summary: Update a Source parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: sourceID schema: type: string required: true description: The source ID. requestBody: description: Source update required: true content: application/json: schema: $ref: '#/components/schemas/Source' responses: '200': description: Created Source content: application/json: schema: $ref: '#/components/schemas/Source' '404': description: Source not found content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' get: operationId: GetSourcesID tags: - Sources summary: Retrieve a source parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: sourceID schema: type: string required: true description: The source ID. responses: '200': description: A source content: application/json: schema: $ref: '#/components/schemas/Source' '404': description: Source not found content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /sources/{sourceID}/health: get: operationId: GetSourcesIDHealth tags: - Sources summary: Get the health of a source parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: sourceID schema: type: string required: true description: The source ID. responses: '200': description: The source is healthy content: application/json: schema: $ref: '#/components/schemas/HealthCheck' '503': description: The source is not healthy content: application/json: schema: $ref: '#/components/schemas/HealthCheck' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /sources/{sourceID}/buckets: get: operationId: GetSourcesIDBuckets tags: - Sources summary: Get buckets in a source parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: sourceID schema: type: string required: true description: The source ID. - in: query name: org description: The name of the organization. schema: type: string responses: '200': description: A source content: application/json: schema: $ref: '#/components/schemas/Buckets' '404': description: Source not found content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: HealthCheck: type: object required: - name - status properties: name: type: string message: type: string checks: type: array items: $ref: '#/components/schemas/HealthCheck' status: type: string enum: - pass - fail version: type: string commit: type: string RetentionRule: type: object properties: type: type: string default: expire enum: - expire everySeconds: type: integer format: int64 description: 'The duration in seconds for how long data will be kept in the database. The default duration is 2592000 (30 days). 0 represents infinite retention. ' example: 86400 default: 2592000 minimum: 0 shardGroupDurationSeconds: type: integer format: int64 description: 'The shard group duration. The duration or interval (in seconds) that each shard group covers. #### InfluxDB Cloud - Does not use `shardGroupDurationsSeconds`. #### InfluxDB OSS - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/#shard-group-duration). ' required: - everySeconds SchemaType: type: string enum: - implicit - explicit Label: type: object properties: id: readOnly: true type: string orgID: readOnly: true type: string name: type: string properties: type: object additionalProperties: type: string description: 'Key-value pairs associated with this label. To remove a property, send an update with an empty value (`""`) for the key. ' example: color: ffb3b3 description: this is a description Labels: type: array items: $ref: '#/components/schemas/Label' RetentionRules: type: array description: 'Retention rules to expire or retain data. The InfluxDB `/api/v2` API uses `RetentionRules` to configure the [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period). #### InfluxDB Cloud - `retentionRules` is required. #### InfluxDB OSS - `retentionRules` isn''t required. ' items: $ref: '#/components/schemas/RetentionRule' Source: type: object properties: links: type: object properties: self: type: string query: type: string health: type: string buckets: type: string id: type: string orgID: type: string default: type: boolean name: type: string type: type: string enum: - v1 - v2 - self url: type: string format: uri insecureSkipVerify: type: boolean telegraf: type: string token: type: string username: type: string password: type: string sharedSecret: type: string metaUrl: type: string format: uri defaultRP: type: string languages: type: array readOnly: true items: type: string enum: - flux - influxql Sources: type: object properties: links: type: object properties: self: type: string format: uri sources: type: array items: $ref: '#/components/schemas/Source' Buckets: type: object properties: links: readOnly: true $ref: '#/components/schemas/Links' buckets: type: array items: $ref: '#/components/schemas/Bucket' Bucket: properties: links: type: object readOnly: true example: labels: /api/v2/buckets/1/labels members: /api/v2/buckets/1/members org: /api/v2/orgs/2 owners: /api/v2/buckets/1/owners self: /api/v2/buckets/1 write: /api/v2/write?org=2&bucket=1 properties: labels: description: The URL to retrieve labels for this bucket. $ref: '#/components/schemas/Link' members: description: The URL to retrieve members that can read this bucket. $ref: '#/components/schemas/Link' org: description: The URL to retrieve parent organization for this bucket. $ref: '#/components/schemas/Link' owners: description: The URL to retrieve owners that can read and write to this bucket. $ref: '#/components/schemas/Link' self: description: The URL for this bucket. $ref: '#/components/schemas/Link' write: description: The URL to write line protocol to this bucket. $ref: '#/components/schemas/Link' id: readOnly: true type: string type: readOnly: true type: string default: user enum: - user - system name: type: string description: type: string orgID: type: string rp: type: string schemaType: $ref: '#/components/schemas/SchemaType' default: implicit createdAt: type: string format: date-time readOnly: true updatedAt: type: string format: date-time readOnly: true retentionRules: $ref: '#/components/schemas/RetentionRules' labels: $ref: '#/components/schemas/Labels' required: - name - retentionRules Link: type: string format: uri readOnly: true description: URI of resource. Error: properties: code: description: code is the machine-readable error code. readOnly: true type: string enum: - internal error - not implemented - not found - conflict - invalid - unprocessable entity - empty value - unavailable - forbidden - too many requests - unauthorized - method not allowed - request too large - unsupported media type message: readOnly: true description: Human-readable message. type: string op: readOnly: true description: Describes the logical code operation when the error occurred. Useful for debugging. type: string err: readOnly: true description: Stack of errors that occurred during processing of the request. Useful for debugging. type: string required: - code Links: type: object description: 'URI pointers for additional paged results. ' properties: next: $ref: '#/components/schemas/Link' self: $ref: '#/components/schemas/Link' prev: $ref: '#/components/schemas/Link' required: - self parameters: TraceSpan: in: header name: Zap-Trace-Span description: OpenTracing span context example: trace_id: '1' span_id: '1' baggage: key: value required: false schema: type: string securitySchemes: TokenAuthentication: type: apiKey name: Authorization in: header description: "Use the [Token authentication](#section/Authentication/TokenAuthentication)\nscheme to authenticate to the InfluxDB API.\n\nIn your API requests, send an `Authorization` header.\nFor the header value, provide the word `Token` followed by a space and an InfluxDB API token.\nThe word `Token` is case-sensitive.\n\n### Syntax\n\n`Authorization: Token INFLUX_API_TOKEN`\n\n### Example\n\n#### Use Token authentication with cURL\n\nThe following example shows how to use cURL to send an API request that uses Token authentication:\n\n```sh\ncurl --request GET \"INFLUX_URL/api/v2/buckets\" \\\n --header \"Authorization: Token INFLUX_API_TOKEN\"\n```\n\nReplace the following:\n\n - *`INFLUX_URL`*: your InfluxDB Cloud URL\n - *`INFLUX_API_TOKEN`*: your [InfluxDB API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\n\n### Related endpoints\n\n- [`/authorizations` endpoints](#tag/Authorizations-(API-tokens))\n\n### Related guides\n\n- [Authorize API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication)\n- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens/)\n" BasicAuthentication: type: http scheme: basic description: "### Basic authentication scheme\n\nUse the HTTP Basic authentication scheme for InfluxDB `/api/v2` API operations that support it:\n\n### Syntax\n\n`Authorization: Basic BASE64_ENCODED_CREDENTIALS`\n\nTo construct the `BASE64_ENCODED_CREDENTIALS`, combine the username and\nthe password with a colon (`USERNAME:PASSWORD`), and then encode the\nresulting string in [base64](https://developer.mozilla.org/en-US/docs/Glossary/Base64).\nMany HTTP clients encode the credentials for you before sending the\nrequest.\n\n_**Warning**: Base64-encoding can easily be reversed to obtain the original\nusername and password. It is used to keep the data intact and does not provide\nsecurity. You should always use HTTPS when authenticating or sending a request with\nsensitive information._\n\n### Examples\n\nIn the examples, replace the following:\n\n- **`EMAIL_ADDRESS`**: InfluxDB Cloud username (the email address the user signed up with)\n- **`PASSWORD`**: InfluxDB Cloud [API token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)\n- **`INFLUX_URL`**: your InfluxDB Cloud URL\n\n#### Encode credentials with cURL\n\nThe following example shows how to use cURL to send an API request that uses Basic authentication.\nWith the `--user` option, cURL encodes the credentials and passes them\nin the `Authorization: Basic` header.\n\n```sh\ncurl --get \"INFLUX_URL/api/v2/signin\"\n --user \"EMAIL_ADDRESS\":\"PASSWORD\"\n```\n\n#### Encode credentials with Flux\n\nThe Flux [`http.basicAuth()` function](https://docs.influxdata.com/flux/v0.x/stdlib/http/basicauth/) returns a Base64-encoded\nbasic authentication header using a specified username and password combination.\n\n#### Encode credentials with JavaScript\n\nThe following example shows how to use the JavaScript `btoa()` function\nto create a Base64-encoded string:\n\n```js\nbtoa('EMAIL_ADDRESS:PASSWORD')\n```\n\nThe output is the following:\n\n```js\n'VVNFUk5BTUU6UEFTU1dPUkQ='\n```\n\nOnce you have the Base64-encoded credentials, you can pass them in the\n`Authorization` header--for example:\n\n```sh\ncurl --get \"INFLUX_URL/api/v2/signin\"\n --header \"Authorization: Basic VVNFUk5BTUU6UEFTU1dPUkQ=\"\n```\n\nTo learn more about HTTP authentication, see\n[Mozilla Developer Network (MDN) Web Docs, HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)._\n" x-tagGroups: - name: Overview tags: - Quick start - Authentication - Supported operations - Headers - Pagination - Response codes - name: Popular endpoints tags: - Data I/O endpoints - Security and access endpoints - System information endpoints - name: All endpoints tags: []