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 Restore API

The Restore API from InfluxData — 5 operation(s) for restore.

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

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

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

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

5 operations 5 paths 15 schemas 5 POST

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 Restore 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 5

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

Restore 5
POST
/restore/kv
Overwrite the embedded KV store on the server with a backed-up snapshot.
PostRestoreKV 3 params body → 200204default
POST
/restore/sql
Overwrite the embedded SQL store on the server with a backed-up snapshot.
PostRestoreSQL 3 params body → 204default
POST
/restore/bucket/{bucketID}deprecated
Overwrite storage metadata for a bucket with shard info from a backup.
PostRestoreBucketID 3 params body → 200default
POST
/restore/bucketMetadata
Create a new bucket pre-seeded with shard info from a backup.
PostRestoreBucketMetadata 1 param body → 201default
POST
/restore/shards/{shardID}
Restore a TSM snapshot into a shard.
PostRestoreShardId 4 params body → 204default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are BucketMetadataManifest (7 properties), ShardGroupManifest (6 properties), RetentionPolicyManifest (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
BucketShardMappings
array
ShardOwner
object
1 property 1 required
RetentionPolicyManifest
object
6 properties 6 required
ShardGroupManifest
object
6 properties 4 required
ShardGroupManifests
array
BucketMetadataManifest
object
7 properties 6 required
ShardManifests
array
SubscriptionManifest
object
3 properties 3 required
BucketShardMapping
object
2 properties 2 required
RetentionPolicyManifests
array
RestoredBucketMappings
object
3 properties 3 required
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-restore-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup 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