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 Job Scheduler API

Job Scheduler

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

Tagged areas include Job Scheduler. 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 6 operations across 4 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, {protocol}://{host_port}/api/v2.

6 operations 4 paths 33 schemas 1 DELETE1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 6

Across 4 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.

Job Scheduler 6

Job Scheduler

DELETE
/customers/{cUUID}/job-schedules/{jUUID}
Delete Job Schedule
DeleteJobSchedule 2 params → 200400500
GET
/customers/{cUUID}/job-schedules/{jUUID}
Get Job Schedule
GetJobSchedule 2 params → 200400500
PUT
/customers/{cUUID}/job-schedules/{jUUID}
Update Job Schedule
UpdateJobSchedule 2 params body → 200400500
POST
/customers/{cUUID}/job-schedules/page
List Job Schedules (paginated)
PageListJobSchedules 1 param body → 200400500
POST
/customers/{cUUID}/job-schedules/{jUUID}/job-instances/page
List Job Instances (paginated)
PageListJobInstances 2 params body → 200400500
POST
/customers/{cUUID}/job-schedules/{jUUID}/snooze
Snooze Job Schedule
SnoozeJobSchedule 2 params body → 200400500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are JobScheduleInfo (11 properties), JobScheduleInfo_2 (11 properties), JobInstanceInfo (6 properties), JobInstanceInfo_2 (6 properties). Each schema is shown below with its type and property counts.

JobInstanceApiFilter
object
API filter for job instance that is a part of JobInstancePagedQuerySpec.
2 properties
JobScheduleState
string
Job schedule state of a schedule that is a part of JobScheduleInfo.
JobInstanceInfo
object
Job instance info representing the execution instance of a JobSchedule.
6 properties
JobSchedule
object
Job schedule which contains the spec and execution info for a schedule.
2 properties
JobScheduleType
string
Job schedule type which is a part of JobScheduleConfigSpec. Fixed delay keeps a fixed interval between the end and start of previous and next job executions re…
PaginationSpec
object
Pagination spec in page API requests.
3 properties
JobConfigSpec
object
Job config spec for a schedule that is a part of JobScheduleSpec
2 properties 1 required
JobScheduleSpec
object
Spec of a job schedule that is a part of JobSchedule.
3 properties 3 required
JobSchedulePagedResp
object
JobScheduleApiFilter
object
API filter for job schedule that is a part of JobSchedulePagedQuerySpec.
5 properties
JobScheduleInfo
object
Job schedule info which is a part of JobSchedule.
11 properties
PaginationResp
object
Pagination information in page API responses.
3 properties
JobSchedulePagedQuerySpec
object
JobScheduleSnoozeSpec
object
JobScheduleSnoozeSpec Request payload to put off the next schedule by snooze secs.
1 property 1 required
JobInstanceState
string
State of a job instance that is a part of JobInstance.
JobScheduleConfigSpec
object
Job schedule config spec for a job schedule.
4 properties 3 required
JobInstancePagedResp
object
JobInstancePagedQuerySpec
object
JobScheduleUpdateSpec
object
JobScheduleUpdateSpec Request payload for updating schedule config of a job.
JobInstanceApiFilter_2
object
API filter for job instance that is a part of JobInstancePagedQuerySpec.
2 properties
JobInstanceInfo_2
object
Job instance info representing the execution instance of a JobSchedule.
6 properties
PaginationSpec_2
object
Pagination spec in page API requests.
3 properties
JobConfigSpec_2
object
Job config spec for a schedule that is a part of JobScheduleSpec
2 properties 1 required
JobScheduleSpec_2
object
Spec of a job schedule that is a part of JobSchedule.
3 properties 3 required
JobSchedulePagedResp_2
object
JobScheduleApiFilter_2
object
API filter for job schedule that is a part of JobSchedulePagedQuerySpec.
5 properties
JobScheduleInfo_2
object
Job schedule info which is a part of JobSchedule.
11 properties
PaginationResp_2
object
Pagination information in page API responses.
3 properties
JobSchedulePagedQuerySpec_2
object
JobScheduleSnoozeSpec_2
object
JobScheduleSnoozeSpec Request payload to put off the next schedule by snooze secs.
1 property 1 required
JobScheduleConfigSpec_2
object
Job schedule config spec for a job schedule.
4 properties 3 required
JobInstancePagedResp_2
object
JobInstancePagedQuerySpec_2
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-job-scheduler-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 Job Scheduler 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.