YugabyteDB
YugabyteDB Job Scheduler API

Job Scheduler
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Job Scheduler API
  description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page.
  version: v1
  contact:
    name: Yugabyte Support
    url: https://support.yugabyte.com
  termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/
  x-generated-from: documentation
  x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/
  x-last-validated: '2026-05-03'
servers:
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
security:
- bearerAuth: []
tags:
- description: Job Scheduler
  name: Job Scheduler
paths:
  /customers/{cUUID}/job-schedules/{jUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: DeleteJobSchedule
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - description: Job Schedule UUID
        explode: false
        in: path
        name: jUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobSchedule'
              examples:
                DeleteJobSchedule200Example:
                  summary: Default DeleteJobSchedule 200 response
                  x-microcks-default: true
                  value:
                    spec:
                      job_config:
                        classname: classname
                        config:
                          key: '{}'
                      name: name
                      schedule_config:
                        interval_secs: 0
                        disabled: true
                        type: FIXED_DELAY
                        snooze_until: 2024-07-25 13:07:18+00:00
                    info:
                      last_end_time: 2024-07-25 13:07:18+00:00
                      updated_at: 2024-07-25 13:07:18+00:00
                      execution_count: 6
                      customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      created_at: 2024-07-25 13:07:18+00:00
                      failed_count: 1
                      next_start_time: 2024-07-25 13:07:18+00:00
                      state: ACTIVE
                      last_start_time: 2024-07-25 13:07:18+00:00
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: Job schedule
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Delete Job Schedule
      tags:
      - Job Scheduler
      x-yba-api-audit:
        auditTargetType: JobSchedule
        auditTargetId: jUUID.toString()
        auditActionType: Delete
      x-yba-api-authz:
      - requiredPermission:
          resourceType: other
          action: read
        resourceLocation:
          path: customers
          sourceType: endpoint
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-accepts:
      - application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: GetJobSchedule
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - description: Job Schedule UUID
        explode: false
        in: path
        name: jUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobSchedule'
              examples:
                GetJobSchedule200Example:
                  summary: Default GetJobSchedule 200 response
                  x-microcks-default: true
                  value:
                    spec:
                      job_config:
                        classname: classname
                        config:
                          key: '{}'
                      name: name
                      schedule_config:
                        interval_secs: 0
                        disabled: true
                        type: FIXED_DELAY
                        snooze_until: 2024-07-25 13:07:18+00:00
                    info:
                      last_end_time: 2024-07-25 13:07:18+00:00
                      updated_at: 2024-07-25 13:07:18+00:00
                      execution_count: 6
                      customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      created_at: 2024-07-25 13:07:18+00:00
                      failed_count: 1
                      next_start_time: 2024-07-25 13:07:18+00:00
                      state: ACTIVE
                      last_start_time: 2024-07-25 13:07:18+00:00
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: Job schedule
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get Job Schedule
      tags:
      - Job Scheduler
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: other
          action: read
        resourceLocation:
          path: customers
          sourceType: endpoint
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-accepts:
      - application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: UpdateJobSchedule
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - description: Job Schedule UUID
        explode: false
        in: path
        name: jUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      requestBody:
        $ref: '#/components/requestBodies/JobScheduleUpdateReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobSchedule'
              examples:
                UpdateJobSchedule200Example:
                  summary: Default UpdateJobSchedule 200 response
                  x-microcks-default: true
                  value:
                    spec:
                      job_config:
                        classname: classname
                        config:
                          key: '{}'
                      name: name
                      schedule_config:
                        interval_secs: 0
                        disabled: true
                        type: FIXED_DELAY
                        snooze_until: 2024-07-25 13:07:18+00:00
                    info:
                      last_end_time: 2024-07-25 13:07:18+00:00
                      updated_at: 2024-07-25 13:07:18+00:00
                      execution_count: 6
                      customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      created_at: 2024-07-25 13:07:18+00:00
                      failed_count: 1
                      next_start_time: 2024-07-25 13:07:18+00:00
                      state: ACTIVE
                      last_start_time: 2024-07-25 13:07:18+00:00
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: Job schedule
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Update Job Schedule
      tags:
      - Job Scheduler
      x-yba-api-audit:
        auditTargetType: JobSchedule
        auditTargetId: jUUID.toString()
        auditActionType: Update
      x-yba-api-authz:
      - requiredPermission:
          resourceType: other
          action: read
        resourceLocation:
          path: customers
          sourceType: endpoint
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /customers/{cUUID}/job-schedules/page:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: PageListJobSchedules
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      requestBody:
        $ref: '#/components/requestBodies/JobSchedulePagedReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobSchedulePagedResp'
              examples:
                PageListJobSchedules200Example:
                  summary: Default PageListJobSchedules 200 response
                  x-microcks-default: true
                  value:
                    entities:
                    - spec:
                        job_config:
                          classname: classname
                          config:
                            key: '{}'
                        name: name
                        schedule_config:
                          interval_secs: 0
                          disabled: true
                          type: FIXED_DELAY
                          snooze_until: 2024-07-25 13:07:18+00:00
                      info:
                        last_end_time: 2024-07-25 13:07:18+00:00
                        updated_at: 2024-07-25 13:07:18+00:00
                        execution_count: 6
                        customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        created_at: 2024-07-25 13:07:18+00:00
                        failed_count: 1
                        next_start_time: 2024-07-25 13:07:18+00:00
                        state: ACTIVE
                        last_start_time: 2024-07-25 13:07:18+00:00
                        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - spec:
                        job_config:
                          classname: classname
                          config:
                            key: '{}'
                        name: name
                        schedule_config:
                          interval_secs: 0
                          disabled: true
                          type: FIXED_DELAY
                          snooze_until: 2024-07-25 13:07:18+00:00
                      info:
                        last_end_time: 2024-07-25 13:07:18+00:00
                        updated_at: 2024-07-25 13:07:18+00:00
                        execution_count: 6
                        customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        created_at: 2024-07-25 13:07:18+00:00
                        failed_count: 1
                        next_start_time: 2024-07-25 13:07:18+00:00
                        state: ACTIVE
                        last_start_time: 2024-07-25 13:07:18+00:00
                        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    total_count: 0
                    has_next: true
                    has_prev: true
          description: Job schedules
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List Job Schedules (paginated)
      tags:
      - Job Scheduler
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: other
          action: read
        resourceLocation:
          path: customers
          sourceType: endpoint
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /customers/{cUUID}/job-schedules/{jUUID}/job-instances/page:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: PageListJobInstances
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - description: Job Schedule UUID
        explode: false
        in: path
        name: jUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      requestBody:
        $ref: '#/components/requestBodies/JobInstancePagedReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobInstancePagedResp'
              examples:
                PageListJobInstances200Example:
                  summary: Default PageListJobInstances 200 response
                  x-microcks-default: true
                  value:
                    entities:
                    - start_time: 2024-07-25 13:07:18+00:00
                      job_schedule_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      end_time: 2024-07-25 13:07:18+00:00
                      created_at: 2024-07-25 13:07:18+00:00
                      state: FAILED
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - start_time: 2024-07-25 13:07:18+00:00
                      job_schedule_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      end_time: 2024-07-25 13:07:18+00:00
                      created_at: 2024-07-25 13:07:18+00:00
                      state: FAILED
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    total_count: 0
                    has_next: true
                    has_prev: true
          description: Job instances
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List Job Instances (paginated)
      tags:
      - Job Scheduler
      x-yba-api-audit:
        noAudit: true
      x-yba-api-authz:
      - requiredPermission:
          resourceType: other
          action: read
        resourceLocation:
          path: customers
          sourceType: endpoint
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /customers/{cUUID}/job-schedules/{jUUID}/snooze:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: SnoozeJobSchedule
      parameters:
      - description: Customer UUID
        explode: false
        in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - description: Job Schedule UUID
        explode: false
        in: path
        name: jUUID
        required: true
        schema:
          format: uuid
          type: string
        style: simple
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      requestBody:
        $ref: '#/components/requestBodies/JobScheduleSnoozeReq'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobSchedule'
              examples:
                SnoozeJobSchedule200Example:
                  summary: Default SnoozeJobSchedule 200 response
                  x-microcks-default: true
                  value:
                    spec:
                      job_config:
                        classname: classname
                        config:
                          key: '{}'
                      name: name
                      schedule_config:
                        interval_secs: 0
                        disabled: true
                        type: FIXED_DELAY
                        snooze_until: 2024-07-25 13:07:18+00:00
                    info:
                      last_end_time: 2024-07-25 13:07:18+00:00
                      updated_at: 2024-07-25 13:07:18+00:00
                      execution_count: 6
                      customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      created_at: 2024-07-25 13:07:18+00:00
                      failed_count: 1
                      next_start_time: 2024-07-25 13:07:18+00:00
                      state: ACTIVE
                      last_start_time: 2024-07-25 13:07:18+00:00
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: Job schedule
        '400':
          description: Invalid input
        '500':
          description: Server error
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Snooze Job Schedule
      tags:
      - Job Scheduler
      x-yba-api-audit:
        auditTargetType: JobSchedule
        auditTargetId: jUUID.toString()
        auditActionType: Update
      x-yba-api-authz:
      - requiredPermission:
          resourceType: other
          action: read
        resourceLocation:
          path: customers
          sourceType: endpoint
      x-yba-api-since: 2024.2.0.0
      x-yba-api-visibility: preview
      x-content-type: application/json
      x-accepts:
      - application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    JobScheduleApiFilter:
      description: API filter for job schedule that is a part of JobSchedulePagedQuerySpec.
      example:
        enabled_only: true
        next_start_window_secs: 1
        config_class: config_class
        name_regex: name_regex
        type: FIXED_DELAY
      properties:
        config_class:
          description: Filter by config class of the job.
          type: string
          example: example-config_class
        enabled_only:
          description: Filter out disabled job schedules if true.
          type: boolean
          example: true
        name_regex:
          description: Filter by name regex.
          type: string
          example: example-name_regex
        next_start_window_secs:
          description: Filter by next start time window from now.
          format: int64
          type: integer
          example: 1000
        type:
          $ref: '#/components/schemas/JobScheduleType'
      title: JobScheduleApiFilter
      type: object
    JobScheduleState:
      description: Job schedule state of a schedule that is a part of JobScheduleInfo.
      enum:
      - ACTIVE
      - INACTIVE
      title: JobScheduleState
      type: string
    JobInstancePagedResp:
      allOf:
      - $ref: '#/components/schemas/PaginationResp'
      - description: Paged API query response for job instance.
        properties:
          entities:
            items:
              $ref: '#/components/schemas/JobInstanceInfo'
            type: array
            example:
            - start_time: '2024-07-25T13:07:18+00:00'
              job_schedule_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
              end_time: '2024-07-25T13:07:18+00:00'
              created_at: '2024-07-25T13:07:18+00:00'
              state: FAILED
              uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        title: JobInstancePagedResp
        type: object
        example: null
      example:
        entities:
        - start_time: 2024-07-25 13:07:18+00:00
          job_schedule_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          end_time: 2024-07-25 13:07:18+00:00
          created_at: 2024-07-25 13:07:18+00:00
          state: FAILED
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - start_time: 2024-07-25 13:07:18+00:00
          job_schedule_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          end_time: 2024-07-25 13:07:18+00:00
          created_at: 2024-07-25 13:07:18+00:00
          state: FAILED
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        total_count: 0
        has_next: true
        has_prev: true
      type: object
    JobSchedulePagedResp:
      allOf:
      - $ref: '#/components/schemas/PaginationResp'
      - description: Paged API query response for job schedule.
        properties:
          entities:
            items:
              $ref: '#/components/schemas/JobSchedule'
            type: array
            example:
            - spec:
                job_config:
                  classname: classname
                  config:
                    key: '{}'
                name: name
                schedule_config:
                  interval_secs: 0
                  disabled: true
                  type: FIXED_DELAY
                  snooze_until: '2024-07-25T13:07:18+00:00'
              info:
                last_end_time: '2024-07-25T13:07:18+00:00'
                updated_at: '2024-07-25T13:07:18+00:00'
                execution_count: 6
                customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                created_at: '2024-07-25T13:07:18+00:00'
                failed_count: 1
                next_start_time: '2024-07-25T13:07:18+00:00'
                state: ACTIVE
                last_start_time: '2024-07-25T13:07:18+00:00'
                uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        title: JobSchedulePagedResp
        type: object
        example: null
      example:
        entities:
        - spec:
            job_config:
              classname: classname
              config:
                key: '{}'
            name: name
            schedule_config:
              interval_secs: 0
              disabled: true
              type: FIXED_DELAY
              snooze_until: 2024-07-25 13:07:18+00:00
          info:
            last_end_time: 2024-07-25 13:07:18+00:00
            updated_at: 2024-07-25 13:07:18+00:00
            execution_count: 6
            customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            created_at: 2024-07-25 13:07:18+00:00
            failed_count: 1
            next_start_time: 2024-07-25 13:07:18+00:00
            state: ACTIVE
            last_start_time: 2024-07-25 13:07:18+00:00
            uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - spec:
            job_config:
              classname: classname
              config:
                key: '{}'
            name: name
            schedule_config:
              interval_secs: 0
              disabled: true
              type: FIXED_DELAY
              snooze_until: 2024-07-25 13:07:18+00:00
          info:
            last_end_time: 2024-07-25 13:07:18+00:00
            updated_at: 2024-07-25 13:07:18+00:00
            execution_count: 6
            customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            created_at: 2024-07-25 13:07:18+00:00
            failed_count: 1
            next_start_time: 2024-07-25 13:07:18+00:00
            state: ACTIVE
            last_start_time: 2024-07-25 13:07:18+00:00
            uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        total_count: 0
        has_next: true
        has_prev: true
      type: object
    JobScheduleInfo:
      description: Job schedule info which is a part of JobSchedule.
      example:
        last_end_time: 2024-07-25 13:07:18+00:00
        updated_at: 2024-07-25 13:07:18+00:00
        execution_count: 6
        customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        created_at: 2024-07-25 13:07:18+00:00
        failed_count: 1
        next_start_time: 2024-07-25 13:07:18+00:00
        state: ACTIVE
        last_start_time: 2024-07-25 13:07:18+00:00
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        last_job_instance_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        created_at:
          description: Creation time
          example: 2024-07-25 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        customer_uuid:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        execution_count:
          description: Total execution count
          format: int64
          readOnly: true
          type: integer
          example: 10
        failed_count:
          description: Total failed count
          format: int64
          readOnly: true
          type: integer
          example: 10
        last_end_time:
          description: Last end time
          example: 2024-07-25 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        last_job_instance_uuid:
          description: Last job instance UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        last_start_time:
          description: Last start time
          example: 2024-07-25 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        next_start_time:
          description: Next start time
          example: 2024-07-25 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        state:
          $ref: '#/components/schemas/JobScheduleState'
        updated_at:
          description: Updated time
          example: 2024-07-25 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        uuid:
          description: Job schedule UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      title: JobScheduleInfo
      type: object
    JobScheduleSpec:
      description: Spec of a job schedule that is a part of JobSchedule.
      example:
        job_config:
          classname: classname
          config:
            key: '{}'
        name: name
        schedule_config:
          interval_secs: 0
          disabled: true
          type: FIXED_DELAY
          snooze_until: 2024-07-25 13:07:18+00:00
      properties:
        name:
          description: Job schedule name
          readOnly: true
          type: string
          example: example-name
        job_config:
          $ref: '#/components/schemas/JobConfigSpec'
        schedule_config:
          $ref: '#/components/schemas/JobScheduleConfigSpec'
      required:
      - job_config
      - name
      - schedule_config
      title: JobScheduleSpec
      type: object
    JobSchedulePagedQuerySpec:
      allOf:
      - $ref: '#/components/schemas/PaginationSpec'
      - description: 'JobSchedulePagedQuerySpec


          Paged API query params for job schedule.

          '
        properties:
          filter:
            $ref: '#/components/schemas/JobScheduleApiFilter'
          sort_by:
            description: Sort fields of the records.
            enum:
            - uuid
            - name
            - enabled
            - state
            - type
            - nextStartTime
            - createdAt
            - updatedAt
            type: string
            example: uuid
        title: JobSchedulePagedQuerySpec
        type: object
        example: null
      example:
        filter:
          enabled_only: true
          next_start_window_secs: 1
          config_class: config_class
          name_regex: name_regex
          type: FIXED_DELAY
        offset: 0
        limit: 6
        sort_by: uuid
        direction: ASC
      type: object
    JobScheduleUpdateSpec:
      allOf:
      - $ref: '#/components/schemas/JobScheduleConfigSpec'
      description: 'JobScheduleUpdateSpec


        Request payload for updating schedule config of a job.

        '
      example:
        interval_secs: 0
        disabled: true
        type: FIXED_DELAY
        snooze_until: 2024-07-25 13:07:18+00:00
      title: JobScheduleUpdateSpec
      type: object
    PaginationSpec:
      description: Pagination spec in page API requests.
      properties:
        offset:
          description: Start offset of the records.
          format: int32
          type: integer
          example: 100
        limit:
          description: Maximum number of records to be fetched.
          format: int32
          type: integer
          example: 10
        direction:
          description: Sort order of the records.
          enum:
          - ASC
          - DESC
          type: string
          example: ASC
      title: PaginationSpec
      type: object
    JobConfigSpec:
      description: Job config spec for a schedule that is a part of JobScheduleSpec
      example:
        classname: classname
        config:
          key: '{}'
      properties:
        classname:
          description: Class name of the job config.
          readOnly: true
          type: string
          example: example-classname
        config:
          additionalProperties:
            type: object
          description: Additional custom configuration.
          type: object
          example: {}
      required:
      - classname
      title: JobConfigSpec
      type: object
    PaginationResp:
      description: Pagination information in page API responses.
      properties:
        has_next:
          description: There are more next records if true.
          type: boolean
          example: true
        has_prev:
          description: There are more previous records if true.
          type: boolean
          example: true
        total_count:
          description: Total number of records.
          format: int32
          type: integer
          example: 10
      title: PaginationResp
      type: object
    JobSchedule:
      description: Job schedule which contains the spec and execution info for a schedule.
      example:
        spec:
          job_config:
            classname: classname
            config:
              key: '{}'
          name: name
          schedule_config:
            interval_secs: 0
            disabled: true
            type: FIXED_DELAY
            snooze_until: 2024-07-25 13:07:18+00:00
        info:
          last_end_time: 2024-07-25 13:07:18+00:00
          updated_at: 2024-07-25 13:07:18+00:00
          execution_count: 6
          customer_uuid: 046b6c7f-0b8a-43

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-job-scheduler-api-openapi.yml
YugabyteDB Job Scheduler API

Documentation

Specifications

Other Resources

OpenAPI Specification
