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 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 48 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

9 operations 7 paths 48 schemas 3 DELETE2 GET1 POST3 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 Schedule 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 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
List schedules - deprecated
listSchedules 1 param → 200
POST
/api/v1/customers/{cUUID}/schedules/page
List schedules V2
listSchedulesV2 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/schedules/{sUUID}deprecated
Delete a schedule - deprecated
deleteSchedule 3 params → 200
GET
/api/v1/customers/{cUUID}/schedules/{sUUID}
Get Schedule
getSchedule 2 params → 200
PUT
/api/v1/customers/{cUUID}/schedules/{sUUID}deprecated
Edit a backup schedule V2 - deprecated
editBackupScheduleV2 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/schedules/{sUUID}/deletedeprecated
Delete a schedule V2 - deprecated
deleteScheduleV2 3 params → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/delete_backup_schedule_async
Delete a backup schedule async
deleteBackupScheduleAsync 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/edit_backup_schedule_async
Edit a backup schedule async
editBackupScheduleAsync 4 params body → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/pause_resume
Toggle a backup schedule
toggleBackupSchedule 4 params body → 200

Schemas 48

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

BackupScheduleEditParams
object
6 properties
BackupInfo
object
11 properties 11 required
KeyspaceTablesList
object
8 properties 8 required
RegionLocations
object
3 properties 3 required
ScheduleResp
object
19 properties 17 required
SchedulePagedApiResponse
object
4 properties 4 required
Schedule
object
Backup schedule
17 properties 1 required
BackupScheduleToggleParams
object
2 properties 1 required
YBPSuccess
object
2 properties
SchedulePagedApiQuery
object
6 properties 6 required
BackupPointInTimeRestoreWindow
object
2 properties 2 required
YBPTask
object
2 properties
EditBackupScheduleParams
object
Info to edit the schedule params for backups
8 properties
ScheduleApiFilter
object
3 properties 3 required
SchedulePagedResponse
object
4 properties 4 required
Schedule_2
object
Backup schedule
10 properties
YBPSuccess_2
object
2 properties
SchedulePagedApiQuery_2
object
6 properties 6 required
EditBackupScheduleParams_2
object
Info to edit the schedule params for backups
4 properties
ScheduleApiFilter_2
object
3 properties 3 required
BackupScheduleEditParams_2
object
6 properties
BackupInfo_2
object
11 properties 11 required
KeyspaceTablesList_2
object
8 properties 8 required
RegionLocations_2
object
3 properties 3 required
ScheduleResp_2
object
19 properties 17 required
SchedulePagedApiResponse_2
object
4 properties 4 required
Schedule_3
object
Backup schedule
17 properties 1 required
BackupScheduleToggleParams_2
object
2 properties 1 required
YBPSuccess_3
object
2 properties
SchedulePagedApiQuery_3
object
6 properties 6 required
BackupPointInTimeRestoreWindow_2
object
2 properties 2 required
YBPTask_2
object
2 properties
EditBackupScheduleParams_3
object
Info to edit the schedule params for backups
8 properties
ScheduleApiFilter_3
object
3 properties 3 required
BackupScheduleEditParams_3
object
6 properties
BackupInfo_3
object
11 properties 11 required
KeyspaceTablesList_3
object
8 properties 8 required
RegionLocations_3
object
3 properties 3 required
ScheduleResp_3
object
19 properties 17 required
SchedulePagedApiResponse_3
object
4 properties 4 required
Schedule_4
object
Backup schedule
17 properties 1 required
BackupScheduleToggleParams_3
object
2 properties 1 required
YBPSuccess_4
object
2 properties
SchedulePagedApiQuery_4
object
6 properties 6 required
BackupPointInTimeRestoreWindow_3
object
2 properties 2 required
YBPTask_3
object
2 properties
EditBackupScheduleParams_4
object
Info to edit the schedule params for backups
8 properties
ScheduleApiFilter_4
object
3 properties 3 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
Where this information came from

This is an independent, third-party profile of YugabyteDB Schedule 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.