{ "opencollection": "1.0.0", "info": { "name": "OS Management Hub Managed Instance API", "version": "20220901" }, "items": [ { "info": { "name": "managedInstance", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of allmanaged instances in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only managed instances whose status matches the status provided." }, { "name": "archType", "value": "", "type": "query", "description": "A filter to return only instances whose architecture type matches the given architecture." }, { "name": "osFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given operating system family." }, { "name": "isManagementStation", "value": "", "type": "query", "description": "A filter to return only managed instances that are acting as management stations." }, { "name": "group", "value": "", "type": "query", "description": "A filter to return only managed instances that are attached to the specified group." }, { "name": "groupNotEqualTo", "value": "", "type": "query", "description": "A filter to return only managed instances that are NOT attached to the specified group." }, { "name": "lifecycleStage", "value": "", "type": "query", "description": "A filter to return only managed instances that are associated with the specified lifecycle environment." }, { "name": "lifecycleStageNotEqualTo", "value": "", "type": "query", "description": "A filter to return only managed instances that are NOT associated with the specified lifecycle environment." }, { "name": "isAttachedToGroupOrLifecycleStage", "value": "", "type": "query", "description": "A filter to return only managed instances that are attached to the specified group or lifecycle environment." }, { "name": "softwareSourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. This filter returns resources associated with this software source." }, { "name": "advisoryName", "value": "", "type": "query", "description": "The assigned erratum name. It's unique and not changeable.\n\nExample: `ELSA-2020-5804`\n" }, { "name": "lifecycleEnvironment", "value": "", "type": "query", "description": "A filter to return only managed instances in a specific lifecycle environment." }, { "name": "lifecycleEnvironmentNotEqualTo", "value": "", "type": "query", "description": "A filter to return only managed instances that aren't in a specific lifecycle environment." }, { "name": "location", "value": "", "type": "query", "description": "A filter to return only resources whose location matches the given value." }, { "name": "locationNotEqualTo", "value": "", "type": "query", "description": "A filter to return only resources whose location does not match the given value." }, { "name": "profile", "value": "", "type": "query", "description": "A multi filter to return only managed instances that match the given profile ids." }, { "name": "profileNotEqualTo", "value": "", "type": "query", "description": "A multi filter to return only managed instances that don't contain the given profile [OCIDs](/iaas/Content/General/Concepts/identifiers.htm)." }, { "name": "isProfileAttached", "value": "", "type": "query", "description": "A filter to return only managed instances with a registration profile attached." }, { "name": "isManagedByAutonomousLinux", "value": "", "type": "query", "description": "Indicates whether to list only resources managed by the Autonomous Linux service.\n" }, { "name": "agentVersion", "value": "", "type": "query", "description": "A filter to return only managed instances with the specified version of osmh-agent running." }, { "name": "managementStation", "value": "", "type": "query", "description": "A filter to return resources that are associated with the specified management \nstation [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "managementStationNotEqualTo", "value": "", "type": "query", "description": "A filter to return resources that aren't associated with the specified management \nstation [OCIDs](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "name": "isRebootRequired", "value": "", "type": "query", "description": "A filter to return only managed instances that require a reboot to install updates." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "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." }, { "info": { "name": "Installs all Windows Updates on managed instances in a compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/actions/installWindowsUpdates", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ] }, "docs": "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.\n" }, { "info": { "name": "Update all packages on managed instances in a compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/actions/updatePackages", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ] }, "docs": "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.\n" }, { "info": { "name": "Get ManagedInstance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Gets information about the specified managed instance." }, { "info": { "name": "Update the managed instance identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Updates the specified managed instance information, such as description, ONS topic, and associated management station.\n" }, { "info": { "name": "Delete (unregister) a provisioned Managed Instance", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "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" }, { "info": { "name": "Add a profile to a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/attachProfile", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Adds profile to a managed instance. After the profile has been added,\nthe instance can be registered as a managed instance.\n" }, { "info": { "name": "Add a software source to a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/attachSoftwareSources", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Adds software sources to a managed instance. After the software source has been added,\nthen packages from that software source can be installed on the managed instance.\n" }, { "info": { "name": "Detach a profile from a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/detachProfile", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Detaches profile from a managed instance. After the profile has been removed,\nthe instance cannot be registered as a managed instance.\n" }, { "info": { "name": "Removes software sources from a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/detachSoftwareSources", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Removes software sources from a managed instance.\nPackages will no longer be able to be installed from these software sources.\n" }, { "info": { "name": "Disable a specific module stream on a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/disableModuleStreams", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Disables a module stream on a managed instance. After the stream is\ndisabled, it is no longer possible to install the profiles that are\ncontained by the stream. All installed profiles must be removed prior\nto disabling a module stream.\n" }, { "info": { "name": "Enable a specific module stream on a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/enableModuleStreams", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Enables a module stream on a managed instance. After the stream is\nenabled, it is possible to install the profiles that are contained\nby the stream. Enabling a stream that is already enabled will\nsucceed. Attempting to enable a different stream for a module that\nalready has a stream enabled results in an error.\n" }, { "info": { "name": "Install packages on a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/installPackages", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Installs packages on a managed instance.\n" }, { "info": { "name": "Installs snaps on a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/installSnaps", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Installs specified snaps on a managed instance." }, { "info": { "name": "Installs a profile for an enabled module stream", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/installStreamProfiles", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Installs a profile for an module stream. The stream must be\nenabled before a profile can be installed. If a module stream\ndefines multiple profiles, each one can be installed independently.\n" }, { "info": { "name": "Install Windows update(s) on a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/installWindowsUpdates", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Installs Windows updates on the specified managed instance.\n" }, { "info": { "name": "Perform an operation involving modules, streams, and profiles on a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/manageModuleStreams", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "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 m" }, { "info": { "name": "Reboots a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/reboot", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "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" }, { "info": { "name": "Refresh the software information", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/refreshSoftware", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "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.\n" }, { "info": { "name": "Removes a package from a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/removePackages", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Removes an installed package from a managed instance.\n" }, { "info": { "name": "Remove snaps from a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/removeSnaps", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Removes specified snaps from a managed instance." }, { "info": { "name": "Removes an installed profile for a module stream from a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/removeStreamProfiles", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Removes a profile for a module stream that is installed on a managed instance.\nIf a module stream is provided, rather than a fully qualified profile, all\nprofiles that have been installed for the module stream will be removed.\n" }, { "info": { "name": "Changes the enabled stream for a module", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/switchModuleStreams", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Enables a new stream for a module that already has a stream enabled.\nIf any profiles or packages from the original module are installed,\nswitching to a new stream will remove the existing packages and\ninstall their counterparts in the new stream.\n" }, { "info": { "name": "Switch snap channel on a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/switchSnapChannel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Switches the snap channel on a managed instance." }, { "info": { "name": "Update a package on a managed instance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/actions/updatePackages", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." } ] }, "docs": "Updates a package on a managed instance.\n" }, { "info": { "name": "Lists all packages that are available for installation on a managed instance.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/availablePackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\nExample: `700`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of packages that are available for installation on a managed instance.\n" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/availableSoftwareSources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "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.\n" }, { "info": { "name": "Gets a list of all Windows updates available for the Managed Instance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/availableWindowsUpdates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "classificationType", "value": "", "type": "query", "description": "A filter to return only packages that match the given update classification type." }, { "name": "name", "value": "", "type": "query", "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" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given user-friendly name." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "isInstallable", "value": "", "type": "query", "description": "Indicates if the update can be installed by the OS Management Hub service." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of Windows updates that can be installed on the specified managed instance.\n" }, { "info": { "name": "Gets a list of all applicable errata on the managed instance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/errata", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "classificationType", "value": "", "type": "query", "description": "A filter to return only packages that match the given update classification type." }, { "name": "name", "value": "", "type": "query", "description": "The assigned erratum name. It's unique and not changeable.\n\nExample: `ELSA-2020-5804`\n" }, { "name": "nameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the erratum name given." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of applicable errata on the managed instance.\n" }, { "info": { "name": "Gets a list of all packages installed on the managed instance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/installedPackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "timeInstallDateStart", "value": "", "type": "query", "description": "The install date after which to list all packages, in ISO 8601 format\n\nExample: 2017-07-14T02:40:00.000Z\n" }, { "name": "timeInstallDateEnd", "value": "", "type": "query", "description": "A filter to return only packages that were installed on or before the date provided, in ISO 8601 format.\n\nExample: 2017-07-14T02:40:00.000Z\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Lists the packages that are installed on the managed instance.\n" }, { "info": { "name": "Gets a list of all Windows updates that are installed on the Managed Instance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/installedWindowsUpdates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "name", "value": "", "type": "query", "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" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given user-friendly name." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of Windows updates that have been installed on the specified managed instance.\n" }, { "info": { "name": "Retrieve a list of modules from a managed instance.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/modules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "name", "value": "", "type": "query", "description": "The resource name.\n" }, { "name": "nameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the name given." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for name is ascending.\n" } ] }, "docs": "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.\n" }, { "info": { "name": "Retrieve a list of snaps from a managed instance.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/snaps", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "name", "value": "", "type": "query", "description": "The resource name.\n" }, { "name": "nameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the name given." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for name is ascending.\n" } ] }, "docs": "Retrieves a list of snaps for a managed instance. Filters may be applied to select a subset of snaps based on the filter criteria.\n" }, { "info": { "name": "Gets a list of updatable packages on a managed instance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/updatablePackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "managedInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "classificationType", "value": "", "type": "query", "description": "A filter to return only packages that match the given update classification type." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "advisoryName", "value": "", "type": "query", "description": "The assigned erratum name. It's unique and not changeable.\n\nExample: `ELSA-2020-5804`\n" }, { "name": "advisorySeverity", "value": "", "type": "query", "description": "The advisory severity.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of updatable packages for a managed instance.\n" }, { "info": { "name": "Associates managed instances to a management station", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/managementStations/:managementStationId/actions/associateManagedInstances", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "managementStationId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associates managed instances to the specified management station\n" }, { "info": { "name": "Gets a list of Windows Updates", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/windowsUpdates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "classificationType", "value": "", "type": "query", "description": "A filter to return only packages that match the given update classification type." }, { "name": "name", "value": "", "type": "query", "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" }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "compartmentId", "value": "", "type": "query", "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." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Lists Windows updates that have been reported to the service.\n" }, { "info": { "name": "Gets information about the specified Windows update.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/windowsUpdates/:windowsUpdateId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "windowsUpdateId", "value": "", "type": "path", "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" } ] }, "docs": "Returns a Windows Update object.\n" } ] } ], "bundled": true }