Oracle Scheduled Job API

openapi: 3.2.0
info:
  description: "Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. \nFor more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).\n"
  title: OS Management Hub Scheduled Job API
  version: '20220901'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OS Management Hub API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    what: the harvested document for OS Management Hub API
servers:
- url: http://127.0.0.1/20220901
- url: https://127.0.0.1/20220901
tags:
- name: scheduledJob
paths:
  /scheduledJobs:
    get:
      description: 'Lists scheduled jobs that match the specified compartment or scheduled job [OCID](/iaas/Content/General/Concepts/identifiers.htm).

        '
      operationId: ListScheduledJobs
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/ScheduledJobLifecycleStateQueryParam'
      - $ref: '#/components/parameters/ManagedInstanceIdQueryParam'
      - $ref: '#/components/parameters/ManagedInstanceGroupIdQueryParam'
      - $ref: '#/components/parameters/ManagedCompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStageIdQueryParam'
      - $ref: '#/components/parameters/OperationTypeQueryParam'
      - $ref: '#/components/parameters/ScheduleTypeQueryParam'
      - $ref: '#/components/parameters/StartTimeOptionalQueryParam'
      - $ref: '#/components/parameters/EndTimeOptionalQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ScheduledJobSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RestrictedQueryParam'
      - $ref: '#/components/parameters/ScheduledJobIdentifierQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubTreeQueryParam'
      - $ref: '#/components/parameters/MultiLocationQueryParam'
      - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam'
      - $ref: '#/components/parameters/IsManagedByAutonomousLinuxQueryParam'
      - $ref: '#/components/parameters/DynamicSetIdQueryParam'
      responses:
        200:
          description: The list of scheduled jobs was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJobCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all scheduled jobs in a compartment
      tags:
      - scheduledJob
      x-example: 'GET /20220901/scheduledJobs?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ScheduledJob'
    post:
      description: 'Creates a new scheduled job.

        '
      operationId: CreateScheduledJob
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The scheduled job was created.
          headers:
            Location:
              description: A link to the created scheduled job.
              schema:
                type: string
                format: url
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJob'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new scheduled job.
      tags:
      - scheduledJob
      x-example: "POST /20220901/scheduledJobs\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"displayName\": \"example_scheduled_job_name\",\n  \"description\": \"string\",\n  \"scheduleType\": \"RECURRING\",\n  \"locations\": [\n    \"OCI_COMPUTE\"\n  ],\n  \"timeNextExecution\": \"2025-04-08T23:49:19.805Z\",\n  \"recurringRule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1\",\n  \"managedInstanceIds\": [\n    \"ocid1.instance.oc1..<var>&lt;unique_ID&gt;</var>\"\n  ],\n  \"isSubcompartmentIncluded\": false,\n  \"operations\": [\n    {\n      \"operationType\": \"UPDATE_ALL\",\n    }\n  ],\n  \"retryIntervals\": [\n    5, 10\n  ],\n  \"isManagedByAutonomousLinux\": false,\n}\n"
      x-related-resource: '#/definitions/ScheduledJob'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduledJobDetails'
        description: Provides the information used to create the scheduled job.
        required: true
  /scheduledJobs/{scheduledJobId}:
    delete:
      description: 'Deletes the specified scheduled job.

        '
      operationId: DeleteScheduledJob
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The scheduled job was deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel (delete) a scheduled job.
      tags:
      - scheduledJob
      x-example: 'DELETE /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ScheduledJob'
    get:
      description: 'Gets information about the specified scheduled job.

        '
      operationId: GetScheduledJob
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The scheduled job was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJob'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a scheduled job
      tags:
      - scheduledJob
      x-example: 'GET /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: 'Updates the specified scheduled job''s name, description, and other details, such as next execution and recurrence.

        '
      operationId: UpdateScheduledJob
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The scheduled job was updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJob'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the specified scheduled job.
      tags:
      - scheduledJob
      x-example: "PUT /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"new_display_name\",\n  \"description\": \"new_description\",\n  \"scheduleType\": \"ONETIME\",\n  \"timeNextExecution\": \"2025-04-09T00:00:15.766Z\",\n  \"recurringRule\": null,\n  \"operations\": [\n    {\n      \"operationType\": \"UPDATE_ALL\",\n    }\n  ],\n  \"retryIntervals\": [\n      0\n    ]\n}\n"
      x-related-resource: '#/definitions/ScheduledJob'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScheduledJobDetails'
        description: Provides the information used to update the job.
        required: true
  /scheduledJobs/{scheduledJobId}/actions/changeCompartment:
    post:
      description: Moves a scheduled job to another compartment.
      operationId: ChangeScheduledJobCompartment
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/ChangeScheduledJobCompartmentDetailsParam'
      responses:
        204:
          description: The scheduled job was successfully moved to the specified compartment.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves a resource into a different compartment.
      tags:
      - scheduledJob
      x-example: "POST /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>/actions/changeCompartment\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n    \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\"\n}\n"
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/ScheduledJob'
  /scheduledJobs/{scheduledJobId}/actions/runNow:
    post:
      description: 'Triggers an already created recurring scheduled job to run immediately instead of waiting for its next regularly

        scheduled time. This operation only applies to recurring jobs, not one-time scheduled jobs.

        '
      operationId: RunScheduledJobNow
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The scheduled job is running.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Triggers a scheduled job to execute immediately
      tags:
      - scheduledJob
      x-example: 'POST /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>/actions/runNow

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        {

        }

        '
      x-related-resource: '#/definitions/ScheduledJob'
