openapi: 3.0.0 info: title: InfluxDB Cloud API Service Authorizations (API tokens) Authorizations (API tokens) Backup 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: Backup paths: /backup/kv: get: operationId: GetBackupKV tags: - Backup summary: Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x. description: 'Retrieves a snapshot of metadata stored in the server''s embedded KV store. InfluxDB versions greater than 2.1.x don''t include metadata stored in embedded SQL; avoid using this endpoint with versions greater than 2.1.x. ' deprecated: true parameters: - $ref: '#/components/parameters/TraceSpan' responses: '200': description: Success. The response contains a snapshot of KV metadata. content: application/octet-stream: schema: type: string format: binary default: description: Unexpected error $ref: '#/components/responses/GeneralServerError' /backup/metadata: get: operationId: GetBackupMetadata tags: - Backup summary: Download snapshot of all metadata in the server parameters: - $ref: '#/components/parameters/TraceSpan' - in: header name: Accept-Encoding description: Indicates the content encoding (usually a compression algorithm) that the client can understand. schema: type: string description: The content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. default: identity enum: - gzip - identity responses: '200': description: Snapshot of metadata headers: Content-Encoding: description: Lists any encodings (usually compression algorithms) that have been applied to the response payload. schema: type: string description: 'The content coding: `gzip` for compressed data or `identity` for unmodified, uncompressed data. ' default: identity enum: - gzip - identity content: multipart/mixed: schema: $ref: '#/components/schemas/MetadataBackup' default: description: Unexpected error $ref: '#/components/responses/GeneralServerError' /backup/shards/{shardID}: get: operationId: GetBackupShardId tags: - Backup summary: Download snapshot of all TSM data in a shard parameters: - $ref: '#/components/parameters/TraceSpan' - in: header name: Accept-Encoding description: Indicates the content encoding (usually a compression algorithm) that the client can understand. schema: type: string description: The content coding. Use `gzip` for compressed data or `identity` for unmodified, uncompressed data. default: identity enum: - gzip - identity - in: header name: Gzip-Compression-Level description: The gzip compression level to use when compressing the response. schema: type: string enum: - none - default - speedy - full - in: path name: shardID schema: type: integer format: int64 required: true description: The shard ID. - in: query name: since description: The earliest time [RFC3339 date/time format](https://docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp) to include in the snapshot. schema: type: string format: date-time examples: RFC3339: summary: RFC3339 date/time format value: 2006-01-02T15:04:05Z07:00 responses: '200': description: TSM snapshot. headers: Content-Encoding: description: Lists any encodings (usually compression algorithms) that have been applied to the response payload. schema: type: string description: 'The content coding: `gzip` for compressed data or `identity` for unmodified, uncompressed data. ' default: identity enum: - gzip - identity content: application/octet-stream: schema: type: string format: binary '404': description: Shard not found. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: Unexpected error $ref: '#/components/responses/GeneralServerError' components: schemas: ShardOwners: type: array items: $ref: '#/components/schemas/ShardOwner' SubscriptionManifests: type: array items: $ref: '#/components/schemas/SubscriptionManifest' ShardManifest: type: object properties: id: type: integer format: int64 shardOwners: $ref: '#/components/schemas/ShardOwners' required: - id - shardOwners MetadataBackup: type: object properties: kv: type: string format: binary sql: type: string format: binary buckets: $ref: '#/components/schemas/BucketMetadataManifests' required: - kv - sql - buckets ShardOwner: type: object properties: nodeID: type: integer format: int64 description: The ID of the node that owns the shard. required: - nodeID RetentionPolicyManifest: type: object properties: name: type: string replicaN: type: integer duration: type: integer format: int64 shardGroupDuration: type: integer format: int64 shardGroups: $ref: '#/components/schemas/ShardGroupManifests' subscriptions: $ref: '#/components/schemas/SubscriptionManifests' required: - name - replicaN - duration - shardGroupDuration - shardGroups - subscriptions BucketMetadataManifests: type: array items: $ref: '#/components/schemas/BucketMetadataManifest' ShardGroupManifests: type: array items: $ref: '#/components/schemas/ShardGroupManifest' BucketMetadataManifest: type: object properties: organizationID: type: string organizationName: type: string bucketID: type: string bucketName: type: string description: type: string defaultRetentionPolicy: type: string retentionPolicies: $ref: '#/components/schemas/RetentionPolicyManifests' required: - organizationID - organizationName - bucketID - bucketName - defaultRetentionPolicy - retentionPolicies ShardGroupManifest: type: object properties: id: type: integer format: int64 startTime: type: string format: date-time endTime: type: string format: date-time deletedAt: type: string format: date-time truncatedAt: type: string format: date-time shards: $ref: '#/components/schemas/ShardManifests' required: - id - startTime - endTime - shards ShardManifests: type: array items: $ref: '#/components/schemas/ShardManifest' SubscriptionManifest: type: object properties: name: type: string mode: type: string destinations: type: array items: type: string required: - name - mode - destinations RetentionPolicyManifests: type: array items: $ref: '#/components/schemas/RetentionPolicyManifest' 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 responses: GeneralServerError: description: Non 2XX error response from server. content: application/json: schema: $ref: '#/components/schemas/Error' 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: []