Yugabyte voyager-metrics API
APIs for getting Voyager data migrations metrics
Yugabyte voyager-metrics API is one of 10 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include voyager-metrics. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yugabyte voyager-metrics 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.
APIs for getting Voyager data migrations metrics
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are VoyagerMigrateDataMetricsDetails (8 properties), ApiError_error (2 properties), ApiError (1 property), VoyagerMigrateDataMetrics (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yugabyte 9
Other APIs Yugabyte publishes across the network.