openapi: 3.0.0 info: title: InfluxDB Cloud API Service Authorizations (API tokens) Authorizations (API tokens) Restore 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: Restore paths: /restore/kv: post: operationId: PostRestoreKV tags: - Restore summary: Overwrite the embedded KV store on the server with a backed-up snapshot. parameters: - $ref: '#/components/parameters/TraceSpan' - in: header name: Content-Encoding description: 'The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. ' 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: Content-Type schema: type: string default: application/octet-stream enum: - application/octet-stream requestBody: description: Full KV snapshot. required: true content: text/plain: schema: type: string format: binary responses: '200': description: KV store successfully overwritten. content: application/json: schema: type: object properties: token: description: token is the root token for the instance after restore (this is overwritten during the restore) type: string '204': description: KV store successfully overwritten. default: description: Unexpected error $ref: '#/components/responses/GeneralServerError' /restore/sql: post: operationId: PostRestoreSQL tags: - Restore summary: Overwrite the embedded SQL store on the server with a backed-up snapshot. parameters: - $ref: '#/components/parameters/TraceSpan' - in: header name: Content-Encoding description: 'The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. ' schema: type: string description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. default: identity enum: - gzip - identity - in: header name: Content-Type schema: type: string default: application/octet-stream enum: - application/octet-stream requestBody: description: Full SQL snapshot. required: true content: text/plain: schema: type: string format: binary responses: '204': description: SQL store successfully overwritten. default: description: Unexpected error $ref: '#/components/responses/GeneralServerError' /restore/bucket/{bucketID}: post: operationId: PostRestoreBucketID tags: - Restore summary: Overwrite storage metadata for a bucket with shard info from a backup. deprecated: true parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: bucketID schema: type: string required: true description: The bucket ID. - in: header name: Content-Type schema: type: string default: application/octet-stream enum: - application/octet-stream requestBody: description: Database info serialized as protobuf. required: true content: text/plain: schema: type: string format: byte responses: '200': description: ID mappings for shards in bucket. content: application/json: schema: type: string format: byte default: description: Unexpected error $ref: '#/components/responses/GeneralServerError' /restore/bucketMetadata: post: operationId: PostRestoreBucketMetadata tags: - Restore summary: Create a new bucket pre-seeded with shard info from a backup. parameters: - $ref: '#/components/parameters/TraceSpan' requestBody: description: Metadata manifest for a bucket. required: true content: application/json: schema: $ref: '#/components/schemas/BucketMetadataManifest' responses: '201': description: ID mappings for shards in new bucket. content: application/json: schema: $ref: '#/components/schemas/RestoredBucketMappings' default: description: Unexpected error $ref: '#/components/responses/GeneralServerError' /restore/shards/{shardID}: post: operationId: PostRestoreShardId tags: - Restore summary: Restore a TSM snapshot into a shard. parameters: - $ref: '#/components/parameters/TraceSpan' - in: header name: Content-Encoding description: 'The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header. ' schema: type: string description: Specifies that the line protocol in the body is encoded with gzip or not encoded with identity. default: identity enum: - gzip - identity - in: header name: Content-Type schema: type: string default: application/octet-stream enum: - application/octet-stream - in: path name: shardID schema: type: string required: true description: The shard ID. requestBody: description: TSM snapshot. required: true content: text/plain: schema: type: string format: binary responses: '204': description: TSM snapshot successfully restored. 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 BucketShardMappings: type: array items: $ref: '#/components/schemas/BucketShardMapping' 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 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 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 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 BucketShardMapping: type: object properties: oldId: type: integer format: int64 newId: type: integer format: int64 required: - oldId - newId RetentionPolicyManifests: type: array items: $ref: '#/components/schemas/RetentionPolicyManifest' RestoredBucketMappings: type: object properties: id: description: New ID of the restored bucket type: string name: type: string shardMappings: $ref: '#/components/schemas/BucketShardMappings' required: - id - name - shardMappings 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: []