Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxData Backup API

The Backup API from InfluxData — 3 operation(s) for backup.

InfluxData Backup API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Backup. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 3 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

3 operations 3 paths 14 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

InfluxData Backup API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (TokenAuthentication). It accepts HTTP basic authentication (BasicAuthentication). By default, every request must be authenticated.

  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…
  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Backup 3
GET
/backup/kvdeprecated
Download snapshot of metadata stored in the server's embedded KV store. Don't use with InfluxDB versions greater than InfluxDB 2.1.x.
GetBackupKV 1 param → 200default
GET
/backup/metadata
Download snapshot of all metadata in the server
GetBackupMetadata 2 params → 200default
GET
/backup/shards/{shardID}
Download snapshot of all TSM data in a shard
GetBackupShardId 5 params → 200404default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are BucketMetadataManifest (7 properties), RetentionPolicyManifest (6 properties), ShardGroupManifest (6 properties), Error (4 properties). Each schema is shown below with its type and property counts.

ShardOwners
array
SubscriptionManifests
array
ShardManifest
object
2 properties 2 required
MetadataBackup
object
3 properties 3 required
ShardOwner
object
1 property 1 required
RetentionPolicyManifest
object
6 properties 6 required
BucketMetadataManifests
array
ShardGroupManifests
array
BucketMetadataManifest
object
7 properties 6 required
ShardGroupManifest
object
6 properties 4 required
ShardManifests
array
SubscriptionManifest
object
3 properties 3 required
RetentionPolicyManifests
array
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-backup-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API
InfluxData Health API