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 Managed Instance 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: managedInstance paths: /managedInstances: get: description: Lists managed instances that match the specified compartment or managed instance OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS version. operationId: ListManagedInstances parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/ManagedInstanceIdQueryParam' - $ref: '#/components/parameters/MultiManagedInstanceStatusQueryParam' - $ref: '#/components/parameters/MultiArchTypeQueryParam' - $ref: '#/components/parameters/MultiOsFamilyQueryParam' - $ref: '#/components/parameters/ManagementStationQueryParam' - $ref: '#/components/parameters/GroupQueryParam' - $ref: '#/components/parameters/GroupNotEqualToQueryParam' - $ref: '#/components/parameters/LifecycleStageQueryParam' - $ref: '#/components/parameters/LifecycleStageNotEqualToQueryParam' - $ref: '#/components/parameters/GroupOrLifecycleQueryParam' - $ref: '#/components/parameters/SoftwareSourceIdQueryParam' - $ref: '#/components/parameters/AdvisoryNameQueryParam' - $ref: '#/components/parameters/LifeCycleEnvironmentQueryParam' - $ref: '#/components/parameters/LifeCycleEnvironmentNotEqualToQueryParam' - $ref: '#/components/parameters/MultiLocationQueryParam' - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam' - $ref: '#/components/parameters/MultiProfileQueryParam' - $ref: '#/components/parameters/MultiProfileNotEqualToQueryParam' - $ref: '#/components/parameters/ProfileQueryParam' - $ref: '#/components/parameters/IsManagedByAutonomousLinuxQueryParam' - $ref: '#/components/parameters/AgentVersionQueryParam' - $ref: '#/components/parameters/MultiManagementStationQueryParam' - $ref: '#/components/parameters/MultiManagementStationNotEqualToQueryParam' - $ref: '#/components/parameters/RebootRequiredQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of managed instances 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 opc-total-items: description: 'The total number of items in the result. Used for pagination of a list of items. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceCollection' 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 allmanaged instances in a compartment tags: - managedInstance x-example: 'GET 20220901/managedInstances?compartmentId=<compartment_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/actions/installWindowsUpdates: post: description: 'Installs all of the available Windows updates for managed instances in a compartment. This applies only to standalone Windows instances. This will not update instances that belong to a group. ' operationId: InstallAllWindowsUpdatesOnManagedInstancesInCompartment parameters: - $ref: '#/components/parameters/InstallAllWindowsUpdatesOnManagedInstancesInCompartmentDetailsParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The packages will be updated on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Installs all Windows Updates on managed instances in a compartment tags: - managedInstance x-example: "POST 20220901/managedInstances/actions/installWindowsUpdates\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/actions/updatePackages: post: description: 'Install all of the available package updates for all of the managed instances in a compartment. This applies only to standalone non-Windows instances. This will not update instances that belong to a group or lifecycle environment. ' operationId: UpdateAllPackagesOnManagedInstancesInCompartment parameters: - $ref: '#/components/parameters/UpdateAllPackagesOnManagedInstancesInCompartmentDetailsParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The packages will be updated on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Update all packages on managed instances in a compartment tags: - managedInstance x-example: "POST 20220901/managedInstances/actions/updatePackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}: delete: description: "Unregisters the specified managed instance from the service. Once unregistered, the service will no longer manage the instance. \nFor Linux instances, yum or DNF repository files will be restored to their state prior to registration.\n" operationId: DeleteManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The managed instance will be deleted (unregistered). 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Delete (unregister) a provisioned Managed Instance tags: - managedInstance x-example: 'DELETE 20220901/managedInstances/<resource_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> If-Match: "" ' x-related-resource: '#/definitions/ManagedInstance' get: description: Gets information about the specified managed instance. operationId: GetManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The managed instance 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/ManagedInstance' 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: Get ManagedInstance tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' put: description: 'Updates the specified managed instance information, such as description, ONS topic, and associated management station. ' operationId: UpdateManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/UpdateManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The managed instance 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/ManagedInstance' 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 managed instance identified by the id tags: - managedInstance x-example: "PUT 20220901/managedInstances/<resource_OCID>\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"displayName\": \"<updated_display_name>\"\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/attachProfile: post: description: 'Adds profile to a managed instance. After the profile has been added, the instance can be registered as a managed instance. ' operationId: AttachProfileToManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/AttachProfileToManagedInstanceParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Accepted the request. The profile was added to the managed instance. 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: Add a profile to a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/attachProfile\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"profileId\": [\"<managed_instance_profile_ocid>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/attachSoftwareSources: post: description: 'Adds software sources to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance. ' operationId: AttachSoftwareSourcesToManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/AttachSoftwareSourcesToManagedInstanceParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The software sources were added to the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Add a software source to a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/attachSoftwareSources\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"softwareSources\": [\"<software_source_OCID>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/detachProfile: post: description: 'Detaches profile from a managed instance. After the profile has been removed, the instance cannot be registered as a managed instance. ' operationId: DetachProfileFromManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Accepted the request. The profile was detached from the managed instance. 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: Detach a profile from a managed instance tags: - managedInstance x-example: 'POST 20220901/managedInstances/<resource_OCID>/actions/detachProfile Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> If-Match: "" ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/detachSoftwareSources: post: description: 'Removes software sources from a managed instance. Packages will no longer be able to be installed from these software sources. ' operationId: DetachSoftwareSourcesFromManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/DetachSoftwareSourcesFromManagedInstanceParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The software sources were removed from the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Removes software sources from a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/detachSoftwareSources\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"softwareSources\": [\"<software_source_OCID>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/disableModuleStreams: post: description: 'Disables a module stream on a managed instance. After the stream is disabled, it is no longer possible to install the profiles that are contained by the stream. All installed profiles must be removed prior to disabling a module stream. ' operationId: DisableModuleStreamOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/DisableModuleStreamOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The module stream will be disabled on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Disable a specific module stream on a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/disableModuleStreams\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"moduleName\": \"<module_name>\"\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/enableModuleStreams: post: description: 'Enables a module stream on a managed instance. After the stream is enabled, it is possible to install the profiles that are contained by the stream. Enabling a stream that is already enabled will succeed. Attempting to enable a different stream for a module that already has a stream enabled results in an error. ' operationId: EnableModuleStreamOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/EnableModuleStreamOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The module stream will be enabled on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Enable a specific module stream on a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/enableModuleStreams\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"moduleName\": \"<module_name>\"\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/installPackages: post: description: 'Installs packages on a managed instance. ' operationId: InstallPackagesOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/InstallPackagesOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The package will be installed on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Install packages on a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/installPackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"packageNames\": [\"<package_name>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/installSnaps: post: description: Installs specified snaps on a managed instance. operationId: InstallSnapsOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/InstallSnapsOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The snap will be installed on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Installs snaps on a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/installSnaps\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"snapNames\": [\"<snap_name>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/installStreamProfiles: post: description: 'Installs a profile for an module stream. The stream must be enabled before a profile can be installed. If a module stream defines multiple profiles, each one can be installed independently. ' operationId: InstallModuleStreamProfileOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/InstallModuleStreamProfileOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The module stream profile will be installed on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Installs a profile for an enabled module stream tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/installStreamProfiles\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"moduleName\": \"<module_name>\",\n \"streamName\": \"<stream_name>\",\n \"profileName\": \"<profile_name>\"\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/installWindowsUpdates: post: description: 'Installs Windows updates on the specified managed instance. ' operationId: InstallWindowsUpdatesOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/InstallWindowsUpdatesOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Windows updates will be installed on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Install Windows update(s) on a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/installWindowsUpdates\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"windowsUpdateName\": [\"<windows_update_name>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/manageModuleStreams: post: description: "Enables or disables module streams and installs or removes module stream profiles. Once complete, the state of the modules, streams, and \nprofiles will match the state indicated in the operation. See [ManageModuleStreamsOnManagedInstanceDetails](#/en/osmh/latest/datatypes/ManageModuleStreamsOnManagedInstanceDetails) \nfor more information. You can preform this operation as a dry run. For a dry run, the service evaluates the operation against the \ncurrent module, stream, and profile state on the managed instance, but does not commit the changes. Instead, the service returns work request log or error entries indicating the impact of the operation.\n" operationId: ManageModuleStreamsOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/ManageModuleStreamsOnManagedInstanceParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The operation will be processed. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Perform an operation involving modules, streams, and profiles on a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/manageModuleStreams\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"enable\": [\n {\n \"moduleName\": \"<module_name>\",\n \"streamName\": \"<stream_name>\"\n }\n ],\n \"disable\": [\n {\n \"moduleName\": \"<module_name>\",\n \"streamName\": \"<stream_name>\"\n }\n ],\n \"install\": [\n {\n \"moduleName\": \"<module_name>\",\n \"streamName\": \"<stream_name>\",\n \"profileName\": \"<profile_name>\"\n }\n ],\n \"remove\": [\n {\n \"moduleName\": \"<module_name>\",\n \"streamName\": \"<stream_name>\",\n \"profileName\": \"<profile_name>\"\n }\n ]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/reboot: post: description: "Initiates a reboot of the specified managed instance. You can also specify the number of minutes the service \nwaits before marking the reboot operation as failed.\n" operationId: RebootManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/RebootManagedInstanceParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. A work request to reboot the managed instance is created. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Reboots a managed instance tags: - managedInstance x-example: 'POST 20220901/managedInstances/<resource_OCID>/actions/reboot Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> If-Match: "" { } ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/refreshSoftware: post: description: 'Refreshes the package or Windows update information on a managed instance with the latest data from the software source. This does not update packages on the instance. It provides the service with the latest package data. ' operationId: RefreshSoftwareOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The software package data on the managed instance will be refreshed. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Refresh the software information tags: - managedInstance x-example: 'POST 20220901/managedInstances/<resource_OCID>/actions/refreshSoftware Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> If-Match: "" ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/removePackages: post: description: 'Removes an installed package from a managed instance. ' operationId: RemovePackagesFromManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/RemovePackagesFromManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The package will be removed from the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Removes a package from a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/removePackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"packageNames\": [\"<package_name>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/removeSnaps: post: description: Removes specified snaps from a managed instance. operationId: RemoveSnapsFromManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/RemoveSnapsFromManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The snap will be removed from the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Remove snaps from a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/removeSnaps\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"snapNames\": [\"<snap_name>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/removeStreamProfiles: post: description: 'Removes a profile for a module stream that is installed on a managed instance. If a module stream is provided, rather than a fully qualified profile, all profiles that have been installed for the module stream will be removed. ' operationId: RemoveModuleStreamProfileFromManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/RemoveModuleStreamProfileFromManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The module stream profile or profiles will be removed from the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Removes an installed profile for a module stream from a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/removeStreamProfiles\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"moduleName\": \"<module_name>\",\n \"streamName\": \"<stream_name>\",\n \"profileName\": \"<profile_name>\"\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/switchModuleStreams: post: description: 'Enables a new stream for a module that already has a stream enabled. If any profiles or packages from the original module are installed, switching to a new stream will remove the existing packages and install their counterparts in the new stream. ' operationId: SwitchModuleStreamOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/SwitchModuleStreamOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The module stream will be disabled on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Changes the enabled stream for a module tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/switchModuleStreams\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"moduleName\": \"<module_name>\",\n \"streamName\": \"<stream_name>\",\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/switchSnapChannel: post: description: Switches the snap channel on a managed instance. operationId: SwitchSnapChannelOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/SwitchSnapChannelOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The snap channel will be switched on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Switch snap channel on a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/switchSnapChannel\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"snapName\": \"\",\n \"channel\": \"\"\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/actions/updatePackages: post: description: 'Updates a package on a managed instance. ' operationId: UpdatePackagesOnManagedInstance parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/UpdatePackagesOnManagedInstanceDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The package will be updated on the managed instance. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Update a package on a managed instance tags: - managedInstance x-example: "POST 20220901/managedInstances/<resource_OCID>/actions/updatePackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"packageNames\": [\"<package_name>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/availablePackages: get: description: 'Returns a list of packages that are available for installation on a managed instance. ' operationId: ListManagedInstanceAvailablePackages parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AvailablePackagePaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of installed package objects. 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/AvailablePackageCollection' 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: Lists all packages that are available for installation on a managed instance. tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/availablePackages Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/availableSoftwareSources: get: description: 'Returns a list of software sources that can be attached to the specified managed instance. Any software sources already attached to the instance are not included in the list. ' operationId: ListManagedInstanceAvailableSoftwareSources parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of available software source objects. 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/AvailableSoftwareSourceCollection' 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 software sources available for the Managed Instance. These only include software sources that are not already added to the managed instance, but can be added. tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/availableSoftwareSources Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/availableWindowsUpdates: get: description: 'Returns a list of Windows updates that can be installed on the specified managed instance. ' operationId: ListManagedInstanceAvailableWindowsUpdates parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/MultiClassificationTypeQueryParam' - $ref: '#/components/parameters/MultiWindowsUpdateIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/IsInstallableQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WindowsUpdateSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of available updates 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/AvailableWindowsUpdateCollection' 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 Windows updates available for the Managed Instance tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/availableWindowsUpdates Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/errata: get: description: 'Returns a list of applicable errata on the managed instance. ' operationId: ListManagedInstanceErrata parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/MultiClassificationTypeQueryParam' - $ref: '#/components/parameters/ErratumNameQueryParam' - $ref: '#/components/parameters/ErratumNameContainsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ErrataSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of installed package objects. 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/ManagedInstanceErratumSummaryCollection' 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 applicable errata on the managed instance tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/errata Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/installedPackages: get: description: 'Lists the packages that are installed on the managed instance. ' operationId: ListManagedInstanceInstalledPackages parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/StartInstallDateQueryParam' - $ref: '#/components/parameters/EndInstallDateQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/InstalledPackageSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of packages installed on the managed instance 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/InstalledPackageCollection' 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 packages installed on the managed instance tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/installedPackages Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/installedWindowsUpdates: get: description: 'Returns a list of Windows updates that have been installed on the specified managed instance. ' operationId: ListManagedInstanceInstalledWindowsUpdates parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/MultiWindowsUpdateIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WindowsUpdateSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of updates 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/InstalledWindowsUpdateCollection' 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 Windows updates that are installed on the Managed Instance tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/installedWindowsUpdates Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/modules: get: description: 'Retrieves a list of modules, along with streams of the modules, from a managed instance. Filters may be applied to select a subset of modules based on the filter criteria. ' operationId: ListManagedInstanceModules parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameParam' - $ref: '#/components/parameters/NameContainsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NameSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of module stream summary objects. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceModuleCollection' 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: Retrieve a list of modules from a managed instance. tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/modules Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/snaps: get: description: 'Retrieves a list of snaps for a managed instance. Filters may be applied to select a subset of snaps based on the filter criteria. ' operationId: ListManagedInstanceSnaps parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameParam' - $ref: '#/components/parameters/NameContainsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NameSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of snap summary objects. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SnapCollection' 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: Retrieve a list of snaps from a managed instance. tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/snaps Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managedInstances/{managedInstanceId}/updatablePackages: get: description: 'Returns a list of updatable packages for a managed instance. ' operationId: ListManagedInstanceUpdatablePackages parameters: - $ref: '#/components/parameters/ManagedInstanceIdPathParam' - $ref: '#/components/parameters/MultiClassificationTypeQueryParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/AdvisoryNameQueryParam' - $ref: '#/components/parameters/AdvisorySeverityQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of installed package objects. 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/UpdatablePackageCollection' 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 updatable packages on a managed instance tags: - managedInstance x-example: 'GET 20220901/managedInstances/<resource_OCID>/updatablePackages Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstance' /managementStations/{managementStationId}/actions/associateManagedInstances: post: description: 'Associates managed instances to the specified management station ' operationId: AssociateManagedInstancesWithManagementStation parameters: - $ref: '#/components/parameters/ManagementStationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The managed instances are being associated to the management station. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' 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: Associates managed instances to a management station tags: - managedInstance x-example: "POST 20220901/managementStations/<resource_OCID>/actions/associateManagedInstances\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"managedInstances\": [\"<managed_instance_OCID>\"]\n}\n" x-related-resource: '#/definitions/ManagedInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/AssociateManagedInstancesWithManagementStationDetails' description: The managed instances [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to associate to the management station. required: true /windowsUpdates: get: description: 'Lists Windows updates that have been reported to the service. ' operationId: ListWindowsUpdates parameters: - $ref: '#/components/parameters/MultiClassificationTypeQueryParam' - $ref: '#/components/parameters/MultiWindowsUpdateIdQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WindowsUpdateSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of updates 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/WindowsUpdateCollection' 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 Windows Updates tags: - managedInstance x-example: 'GET 20220901/windowsUpdates?compartmentId=<compartment_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' /windowsUpdates/{windowsUpdateId}: get: description: 'Returns a Windows Update object. ' operationId: GetWindowsUpdate parameters: - $ref: '#/components/parameters/WindowsUpdateIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The update information was retrieved. 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 content: application/json: schema: $ref: '#/components/schemas/WindowsUpdate' 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 information about the specified Windows update. tags: - managedInstance x-example: 'GET 20220901/windowsUpdates/<windows_update_id> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' 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 SnapCollection: description: "The set of snaps returned for the \n[ListManagedInstanceSnaps](#/en/osmh/latest/ManagedInstance/ListManagedInstanceSnaps) operation.\n" properties: items: description: The list of snaps. items: $ref: '#/components/schemas/SnapSummary' type: array required: - items type: object 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 PackageSummary: description: Provides summary information for a software package. discriminator: propertyName: packageClassification properties: architecture: description: The architecture for which this package was built. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' displayName: description: Package name. type: string name: description: Unique identifier for the package. type: string packageClassification: description: Status of the software package. enum: - INSTALLED - AVAILABLE - UPDATABLE type: string softwareSources: description: List of software sources that provide the software package. items: $ref: '#/components/schemas/SoftwareSourceDetails' type: array type: description: Type of the package. type: string version: description: Version of the installed package. type: string required: - displayName - type - version - name - packageClassification ManagedInstanceSummary: description: Provides summary information for a managed instance. properties: agentVersion: description: The version of osmh-agent running on the managed instance type: string architecture: description: The CPU architecture type of the managed instance. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' autonomousSettings: $ref: '#/components/schemas/AutonomousSettings' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the managed instance. ' type: string description: description: User-specified description of the managed instance. type: string displayName: description: User-friendly name for the managed instance. type: string id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. ' type: string isManagedByAutonomousLinux: description: Indicates whether Autonomous Linux manages this instance. type: boolean isManagementStation: description: Whether this managed instance is acting as an on-premises management station. type: boolean isRebootRequired: description: Indicates whether a reboot is required to complete installation of updates. type: boolean lifecycleEnvironment: $ref: '#/components/schemas/Id' lifecycleStage: $ref: '#/components/schemas/Id' location: description: The location of the managed instance. enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' managedInstanceGroup: $ref: '#/components/schemas/Id' notificationTopicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. ' type: string osFamily: description: The operating system type of the managed instance. enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' status: description: Current status of the managed instance. enum: - NORMAL - UNREACHABLE - ERROR - WARNING - REGISTRATION_ERROR - DELETING - ONBOARDING - REBOOTING type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceStatus' tenancyId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy this managed instance resides in. ' type: string timeLastBoot: description: 'Time that the instance last booted (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string updatesAvailable: description: Number of updates available for installation. type: integer required: - id - displayName - tenancyId - compartmentId - status type: object AvailableSoftwareSourceSummary: description: "Provides summary information about an available software source. \nAn available software source can be added to a managed instance. \nAfter a software source is added, packages from that software source can be installed on that managed instance.\n" properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source. type: string description: description: Software source description. type: string displayName: description: User-friendly name for the software source. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. type: string softwareSourceType: description: Type of the software source. enum: - VENDOR - CUSTOM - VERSIONED - PRIVATE - THIRD_PARTY type: string x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType' required: - displayName - id - compartmentId - softwareSourceType type: object InstallPackagesOnManagedInstanceDetails: allOf: - $ref: '#/components/schemas/SoftwarePackagesDetails' description: Provides the information used to install software packages on a managed instance. type: object SoftwarePackagesDetails: description: Provides the information used to install, remove, or update software packages. properties: packageNames: description: The list of package names. items: type: string maxItems: 255 type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - packageNames type: object AttachSoftwareSourcesToManagedInstanceDetails: allOf: - $ref: '#/components/schemas/SoftwareSourcesDetails' description: Provides the information used to attach software sources to a managed instance. type: object RemoveSnapDetails: description: Provides the information used to remove a snap. properties: name: description: 'The name of the snap to remove. ' type: string revision: description: 'The revision to remove. Note: This option cannot be used when removing multiple snaps. ' type: string x-default-description: 'null' required: - name type: object SwitchSnapChannelOnManagedInstanceDetails: description: Provides the information used to switch snap channel a managed instance. - snapDetails properties: snapDetails: $ref: '#/components/schemas/SwitchSnapChannelDetails' workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object SoftwareSourceDetails: description: Provides identifying information for the specified software source. properties: description: description: Software source description. type: string displayName: description: Software source name. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. type: string isMandatoryForAutonomousLinux: description: Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. type: boolean softwareSourceType: description: Type of the software source. enum: - VENDOR - CUSTOM - VERSIONED - PRIVATE - THIRD_PARTY type: string x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType' required: - id type: object ManagedInstanceErratumSummary: description: Provides summary information about an erratum associated with a managed instance. properties: advisoryType: description: The advisory type of the erratum. enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER type: string x-obmcs-top-level-enum: '#/definitions/ClassificationTypes' name: description: The identifier of the erratum. type: string packages: description: The list of packages affected by this erratum. items: $ref: '#/components/schemas/PackageNameSummary' type: array relatedCves: description: The list of CVEs applicable to this erratum. items: type: string type: array synopsis: description: A summary description of the erratum. type: string timeIssued: description: 'The date and time the package was issued by a providing erratum (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string required: - name - advisoryType - packages type: object ManagedInstanceCollection: description: 'The set of managed instances returned for the [ListManagedInstances](#/en/osmh/latest/ManagedInstance/ListManagedInstances) operation. ' properties: items: description: List of managed instances. items: $ref: '#/components/schemas/ManagedInstanceSummary' type: array required: - items type: object InstallSnapsOnManagedInstanceDetails: description: Provides the information used to install snaps to a managed instance. - snapDetails properties: snapDetails: description: The array of snaps to install. items: $ref: '#/components/schemas/InstallSnapDetails' type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object InstallSnapDetails: description: Provides the information used to install a snap. properties: channel: description: 'The snap channel to install from (e.g. stable, 1.2/edge, beta, candidate, or a custom channel). ' type: string x-default-description: 'null' isSigned: default: true description: 'If false, allows installing snaps not signed by the Snap Store. E.g., snaps from local file. Use with caution. ' type: boolean mode: default: DEFAULT description: 'The confinement mode for the snap. ' enum: - DEFAULT - CLASSIC - JAIL_MODE - DEV_MODE type: string x-obmcs-top-level-enum: '#/definitions/SnapModes' name: description: 'The name of the snap to install. ' type: string revision: description: 'The snap revision to install. ' type: string x-default-description: 'null' required: - name type: object AttachProfileToManagedInstanceDetails: description: Provides the information used to set a profile for a managed instance. properties: profileId: description: The profile [OCID](/iaas/Content/General/Concepts/identifiers.htm) to attach to the managed instance. type: string required: - profileId type: object ManagedInstanceModuleCollection: description: 'The set of modules returned for the [ListManagedInstanceModules](#/en/osmh/latest/ManagedInstance/ListManagedInstanceModules) operation. ' properties: items: description: List of module streams. items: $ref: '#/components/schemas/ManagedInstanceModuleSummary' type: array required: - items type: object InstallModuleStreamProfileOnManagedInstanceDetails: allOf: - $ref: '#/components/schemas/ModuleStreamProfileDetailsBody' description: Provides the information used to install a module stream profile on a managed instance. type: object SnapSummary: description: Provides summary information for a snap. properties: description: description: The description of of snap. type: string name: description: The name of the snap. type: string publisher: description: The publisher of the snap. type: string revision: description: The revision number of the snap channel. type: string storeUrl: description: The snap's store url. type: string timeRefreshed: description: The date and time of the snap's last refresh in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format. format: date-time type: string tracking: description: The track this snap is following. type: string version: description: The version of the snap. type: string required: - name - version - revision - publisher - tracking type: object WorkRequestDetails: description: Provides the name and description of the job. properties: description: description: User-specified information about the job. Avoid entering confidential information. maxLength: 400 minLength: 0 type: string displayName: description: A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string type: object AvailableSoftwareSourceCollection: description: "The set of available software sources returned for the [ListManagedInstanceAvailableSoftwareSources](#/en/osmh/latest/ManagedInstance/ListManagedInstanceAvailableSoftwareSources) or the \n[ListManagedInstanceGroupAvailableSoftwareSources](#/en/osmh/latest/ManagedInstanceGroup/ListManagedInstanceGroupAvailableSoftwareSources) operation.\n" properties: items: description: List of available software sources. items: $ref: '#/components/schemas/AvailableSoftwareSourceSummary' type: array required: - items type: object DetachSoftwareSourcesFromManagedInstanceDetails: allOf: - $ref: '#/components/schemas/SoftwareSourcesDetails' description: Provides the information used to detach the software sources from the managed instance. type: object EnableModuleStreamOnManagedInstanceDetails: allOf: - $ref: '#/components/schemas/ModuleStreamDetailsBody' description: Provides the information used to enable a module stream on a managed instance. type: object RemoveSnapsFromManagedInstanceDetails: description: Provides the information used to install snaps from a managed instance. properties: snapDetails: description: The array of snaps to remove. items: $ref: '#/components/schemas/RemoveSnapDetails' type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - snapDetails type: object UpdatePackagesOnManagedInstanceDetails: description: Provides the information used to update software packages on a managed instance. properties: packageNames: description: The list of package names. items: type: string type: array updateTypes: description: The types of updates to be applied. items: enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER - KSPLICE_KERNEL - KSPLICE_USERSPACE - ALL type: string x-obmcs-top-level-enum: '#/definitions/UpdateTypes' type: array uniqueItems: true workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object UpdateManagedInstanceDetails: description: Provides the information used to update a managed instance. properties: autonomousSettings: $ref: '#/components/schemas/UpdatableAutonomousSettings' description: description: User-specified description of the managed instance. Avoid entering confidential information. type: string notificationTopicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. ' type: string primaryManagementStationId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station for the instance to use as primary management station. ' type: string secondaryManagementStationId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station for the instance to use as secondary management station. ' type: string type: object SwitchModuleStreamOnManagedInstanceDetails: allOf: - $ref: '#/components/schemas/ModuleStreamDetails' - properties: workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object description: Provides the information used to switch module streams on a managed instance. type: object AutonomousSettings: description: Settings for the Autonomous Linux service. properties: isDataCollectionAuthorized: description: Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user. type: boolean scheduledJobId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. type: string type: object ManagedInstanceModuleSummary: description: Provides summary information for a module on a managed instance. properties: activeStreams: description: List of streams that are active in the module. items: maxItems: 50 type: string type: array disabledStreams: description: List of streams that are disabled in the module. items: maxItems: 50 type: string type: array enabledStream: description: 'The stream that is enabled in the module. ' type: string installedProfiles: description: List of installed profiles in the enabled stream of the module. items: maxItems: 50 type: string type: array name: description: 'The module name. ' type: string softwareSourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides this module and the associated streams. ' type: string required: - name type: object InstallWindowsUpdatesOnManagedInstanceDetails: description: Provides the information used to install Windows updates on a managed instance. properties: windowsUpdateName: description: "The list of Windows update unique identifiers. \nNote that this is not an OCID, but is a unique identifier assigned by Microsoft.\nExample: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'\n" items: maxLength: 255 minLength: 1 type: string type: array windowsUpdateTypes: description: The types of Windows updates to be installed. items: enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER - ALL type: string x-obmcs-top-level-enum: '#/definitions/WindowsUpdateTypes' maxItems: 20 type: array uniqueItems: true workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object AvailablePackageCollection: description: The set of packages returned for the [ListManagedInstanceAvailablePackages](#/en/osmh/latest/ManagedInstance/ListManagedInstanceAvailablePackages) operation. properties: items: description: List of available packages. items: $ref: '#/components/schemas/AvailablePackageSummary' type: array required: - items type: object RebootManagedInstanceDetails: description: Provides the information used for the reboot job. properties: rebootTimeoutInMins: default: 20 description: "The number of minutes the service waits for the reboot to complete. If the instance doesn't reboot within this \ntime, the reboot job status is set to failed.\n" maximum: 240 minimum: 5 type: integer workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object RemovePackagesFromManagedInstanceDetails: allOf: - $ref: '#/components/schemas/SoftwarePackagesDetails' description: Provides the information used to remove software packages from a managed instance. type: object InstalledWindowsUpdateCollection: description: 'The set of installed Windows updates returned for the [ListManagedInstanceInstalledWindowsUpdates](#/en/osmh/latest/ManagedInstance/ListManagedInstanceInstalledWindowsUpdates) operation. ' properties: items: description: List of installed Windows updates. items: $ref: '#/components/schemas/InstalledWindowsUpdateSummary' type: array required: - items type: object AvailablePackageSummary: allOf: - $ref: '#/components/schemas/PackageSummary' - discriminator: AVAILABLE description: Provides summary information about a software package available for installation on a managed instance. WindowsUpdateCollection: description: "A set of Windows updates returned for the [ListWindowsUpdates](#/en/osmh/latest/WindowsUpdateCollection/ListWindowsUpdates) operation. \nThe list contains a summary of each update.\n" properties: items: description: List of Windows updates. items: $ref: '#/components/schemas/WindowsUpdateSummary' type: array required: - items type: object AssociateManagedInstancesWithManagementStationDetails: description: Provides the information used to associate managed instances to a management station. properties: managedInstances: description: List of managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to associate to the management station. items: type: string maxItems: 100 minItems: 1 type: array uniqueItems: true workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - managedInstances ModuleStreamProfileDetailsBody: description: Provides the information used to install or remove a module stream profile on a managed instance. properties: moduleName: description: The name of a module. type: string profileName: description: The name of a profile of the specified module stream. type: string streamName: description: The name of a stream of the specified module. type: string workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - moduleName type: object InstallationRequirements: description: Indicates requirements for installing updates on a managed instance. enum: - EULA_ACCEPTANCE_REQUIRED - SOFTWARE_MEDIA_REQUIRED - USER_INTERACTION_REQUIRED type: string InstalledPackageCollection: description: The set of installed packages on a managed instance. properties: items: description: List of installed packages. items: $ref: '#/components/schemas/InstalledPackageSummary' type: array required: - items type: object UpdateAllPackagesOnManagedInstancesInCompartmentDetails: description: 'Provides the information used to update all packages of a specified type on managed instances within the specified compartment. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string updateTypes: description: The types of updates to be applied. items: enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER - KSPLICE_KERNEL - KSPLICE_USERSPACE - ALL type: string x-obmcs-top-level-enum: '#/definitions/UpdateTypes' maxItems: 20 type: array uniqueItems: true workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - compartmentId type: object UpdatableAutonomousSettings: description: Updatable settings for the Autonomous Linux service. This is required when creating an Autonomous Linux Managed Instance Group. Do not include it when creating a standard (non-Autonomous) Managed Instance Group. properties: isDataCollectionAuthorized: description: Indicates whether Autonomous Linux will collect crash files. type: boolean type: object InstallAllWindowsUpdatesOnManagedInstancesInCompartmentDetails: description: 'Provides the information used to install all Windows updates of a specified type on managed instances within the specified compartment. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string windowsUpdateTypes: description: The types of Windows updates to be installed. items: enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER - ALL type: string x-obmcs-top-level-enum: '#/definitions/WindowsUpdateTypes' maxItems: 20 type: array uniqueItems: true workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - compartmentId type: object UpdatablePackageCollection: description: The set of packages returned for the [ListManagedInstanceUpdatablePackages](#/en/osmh/latest/ManagedInstance/ListManagedInstanceUpdatablePackages) operation. properties: items: description: List of updatable packages. items: $ref: '#/components/schemas/UpdatablePackageSummary' type: array required: - items type: object ManagedInstanceErratumSummaryCollection: description: 'The set of errata returned for the [ListManagedInstanceErrata](#/en/osmh/20220901/ManagedInstance/ListManagedInstanceErrata) operation. ' properties: items: description: List of errata. items: $ref: '#/components/schemas/ManagedInstanceErratumSummary' type: array required: - items type: object WindowsUpdateSummary: description: Provides summary information about an update for a Windows instance. properties: installable: description: Indicates whether the update can be installed using the service. type: string x-obmcs-enumref: '#/definitions/WindowsUpdate/installable' isRebootRequiredForInstallation: description: Indicates whether a reboot is required to complete the installation of this update. type: boolean name: description: Name of the Windows update. type: string updateId: description: "Unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. \nExample: 6981d463-cd91-4a26-b7c4-ea4ded9183ed\n" type: string updateType: description: The type of Windows update. enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER type: string x-obmcs-top-level-enum: '#/definitions/ClassificationTypes' required: - name - updateType - updateId type: object UpdatablePackageSummary: allOf: - $ref: '#/components/schemas/PackageSummary' - discriminator: propertyName: UPDATABLE properties: advisorySeverity: description: The severity level of the security update. Only applicable when updateType is SECURITY. enum: - LOW - MODERATE - IMPORTANT - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/AdvisorySeverity' errata: description: List of errata applicable to this update. items: type: string type: array installedVersion: description: The version of the package that is currently installed on the instance. type: string relatedCves: description: List of CVEs applicable to this erratum. items: type: string type: array updateType: description: The type of update. enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER type: string x-obmcs-top-level-enum: '#/definitions/ClassificationTypes' required: - updateType description: Provides summary information for a software package available for installation on a managed instance. 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 AvailableWindowsUpdateCollection: description: 'The set of available Windows updates returned for the [ListManagedInstanceAvailableWindowsUpdates](#/en/osmh/latest/ManagedInstance/ListManagedInstanceAvailableWindowsUpdates) operation. ' properties: items: description: List of available Windows updates. items: $ref: '#/components/schemas/AvailableWindowsUpdateSummary' type: array required: - items type: object ModuleStreamDetailsBody: description: Provides the information used to enable or disable the module stream on a managed instance. properties: moduleName: description: The name of a module. type: string streamName: description: The name of a stream of the specified module. type: string workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - moduleName type: object WindowsUpdate: description: An object that provides information about an update for a Windows instance. properties: description: description: Description of the update. type: string installable: description: Indicates whether the update can be installed using the service. enum: - INSTALLABLE - NOT_INSTALLABLE type: string installationRequirements: description: List of requirements for installing the update on the managed instance. items: $ref: '#/components/schemas/InstallationRequirements' type: array isRebootRequiredForInstallation: description: Indicates whether a reboot is required to complete the installation of this update. type: boolean kbArticleIds: description: List of the Microsoft Knowledge Base Article Ids related to this Windows Update. items: type: string type: array name: description: Name of the Windows update. type: string sizeInBytes: description: size of the package in bytes format: int64 type: integer updateId: description: "Unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. \nExample: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'\n" type: string updateType: description: The type of Windows update. enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER type: string x-obmcs-top-level-enum: '#/definitions/ClassificationTypes' required: - name - updateType - updateId type: object Id: description: Id and name of a resource to simplify the display for the user. properties: displayName: description: User-friendly name. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. type: string required: - displayName - id SoftwareSourcesDetails: description: The details about the software sources to be attached/detached. properties: softwareSources: description: The list of software source OCIDs to be attached/detached. items: type: string maxItems: 255 type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - softwareSources type: object AvailableWindowsUpdateSummary: description: An object that defines an available update for a Windows instance. properties: installable: description: Indicates whether the update can be installed using the service. type: string x-obmcs-enumref: '#/definitions/WindowsUpdate/installable' isRebootRequiredForInstallation: description: Indicates whether a reboot is required to complete the installation of this update. type: boolean name: description: Name of the Windows update. type: string updateId: description: "Unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. \nExample: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'\n" type: string updateType: description: The type of Windows update. enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER type: string x-obmcs-top-level-enum: '#/definitions/ClassificationTypes' required: - name - updateType - updateId type: object ModuleStreamDetails: description: Provides the information used to update a module stream. properties: moduleName: description: The name of a module. 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 ManageModuleStreamsOnManagedInstanceDetails: description: The set of changes to make to the state of the modules, streams, and profiles on a managed instance properties: disable: description: "The set of module streams to disable. Any profiles that are installed for the module stream will be removed as part of the operation. \nOnce complete, the streams will be in 'DISABLED' status.\n" items: $ref: '#/components/schemas/ModuleStreamDetails' type: array enable: description: "The set of module streams to enable. If any streams of a module are already enabled, the service switches from the current stream to the new stream. \nOnce complete, the streams will be in 'ENABLED' status.\n" items: $ref: '#/components/schemas/ModuleStreamDetails' type: array install: description: "The set of module stream profiles to install. Any packages that are part of the profile are installed on the managed instance. \nOnce complete, the profile will be in 'INSTALLED' status. The operation will return an error if you attempt to install a profile from a disabled stream, unless enabling the new module stream is included in this operation.\n" items: $ref: '#/components/schemas/ModuleStreamProfileDetails' type: array isDryRun: default: false description: 'Indicates if this operation is a dry run or if the operation should be committed. If set to true, the result of the operation will be evaluated but not committed. If set to false, the operation is committed to the managed instance. The default is false. ' type: boolean remove: description: "The set of module stream profiles to remove. Once complete, the profile will be in 'AVAILABLE' status. \nThe status of packages within the profile after the operation is complete is defined by the package manager on the managed instance group.\n" items: $ref: '#/components/schemas/ModuleStreamProfileDetails' type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object DisableModuleStreamOnManagedInstanceDetails: allOf: - $ref: '#/components/schemas/ModuleStreamDetailsBody' description: Provides the information used to disable a module stream on a managed instance. type: object InstalledPackageSummary: allOf: - $ref: '#/components/schemas/PackageSummary' - discriminator: propertyName: INSTALLED properties: timeInstalled: description: 'The date and time the package was installed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeIssued: description: 'The date and time the package was issued by a providing erratum (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string required: - timeInstalled description: Provides summary information for a software package installed on a managed instance. ManagedInstance: description: An object that defines the instance being managed by the service. properties: agentVersion: description: The version of osmh-agent running on the managed instance type: string architecture: description: The CPU architecture type of the managed instance. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' areSourcesManaged: description: 'Controls whether OSMH manages software sources for this instance. This defaults to false for Ubuntu and Windows instances. ' type: boolean autonomousSettings: $ref: '#/components/schemas/AutonomousSettings' bugUpdatesAvailable: description: Number of bug fix type updates available for installation. type: integer compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the managed instance. ' type: string description: description: User-specified description for the managed instance. type: string displayName: description: User-friendly name for the managed instance. type: string enhancementUpdatesAvailable: description: Number of enhancement type updates available for installation. type: integer id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. ' type: string installedPackages: description: Number of packages installed on the instance. type: integer installedWindowsUpdates: description: Number of Windows updates installed on the instance. type: integer isManagedByAutonomousLinux: description: Indicates whether the Autonomous Linux service manages the instance. type: boolean isManagementStation: description: Indicates whether this managed instance is acting as an on-premises management station. type: boolean isRebootRequired: description: Indicates whether a reboot is required to complete installation of updates. type: boolean kspliceEffectiveKernelVersion: description: The ksplice effective kernel version. type: string lifecycleEnvironment: $ref: '#/components/schemas/Id' lifecycleStage: $ref: '#/components/schemas/Id' location: description: The location of the managed instance. enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' managedInstanceGroup: $ref: '#/components/schemas/Id' notificationTopicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. ' type: string osFamily: description: The operating system type of the managed instance. enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' osKernelVersion: description: Operating system kernel version. type: string osName: description: Operating system name. type: string osVersion: description: Operating system version. type: string otherUpdatesAvailable: description: Number of non-classified (other) updates available for installation. type: integer primaryManagementStationId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station for the instance to use as primary management station. ' type: string profile: description: The profile that was used to register this instance with the service. type: string profileVersion: description: The version of the profile that was used to register this instance with the service. type: string scheduledJobCount: description: Number of scheduled jobs associated with this instance. type: integer secondaryManagementStationId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station for the instance to use as secondary management station. ' type: string securityUpdatesAvailable: description: Number of security type updates available for installation. type: integer softwareSources: description: The list of software sources currently attached to the managed instance. items: $ref: '#/components/schemas/SoftwareSourceDetails' type: array status: description: Current status of the managed instance. enum: - NORMAL - UNREACHABLE - ERROR - WARNING - REGISTRATION_ERROR - DELETING - ONBOARDING - REBOOTING type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceStatus' tenancyId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy that the managed instance resides in. ' type: string timeCreated: description: 'The date and time the instance was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string timeLastBoot: description: 'Time that the instance last booted (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string timeLastCheckin: description: 'Time that the instance last checked in with the service (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string timeLastSoftwareRefresh: description: 'The date and time the instance''s software information was last refreshed (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string timeUpdated: description: 'The date and time the instance was last updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string updatesAvailable: description: Number of updates available for installation. type: integer workRequestCount: description: Number of work requests associated with this instance. type: integer required: - id - displayName - tenancyId - compartmentId - status type: object PackageNameSummary: description: Provides summary information about a package. properties: architecture: description: The CPU architecture type for which this package was built. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' displayName: description: Full package name in NERVA format. This value should be unique. type: string name: description: The name of the software package. type: string type: description: Type of the package. type: string version: description: The version of the software package. type: string required: - displayName - name type: object InstalledWindowsUpdateSummary: description: An object that defines an installed update for a Windows instance. properties: name: description: Name of the Windows update. type: string updateId: description: "Unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. \nExample: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'\n" type: string updateType: description: The type of Windows update. enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER type: string x-obmcs-top-level-enum: '#/definitions/ClassificationTypes' required: - name - updateType - updateId type: object RemoveModuleStreamProfileFromManagedInstanceDetails: allOf: - $ref: '#/components/schemas/ModuleStreamProfileDetailsBody' description: Provides the information used to remove a module stream profile on a managed instance. type: object parameters: LifecycleStageNotEqualToQueryParam: description: A filter to return only managed instances that are NOT associated with the specified lifecycle environment. in: query name: lifecycleStageNotEqualTo required: false x-default-description: 'null' schema: type: string WindowsUpdateSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeInstalled is descending. Default order for name or displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - name - displayName default: timeCreated RequiredCompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string MultiDisplayNameQueryParam: description: A filter to return resources that match the given display names. in: query name: displayName x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string maxItems: 5 uniqueItems: true GroupNotEqualToQueryParam: description: A filter to return only managed instances that are NOT attached to the specified group. in: query name: groupNotEqualTo required: false x-default-description: 'null' schema: type: string ErrataSortByQueryParam: description: 'The field to sort errata by. Only one sort order may be provided. Default order for timeIssued is descending. Default order for name is ascending. If no value is specified timeIssued is default. ' in: query name: sortBy schema: type: string enum: - timeIssued - name default: timeIssued InstallModuleStreamProfileOnManagedInstanceDetailsParam: description: The details of the module stream profile to be installed on a managed instance. in: body name: InstallModuleStreamProfileOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/InstallModuleStreamProfileOnManagedInstanceDetails' IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string AgentVersionQueryParam: description: A filter to return only managed instances with the specified version of osmh-agent running. in: query name: agentVersion required: false x-default-description: 'null' schema: type: string AdvisorySeverityQueryParam: description: 'The advisory severity. ' in: query name: advisorySeverity required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - LOW - MODERATE - IMPORTANT - CRITICAL type: string x-obmcs-top-level-enum: '#/definitions/AdvisorySeverity' maxItems: 10 MultiOsFamilyQueryParam: description: A filter to return only resources that match the given operating system family. in: query name: osFamily required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' maxItems: 5 uniqueItems: true SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC IsInstallableQueryParam: description: Indicates if the update can be installed by the OS Management Hub service. in: query name: isInstallable required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/WindowsUpdate/installable' schema: type: string EnableModuleStreamOnManagedInstanceDetailsParam: description: The details of the module stream to be enabled on a managed instance. in: body name: EnableModuleStreamOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/EnableModuleStreamOnManagedInstanceDetails' ManagedInstanceIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. in: path name: managedInstanceId required: true schema: type: string RequestIdHeader: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. in: header name: opc-request-id schema: type: string UpdatePackagesOnManagedInstanceDetailsParam: description: Details about packages to be updated on a managed instance. in: body name: UpdatePackagesOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/UpdatePackagesOnManagedInstanceDetails' MultiManagementStationNotEqualToQueryParam: description: "A filter to return resources that aren't associated with the specified management \nstation [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" in: query name: managementStationNotEqualTo x-default-description: 'null' style: form explode: true schema: type: array items: type: string uniqueItems: true LifeCycleEnvironmentQueryParam: description: A filter to return only managed instances in a specific lifecycle environment. in: query name: lifecycleEnvironment required: false x-default-description: 'null' schema: type: string RebootManagedInstanceParam: description: "The timeout to be set for the reboot job. The timeout is the amount of time in minutes that the service waits for \nthe reboot to complete before marking the job as failed.\n" in: body name: RebootManagedInstanceDetails required: true schema: $ref: '#/components/schemas/RebootManagedInstanceDetails' UpdateManagedInstanceDetailsParam: description: Details about a managed instance to be updated. in: body name: UpdateManagedInstanceDetails required: true schema: $ref: '#/components/schemas/UpdateManagedInstanceDetails' DisplayNameContainsQueryParam: description: A filter to return resources that may partially match the given display name. in: query name: displayNameContains x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 LifeCycleEnvironmentNotEqualToQueryParam: description: A filter to return only managed instances that aren't in a specific lifecycle environment. in: query name: lifecycleEnvironmentNotEqualTo required: false x-default-description: 'null' schema: type: string ManagementStationIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station. in: path name: managementStationId required: true schema: type: string MultiLocationQueryParam: description: A filter to return only resources whose location matches the given value. in: query name: location x-default-description: 'null' style: form explode: true schema: type: array items: enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' maxItems: 5 uniqueItems: true AvailablePackagePaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `700` ' in: query name: limit schema: type: integer default: 500 maximum: 1000 minimum: 1 InstalledPackageSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeInstalled is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeInstalled - timeCreated - displayName default: timeInstalled RemoveModuleStreamProfileFromManagedInstanceDetailsParam: description: The details of the module stream profile to be removed from a managed instance. in: body name: RemoveModuleStreamProfileFromManagedInstanceDetails required: true schema: $ref: '#/components/schemas/RemoveModuleStreamProfileFromManagedInstanceDetails' NameSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for name is ascending. ' in: query name: sortBy schema: type: string enum: - name default: name InstallAllWindowsUpdatesOnManagedInstancesInCompartmentDetailsParam: description: The details about Windows update types to be installed on all managed instances in a compartment. in: body name: InstallAllWindowsUpdatesOnManagedInstancesInCompartmentDetails required: true schema: $ref: '#/components/schemas/InstallAllWindowsUpdatesOnManagedInstancesInCompartmentDetails' NameContainsQueryParam: description: A filter to return resources that may partially match the name given. in: query name: nameContains required: false x-default-description: 'null' schema: type: string MultiLocationNotEqualToQueryParam: description: A filter to return only resources whose location does not match the given value. in: query name: locationNotEqualTo x-default-description: 'null' style: form explode: true schema: type: array items: enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' maxItems: 5 uniqueItems: true ManagementStationQueryParam: description: A filter to return only managed instances that are acting as management stations. in: query name: isManagementStation required: false x-default-description: 'null' schema: type: boolean DetachSoftwareSourcesFromManagedInstanceParam: description: Details of software sources to be detached from a managed instance. in: body name: DetachSoftwareSourcesFromManagedInstanceDetails required: true schema: $ref: '#/components/schemas/DetachSoftwareSourcesFromManagedInstanceDetails' ManagedInstanceSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated DisplayNameQueryParam: description: A filter to return resources that match the given user-friendly name. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 UpdateAllPackagesOnManagedInstancesInCompartmentDetailsParam: description: The details about package types are to be updated on all managed instances in a compartment. in: body name: UpdateAllPackagesOnManagedInstancesInCompartmentDetails required: true schema: $ref: '#/components/schemas/UpdateAllPackagesOnManagedInstancesInCompartmentDetails' ManagedInstanceIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance. in: query name: managedInstanceId required: false x-default-description: 'null' schema: type: string WindowsUpdateIdPathParam: description: "The unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. \nExample: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'\n" in: path name: windowsUpdateId required: true x-default-description: 'null' schema: type: string RemoveSnapsFromManagedInstanceDetailsParam: description: Details about snaps to install. in: body name: RemoveSnapsFromManagedInstanceDetails required: true schema: $ref: '#/components/schemas/RemoveSnapsFromManagedInstanceDetails' PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `3` ' in: query name: page x-default-description: 'null' schema: type: string minLength: 1 SwitchSnapChannelOnManagedInstanceDetailsParam: description: Details about snaps to install. in: body name: SwitchSnapChannelOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/SwitchSnapChannelOnManagedInstanceDetails' EndInstallDateQueryParam: description: 'A filter to return only packages that were installed on or before the date provided, in ISO 8601 format. Example: 2017-07-14T02:40:00.000Z ' in: query name: timeInstallDateEnd required: false x-default-description: 'null' schema: type: string format: date-time LifecycleStageQueryParam: description: A filter to return only managed instances that are associated with the specified lifecycle environment. in: query name: lifecycleStage required: false x-default-description: 'null' schema: type: string MultiClassificationTypeQueryParam: description: A filter to return only packages that match the given update classification type. in: query name: classificationType x-default-description: 'null' style: form explode: true schema: type: array items: enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER type: string x-obmcs-top-level-enum: '#/definitions/ClassificationTypes' maxItems: 5 uniqueItems: true MultiArchTypeQueryParam: description: A filter to return only instances whose architecture type matches the given architecture. in: query name: archType required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' maxItems: 5 uniqueItems: true MultiProfileNotEqualToQueryParam: description: A multi filter to return only managed instances that don't contain the given profile [OCIDs](/iaas/Content/General/Concepts/identifiers.htm). in: query name: profileNotEqualTo x-default-description: 'null' style: form explode: true schema: type: array items: type: string uniqueItems: true RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 AttachSoftwareSourcesToManagedInstanceParam: description: Details of software sources to be attached to a managed instance. in: body name: AttachSoftwareSourcesToManagedInstanceDetails required: true schema: $ref: '#/components/schemas/AttachSoftwareSourcesToManagedInstanceDetails' IsManagedByAutonomousLinuxQueryParam: description: 'Indicates whether to list only resources managed by the Autonomous Linux service. ' in: query name: isManagedByAutonomousLinux required: false x-default-description: 'null' schema: type: boolean ProfileQueryParam: description: A filter to return only managed instances with a registration profile attached. in: query name: isProfileAttached required: false x-default-description: 'null' schema: type: boolean AttachProfileToManagedInstanceParam: description: Details of the registration profile to be attached to a managed instance. in: body name: AttachProfileToManagedInstanceDetails required: true schema: $ref: '#/components/schemas/AttachProfileToManagedInstanceDetails' GroupQueryParam: description: A filter to return only managed instances that are attached to the specified group. in: query name: group required: false x-default-description: 'null' schema: type: string RemovePackagesFromManagedInstanceDetailsParam: description: Details about packages to be removed on a managed instance. in: body name: RemovePackagesFromManagedInstanceDetails required: true schema: $ref: '#/components/schemas/RemovePackagesFromManagedInstanceDetails' InstallSnapsOnManagedInstanceDetailsParam: description: Details about snaps to install. in: body name: InstallSnapsOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/InstallSnapsOnManagedInstanceDetails' AdvisoryNameQueryParam: description: 'The assigned erratum name. It''s unique and not changeable. Example: `ELSA-2020-5804` ' in: query name: advisoryName required: false x-default-description: 'null' style: form explode: true schema: type: array items: type: string maxItems: 51 NameParam: description: 'The resource name. ' in: query name: name required: false x-default-description: 'null' schema: type: string MultiWindowsUpdateIdQueryParam: description: "A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. \nExample: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'\n" in: query name: name x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string maxItems: 5 uniqueItems: true MultiManagementStationQueryParam: description: "A filter to return resources that are associated with the specified management \nstation [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" in: query name: managementStation x-default-description: 'null' style: form explode: true schema: type: array items: type: string uniqueItems: true ErratumNameQueryParam: description: 'The assigned erratum name. It''s unique and not changeable. Example: `ELSA-2020-5804` ' in: query name: name required: false x-default-description: 'null' style: form explode: true schema: type: array items: type: string maxItems: 51 RebootRequiredQueryParam: description: A filter to return only managed instances that require a reboot to install updates. in: query name: isRebootRequired required: false x-default-description: 'null' schema: type: boolean CompartmentIdQueryParam: description: The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. in: query name: compartmentId x-default-description: 'null' schema: type: string InstallWindowsUpdatesOnManagedInstanceDetailsParam: description: Details about Windows updates to be installed on a managed instance. in: body name: InstallWindowsUpdatesOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/InstallWindowsUpdatesOnManagedInstanceDetails' PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 SoftwareSourceIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. This filter returns resources associated with this software source. in: query name: softwareSourceId required: false x-default-description: 'null' schema: type: string MultiProfileQueryParam: description: A multi filter to return only managed instances that match the given profile ids. in: query name: profile x-default-description: 'null' style: form explode: true schema: type: array items: type: string uniqueItems: true ErratumNameContainsQueryParam: description: A filter to return resources that may partially match the erratum name given. in: query name: nameContains required: false x-default-description: 'null' schema: type: string GroupOrLifecycleQueryParam: description: A filter to return only managed instances that are attached to the specified group or lifecycle environment. in: query name: isAttachedToGroupOrLifecycleStage required: false x-default-description: 'null' schema: type: boolean MultiManagedInstanceStatusQueryParam: description: A filter to return only managed instances whose status matches the status provided. in: query name: status required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - NORMAL - UNREACHABLE - ERROR - WARNING - REGISTRATION_ERROR - DELETING - ONBOARDING - REBOOTING type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceStatus' maxItems: 5 uniqueItems: true SwitchModuleStreamOnManagedInstanceDetailsParam: description: The details of the module stream to be switched on a managed instance. in: body name: SwitchModuleStreamOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/SwitchModuleStreamOnManagedInstanceDetails' InstallPackagesOnManagedInstanceDetailsParam: description: Details about packages to be installed on a managed instance. in: body name: InstallPackagesOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/InstallPackagesOnManagedInstanceDetails' DisableModuleStreamOnManagedInstanceDetailsParam: description: The details of the module stream to be disabled on a managed instance. in: body name: DisableModuleStreamOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/DisableModuleStreamOnManagedInstanceDetails' StartInstallDateQueryParam: description: 'The install date after which to list all packages, in ISO 8601 format Example: 2017-07-14T02:40:00.000Z ' in: query name: timeInstallDateStart required: false x-default-description: 'null' schema: type: string format: date-time ManageModuleStreamsOnManagedInstanceParam: description: A description of an operation to perform against the modules, streams, and profiles of a managed instance. in: body name: ManageModuleStreamsOnManagedInstanceDetails required: true schema: $ref: '#/components/schemas/ManageModuleStreamsOnManagedInstanceDetails' responses: default: description: Unknown Error 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 content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string 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). ' 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. ' type: string opc-total-items: description: 'The total number of items in the result. Used for pagination of a list of items. ' type: integer opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: 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 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 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 x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.osmh.api