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 pitr-info API

APIs for getting Point-in-Time Recovery (PITR) schedules

Yugabyte pitr-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 pitr-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 pitr-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.

pitr-info 1

APIs for getting Point-in-Time Recovery (PITR) schedules

GET
/pitr
Get PITR Schedules
getPITRSchedules → 200400500

Schemas 4

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

PITRSchedule
object
Details of a Point-in-Time Recovery (PITR) schedule
5 properties 5 required
ApiError_error
object
2 properties
PITR_Schedule_Response
object
1 property 1 required
ApiError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-pitr-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 restore-info API
Yugabyte voyager-info API
Yugabyte voyager-metrics API
Yugabyte Xcluster Metrics API
Yugabyte Xcluster Namespace Details API