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

YugabyteDB Schedule management API

The Schedule management API from YugabyteDB — 7 operation(s) for schedule management.

YugabyteDB Schedule management API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 9 operations across 7 paths, and defines 28 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

9 operations 7 paths 28 schemas 3 DELETE2 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.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

YugabyteDB Schedule management API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 9

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

Schedule management 9
GET
/api/v1/customers/{cUUID}/schedulesdeprecated
YugabyteDB Anywhere List Schedules - Deprecated
listSchedules 1 param → 200
POST
/api/v1/customers/{cUUID}/schedules/page
YugabyteDB Anywhere List Schedules V2
listSchedulesV2 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/schedules/{sUUID}deprecated
YugabyteDB Anywhere Delete a Schedule - Deprecated
deleteSchedule 3 params → 200
GET
/api/v1/customers/{cUUID}/schedules/{sUUID}
YugabyteDB Anywhere Get Schedule
getSchedule 2 params → 200
PUT
/api/v1/customers/{cUUID}/schedules/{sUUID}deprecated
YugabyteDB Anywhere Edit a Backup Schedule V2 - Deprecated
editBackupScheduleV2 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/schedules/{sUUID}/deletedeprecated
YugabyteDB Anywhere Delete a Schedule V2 - Deprecated
deleteScheduleV2 3 params → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/delete_backup_schedule_async
YugabyteDB Anywhere Delete a Backup Schedule Async
deleteBackupScheduleAsync 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/edit_backup_schedule_async
YugabyteDB Anywhere Edit a Backup Schedule Async
editBackupScheduleAsync 4 params body → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/pause_resume
YugabyteDB Anywhere Toggle a Backup Schedule
toggleBackupSchedule 4 params body → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ScheduleResp (19 properties), ScheduleResp_2 (19 properties), Schedule_2 (17 properties), Schedule (17 properties). Each schema is shown below with its type and property counts.

SchedulePagedApiQuery
object
6 properties 6 required
RegionLocations
object
3 properties 3 required
BackupInfo
object
11 properties 11 required
EditBackupScheduleParams
object
Info to edit the schedule params for backups
8 properties
BackupScheduleToggleParams
object
2 properties 1 required
SchedulePagedApiResponse
object
4 properties 4 required
BackupPointInTimeRestoreWindow
object
2 properties 2 required
ScheduleApiFilter
object
3 properties 3 required
ScheduleResp
object
19 properties 17 required
YBPSuccess
object
2 properties
KeyspaceTablesList
object
8 properties 8 required
BackupScheduleEditParams
object
6 properties
YBPTask
object
2 properties
Schedule
object
Backup schedule
17 properties 1 required
SchedulePagedApiQuery_2
object
6 properties 6 required
RegionLocations_2
object
3 properties 3 required
BackupInfo_2
object
11 properties 11 required
EditBackupScheduleParams_2
object
Info to edit the schedule params for backups
8 properties
BackupScheduleToggleParams_2
object
2 properties 1 required
SchedulePagedApiResponse_2
object
4 properties 4 required
BackupPointInTimeRestoreWindow_2
object
2 properties 2 required
ScheduleApiFilter_2
object
3 properties 3 required
ScheduleResp_2
object
19 properties 17 required
YBPSuccess_2
object
2 properties
KeyspaceTablesList_2
object
8 properties 8 required
BackupScheduleEditParams_2
object
6 properties
YBPTask_2
object
2 properties
Schedule_2
object
Backup schedule
17 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-schedule-management-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API