Oracle Database Scheduler API

Oracle Scheduler job management

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

oracle-database-scheduler-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Oracle Database Oracle Cloud Infrastructure Database APEX Scheduler API
  description: API for managing Oracle Database services in Oracle Cloud Infrastructure (OCI). Provides management of DB Systems, Autonomous Databases, Exadata infrastructure, database backups, Data Guard associations, database homes, and related cloud database resources.
  version: '20160918'
  contact:
    name: Oracle Cloud Support
    url: https://support.oracle.com
    email: cloud-support@oracle.com
  license:
    name: Oracle Cloud Infrastructure Terms
    url: https://www.oracle.com/cloud/free/oci-terms.html
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: https://database.{region}.oraclecloud.com/20160918
  description: OCI Database Service Regional Endpoint
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
      enum:
      - us-ashburn-1
      - us-phoenix-1
      - eu-frankfurt-1
      - uk-london-1
      - ap-tokyo-1
      - ap-mumbai-1
      - ca-toronto-1
      - ap-sydney-1
      - sa-saopaulo-1
      - ap-seoul-1
security:
- ociSignature: []
tags:
- name: Scheduler
  description: Oracle Scheduler job management
paths:
  /database/scheduler/jobs/:
    get:
      operationId: getSchedulerJobs
      summary: Oracle Database Get all scheduler jobs
      description: Returns a list of all Oracle Scheduler jobs.
      tags:
      - Scheduler
      responses:
        '200':
          description: Scheduler jobs retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchedulerJobList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/scheduler/jobs/{owner},{job_name}:
    get:
      operationId: getSchedulerJob
      summary: Oracle Database Get a specific scheduler job
      description: Returns details about a specific Oracle Scheduler job.
      tags:
      - Scheduler
      parameters:
      - name: owner
        in: path
        required: true
        schema:
          type: string
      - name: job_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Scheduler job details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchedulerJob'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    SchedulerJob:
      type: object
      properties:
        owner:
          type: string
        job_name:
          type: string
        job_type:
          type: string
        state:
          type: string
        enabled:
          type: boolean
        next_run_date:
          type: string
          format: date-time
        last_start_date:
          type: string
          format: date-time
        repeat_interval:
          type: string
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        type:
          type: string
    SchedulerJobList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SchedulerJob'
  responses:
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys
externalDocs:
  description: OCI Database Service API Documentation
  url: https://docs.oracle.com/iaas/api/#/en/database/20160918/