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

Yugabyte restore-info API

APIs for getting restore Details

Yugabyte restore-info API is one of 10 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include restore-info. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, {protocol}://{host_port}/api.

1 operations 1 paths 4 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Yugabyte restore-info API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuthToken). By default, every request must be authenticated.

Paths & Operations 1

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

restore-info 1

APIs for getting restore Details

GET
/restore
Get Restore Details
getRestoreDetails → 200400500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RestoreDetails (10 properties), ApiError_error (2 properties), ApiError (1 property), Restore_Details (1 property). Each schema is shown below with its type and property counts.

RestoreDetails
object
Details of databases in YugabyteDB cluster on which restore operation in run
10 properties 10 required
ApiError_error
object
2 properties
Restore_Details
object
1 property 1 required
ApiError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-restore-info-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
Yugabyte backup-info API
Yugabyte cluster API
Yugabyte cluster-info API
Yugabyte pitr-info API
Yugabyte voyager-info API
Yugabyte voyager-metrics API
Yugabyte Xcluster Metrics API
Yugabyte Xcluster Namespace Details API