components:
  schemas:
    SwitchSnapChannelDetails:
      description: Provides the information used to switch a snap channel.
      properties:
        channel:
          description: The channel to switch to (e.g. stable, edge, beta, candidate, or a custom channel).
          type: string
          x-default-description: 'null'
        name:
          description: The name of the snap.
          type: string
      required:
      - name
      type: object
    ModuleStreamProfileDetails:
      description: Provides the information used to update a module stream profile.
      properties:
        moduleName:
          description: The name of a module.
          type: string
        profileName:
          description: The name of a profile of the specified module stream.
          type: string
        softwareSourceId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream.

            '
          type: string
        streamName:
          description: The name of a stream of the specified module.
          type: string
      required:
      - moduleName
      - streamName
      - profileName
    ScheduledJobSummary:
      description: Provides summary information for a scheduled job.
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the scheduled job.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: User-friendly name for the scheduled job.
          maxLength: 255
          minLength: 1
          type: string
        dynamicSetIds:
          description: "The dynamic set [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on.\nA scheduled job can only operate on one type of target. therefore this parameter is mutually exclusive with \nmanagedInstanceIds, managedInstanceGroupIds, managedCompartmentIds.\n"
          items:
            type: string
          maxItems: 255
          type: array
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job.
          type: string
        isManagedByAutonomousLinux:
          description: Indicates whether this scheduled job is managed by the Autonomous Linux service.
          type: boolean
        isRestricted:
          description: "Indicates if the schedule job has restricted update and deletion capabilities. \nFor restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.\n"
          type: boolean
        lifecycleStageIds:
          description: "The lifecycle stage [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. \nA scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with \nmanagedInstanceIds, managedInstanceGroupIds, managedCompartmentIds, and dynamicSetIds.\n"
          items:
            type: string
          maxItems: 255
          type: array
        lifecycleState:
          description: The current state of the scheduled job.
          type: string
          x-obmcs-enumref: '#/definitions/ScheduledJob/lifecycleState'
        locations:
          description: The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
          items:
            $ref: '#/components/schemas/ManagedInstanceLocation'
          maxItems: 10
          type: array
        managedCompartmentIds:
          description: "The compartment [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. \nA scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with \nmanagedInstanceIds, managedInstanceGroupIds, lifecycleStageIds, and dynamicSetIds.\n"
          items:
            type: string
          maxItems: 255
          type: array
        managedInstanceGroupIds:
          description: "The managed instance group [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. \nA scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with \nmanagedInstanceIds, managedCompartmentIds, lifecycleStageIds, and dynamicSetIds.\n"
          items:
            type: string
          maxItems: 255
          type: array
        managedInstanceIds:
          description: "The managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. \nA scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with \nmanagedInstanceGroupIds, managedCompartmentIds, lifecycleStageIds, and dynamicSetIds.\n"
          items:
            type: string
          maxItems: 255
          type: array
        operations:
          description: 'The list of operations this scheduled job needs to perform.

            A scheduled job supports only one operation type, unless it is one of the following:

            * UPDATE_PACKAGES

            * UPDATE_ALL

            * UPDATE_SECURITY

            * UPDATE_BUGFIX

            * UPDATE_ENHANCEMENT

            * UPDATE_OTHER

            * UPDATE_KSPLICE_USERSPACE

            * UPDATE_KSPLICE_KERNEL

            '
          items:
            $ref: '#/components/schemas/ScheduledJobOperation'
          maxItems: 10
          type: array
        retryIntervals:
          description: "The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically \nretry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the \ninitial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits\n5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.\n"
          items:
            format: int32
            type: integer
          maxItems: 5
          type: array
        scheduleType:
          description: The type of scheduling this scheduled job follows.
          enum:
          - ONETIME
          - RECURRING
          type: string
          x-obmcs-top-level-enum: '#/definitions/ScheduleTypes'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time this scheduled job was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        timeLastExecution:
          description: The time of the last execution of this scheduled job (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).b.
          format: date-time
          type: string
        timeNextExecution:
          description: The time of the next execution of this scheduled job (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        timeUpdated:
          description: The time this scheduled job was updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        workRequestId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the work request that will be rerun.
          type: string
      required:
      - id
      - compartmentId
      - scheduleType
      - timeNextExecution
      - operations
      - lifecycleState
      - timeCreated
      - timeUpdated
      - displayName
      - freeformTags
      - definedTags
      type: object
      x-example: "{\n  \"id\": \"ocid1.osmhscheduledjob.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"displayName\": \"Apply updates to 2 instances\",\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"scheduleType\": \"RECURRING\",\n  \"locations\": [],\n  \"timeCreated\": \"2025-03-12T22:52:00.721Z\",\n  \"timeUpdated\": \"2025-04-04T22:50:16.783Z\",\n  \"timeNextExecution\": \"2025-04-11T22:52:00.000Z\",\n  \"timeLastExecution\": \"2025-04-04T22:50:16.783Z\",\n  \"managedInstanceIds\": [\n    \"ocid1.instance.oc1..<var>&lt;unique_ID&gt;</var>\",\n    \"ocid1.instance.oc1..<var>&lt;unique_ID&gt;</var>\"\n  ],\n  \"managedInstanceGroupIds\": [],\n  \"managedCompartmentIds\": [],\n  \"lifecycleStageIds\": [],\n  \"operations\": [\n    {\n      \"operationType\": \"UPDATE_ALL\",\n      \"packageNames\": [],\n      \"windowsUpdateNames\": [],\n      \"manageModuleStreamsDetails\": {\n        \"enable\": [],\n        \"disable\": [],\n        \"install\": [],\n        \"remove\": []\n      },\n      \"switchModuleStreamsDetails\": {\n        \"moduleName\": null,\n        \"streamName\": null,\n        \"softwareSourceId\": null\n      },\n      \"softwareSourceIds\": [],\n      \"rebootTimeoutInMins\": null\n    },\n    {\n      \"operationType\": \"INSTALL_ALL_WINDOWS_UPDATES\",\n      \"packageNames\": [],\n      \"windowsUpdateNames\": [],\n      \"manageModuleStreamsDetails\": {\n        \"enable\": [],\n        \"disable\": [],\n        \"install\": [],\n        \"remove\": []\n      },\n      \"switchModuleStreamsDetails\": {\n        \"moduleName\": null,\n        \"streamName\": null,\n        \"softwareSourceId\": null\n      },\n      \"softwareSourceIds\": [],\n      \"rebootTimeoutInMins\": null\n    }\n  ],\n  \"lifecycleState\": \"ACTIVE\",\n  \"isManagedByAutonomousLinux\": false,\n  \"isRestricted\": false,\n  \"retryIntervals\": [],\n  \"workRequestId\": null,\n  \"freeformTags\": {},\n  \"definedTags\": {},\n  \"systemTags\": {}\n}\n"
    Error:
      description: Provides the information for an error.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    ChangeScheduledJobCompartmentDetails:
      description: Provides the information used to move a scheduled job to another compartment.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the scheduled job to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.osmhscheduledjob.oc1..<var>&lt;unique_ID&gt;</var>\"\n}\n"
    ManageModuleStreamsInScheduledJobDetails:
      description: The set of changes to make to the state of the modules, streams, and profiles on the managed target.
      properties:
        disable:
          description: The set of module streams to disable.
          items:
            $ref: '#/components/schemas/ModuleStreamDetails'
          type: array
        enable:
          description: The set of module streams to enable.
          items:
            $ref: '#/components/schemas/ModuleStreamDetails'
          type: array
        install:
          description: The set of module stream profiles to install.
          items:
            $ref: '#/components/schemas/ModuleStreamProfileDetails'
          type: array
        remove:
          description: The set of module stream profiles to remove.
          items:
            $ref: '#/components/schemas/ModuleStreamProfileDetails'
          type: array
      type: object
      x-example: "{\n    \"manageModuleStreamsDetails\": {\n      \"enable\": [\n        {\n          \"moduleName\": \"ant\",\n          \"streamName\": \"1.10\",\n          \"softwareSourceId\": null\n        }\n      ],\n      \"disable\": [ ],\n      \"install\": [\n        {\n          \"moduleName\": \"ant\",\n          \"streamName\": \"1.10\",\n          \"profileName\": \"common\",\n          \"softwareSourceId\": null\n        }\n      ],\n      \"remove\": [ ]\n    }\n}\n"
    ScheduledJobOperation:
      description: Defines an operation that is performed by a scheduled job.
      properties:
        installSnapDetails:
          $ref: '#/components/schemas/InstallSnapDetails'
        manageModuleStreamsDetails:
          $ref: '#/components/schemas/ManageModuleStreamsInScheduledJobDetails'
        operationType:
          description: The type of operation this scheduled job performs.
          enum:
          - INSTALL_PACKAGES
          - UPDATE_PACKAGES
          - REMOVE_PACKAGES
          - UPDATE_ALL
          - UPDATE_SECURITY
          - UPDATE_BUGFIX
          - UPDATE_ENHANCEMENT
          - UPDATE_OTHER
          - UPDATE_KSPLICE_USERSPACE
          - UPDATE_KSPLICE_KERNEL
          - MANAGE_MODULE_STREAMS
          - SWITCH_MODULE_STREAM
          - ATTACH_SOFTWARE_SOURCES
          - DETACH_SOFTWARE_SOURCES
          - SYNC_MANAGEMENT_STATION_MIRROR
          - PROMOTE_LIFECYCLE
          - INSTALL_WINDOWS_UPDATES
          - INSTALL_ALL_WINDOWS_UPDATES
          - INSTALL_SECURITY_WINDOWS_UPDATES
          - INSTALL_BUGFIX_WINDOWS_UPDATES
          - INSTALL_ENHANCEMENT_WINDOWS_UPDATES
          - INSTALL_OTHER_WINDOWS_UPDATES
          - REBOOT
          - RERUN_WORK_REQUEST
          - INSTALL_SNAPS
          - REMOVE_SNAPS
          - SWITCH_SNAP_CHANNEL
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationTypes'
        packageNames:
          description: The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages.
          items:
            type: string
          maxItems: 255
          type: array
        rebootTimeoutInMins:
          description: "The number of minutes the service waits for the reboot to complete. If the instance doesn't reboot within the \ntimeout, the service marks the reboot job as failed.\n"
          maximum: 240
          minimum: 5
          type: integer
          x-default-description: When operationType is REBOOT, and this field will be set to a default value of 20 if not specified.
        removeSnapDetails:
          $ref: '#/

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-scheduledjob-api-openapi.yml