How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB PITR management API

The PITR management API from YugabyteDB — 5 operation(s) for pitr management.

This API exposes 6 operations across 5 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

6 operations 5 paths 14 schemas 1 DELETE1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB PITR management API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as header

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

PITR management 6
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/clone
Clone namespace via PITR on a universe
cloneNamespace 3 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/keyspaces/{tableType}/{keyspaceName}/pitr_config
Create pitr config for a keyspace in a universe
createPitrConfig 5 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/pitr
Perform PITR on a universe
performPitr 3 params body → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config
List the PITR configs of a universe
ListOfPitrConfigs 2 params → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config/{pUUID}
Delete pitr config on a universe
deletePitrConfig 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config/{pUUID}
Update pitr config for a keyspace in a universe
updatePitrConfig 4 params body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are NodeDetails (37 properties), RestoreSnapshotScheduleParams (26 properties), CloneNamespaceParams (26 properties), CreatePitrConfigParams (26 properties). Each schema is shown below with its type and property counts.

PitrConfig
object
PITR config created on the universe
16 properties 3 required
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
CommunicationPorts
object
Communication ports
15 properties
UpdatePitrConfigParams
object
Update PITR config parameters
25 properties 4 required
YBPTask
object
2 properties
NodeDetails
object
Details of a cloud node
37 properties
DeviceInfo
object
Device information
8 properties
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
CreatePitrConfigParams
object
Create PITR config parameters
26 properties 4 required
CloneNamespaceParams
object
Clone Namespace parameters
26 properties 4 required
Users
object
A user associated with a customer
12 properties 3 required
ExtraDependencies
object
Extra dependencies
1 property
RestoreSnapshotScheduleParams
object
Restore snapshot schedule parameters
26 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-pitr-management-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of YugabyteDB PITR management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.