openapi: 3.0.0 info: title: InfluxDB Cloud API Service Authorizations (API tokens) Authorizations (API tokens) Replications 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: Replications paths: /replications: get: operationId: GetReplications tags: - Replications summary: List all replications parameters: - $ref: '#/components/parameters/TraceSpan' - in: query name: orgID description: The organization ID. required: true schema: type: string - in: query name: name schema: type: string - in: query name: remoteID schema: type: string - in: query name: localBucketID schema: type: string responses: '200': description: List of replications content: application/json: schema: $ref: '#/components/schemas/Replications' '404': $ref: '#/components/responses/GeneralServerError' default: $ref: '#/components/responses/GeneralServerError' post: operationId: PostReplication tags: - Replications summary: Register a new replication parameters: - $ref: '#/components/parameters/TraceSpan' - in: query name: validate description: If true, validate the replication, but don't save it. schema: type: boolean default: false requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplicationCreationRequest' responses: '201': description: Replication saved content: application/json: schema: $ref: '#/components/schemas/Replication' '204': description: Replication validated, but not saved '400': $ref: '#/components/responses/GeneralServerError' default: $ref: '#/components/responses/GeneralServerError' /replications/{replicationID}: get: operationId: GetReplicationByID tags: - Replications summary: Retrieve a replication parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: replicationID schema: type: string required: true responses: '200': description: Replication content: application/json: schema: $ref: '#/components/schemas/Replication' '404': $ref: '#/components/responses/GeneralServerError' default: $ref: '#/components/responses/GeneralServerError' patch: operationId: PatchReplicationByID tags: - Replications summary: Update a replication parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: replicationID schema: type: string required: true - in: query name: validate description: If true, validate the updated information, but don't save it. schema: type: boolean default: false requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplicationUpdateRequest' responses: '200': description: Updated information saved content: application/json: schema: $ref: '#/components/schemas/Replication' '204': description: Updated replication validated, but not saved '400': $ref: '#/components/responses/GeneralServerError' '404': $ref: '#/components/responses/GeneralServerError' default: $ref: '#/components/responses/GeneralServerError' delete: operationId: DeleteReplicationByID tags: - Replications summary: Delete a replication parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: replicationID schema: type: string required: true responses: '204': description: Replication deleted. '404': $ref: '#/components/responses/GeneralServerError' default: $ref: '#/components/responses/GeneralServerError' /replications/{replicationID}/validate: post: operationId: PostValidateReplicationByID tags: - Replications summary: Validate a replication parameters: - $ref: '#/components/parameters/TraceSpan' - in: path name: replicationID schema: type: string required: true responses: '204': description: Replication is valid '400': description: Replication failed validation $ref: '#/components/responses/GeneralServerError' default: $ref: '#/components/responses/GeneralServerError' components: schemas: Replications: type: object properties: replications: type: array items: $ref: '#/components/schemas/Replication' ReplicationCreationRequest: type: object properties: name: type: string description: type: string orgID: type: string remoteID: type: string localBucketID: type: string remoteBucketID: type: string remoteBucketName: type: string maxQueueSizeBytes: type: integer format: int64 minimum: 33554430 default: 67108860 dropNonRetryableData: type: boolean default: false maxAgeSeconds: type: integer format: int64 minimum: 0 default: 604800 required: - name - orgID - remoteID - localBucketID - maxQueueSizeBytes - maxAgeSeconds ReplicationUpdateRequest: type: object properties: name: type: string description: type: string remoteID: type: string remoteBucketID: type: string remoteBucketName: type: string maxQueueSizeBytes: type: integer format: int64 minimum: 33554430 dropNonRetryableData: type: boolean maxAgeSeconds: type: integer format: int64 minimum: 0 Replication: type: object properties: id: type: string name: type: string description: type: string orgID: type: string remoteID: type: string localBucketID: type: string remoteBucketID: type: string remoteBucketName: type: string maxQueueSizeBytes: type: integer format: int64 currentQueueSizeBytes: type: integer format: int64 remainingBytesToBeSynced: type: integer format: int64 latestResponseCode: type: integer latestErrorMessage: type: string dropNonRetryableData: type: boolean required: - id - name - remoteID - orgID - localBucketID - maxQueueSizeBytes 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: []