{ "opencollection": "1.0.0", "info": { "name": "OS Management Hub Reporting Managed Instance API", "version": "20220901" }, "items": [ { "info": { "name": "reportingManagedInstance", "type": "folder" }, "items": [ { "info": { "name": "Returns user specified metrics for a collection of managed instances which match the given filters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstanceAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "metricNames", "value": "", "type": "query", "description": "A filter to return only metrics whose name matches the given metric names." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. \nThis filter returns only resources contained within the specified compartment.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates whether to include subcompartments in the returned results. Default is false." }, { "name": "managedInstanceGroupId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. This filter returns resources associated with this group." }, { "name": "dynamicSetId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." }, { "name": "lifecycleEnvironmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment." }, { "name": "lifecycleStageId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage. This resource returns resources associated with this lifecycle stage." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only managed instances whose status matches the status provided." }, { "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": "osFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given operating system family." }, { "name": "isManagedByAutonomousLinux", "value": "", "type": "query", "description": "Indicates whether to list only resources managed by the Autonomous Linux service.\n" }, { "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": "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": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default is to sort in ascending order by metricName (previously name, which is now depricated). \nYou can also sort by displayName (default is ascending order).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a list of user specified metrics for a collection of managed instances.\n" }, { "info": { "name": "Download report in user selected format (CSV/XML/JSON) of a collection of managed instances", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstanceAnalytics/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. \nThis filter returns only resources contained within the specified compartment.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates whether to include subcompartments in the returned results. Default is false." }, { "name": "managedInstanceGroupId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. This filter returns resources associated with this group." }, { "name": "dynamicSetId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set." }, { "name": "lifecycleEnvironmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment." }, { "name": "lifecycleStageId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage. This resource returns resources associated with this lifecycle stage." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only managed instances whose status matches the status provided." }, { "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": "securityUpdatesAvailableEqualsTo", "value": "", "type": "query", "description": "A filter to return instances that have the specified number of available security updates." }, { "name": "bugUpdatesAvailableEqualsTo", "value": "", "type": "query", "description": "A filter to return instances that have the specified number of available bug updates." }, { "name": "otherUpdatesAvailableEqualsTo", "value": "", "type": "query", "description": "A filter to return instances that have the specified number of available other updates." }, { "name": "securityUpdatesAvailableGreaterThan", "value": "", "type": "query", "description": "A filter to return instances that have more available security updates than the number specified." }, { "name": "bugUpdatesAvailableGreaterThan", "value": "", "type": "query", "description": "A filter to return instances that have more available bug updates than the number specified." }, { "name": "otherUpdatesAvailableGreaterThan", "value": "", "type": "query", "description": "A filter to return instances that have more available other updates than the number specified." }, { "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": "osFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given operating system family." }, { "name": "isManagedByAutonomousLinux", "value": "", "type": "query", "description": "Indicates whether to list only resources managed by the Autonomous Linux service.\n" }, { "name": "reportFormat", "value": "", "type": "query", "description": "The format of the report to download. Default is CSV." }, { "name": "reportType", "value": "", "type": "query", "description": "The type of the report the user wants to download. Default is ALL." } ] }, "docs": "Returns a report of managed instances matching the given filters. You can select CSV, XML, or JSON format.\n" }, { "info": { "name": "Download a user selected format (CSV/XML/JSON) vulnerability report of a single managed instances", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/managedInstances/:managedInstanceId/content", "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": "advisoryName", "value": "", "type": "query", "description": "The assigned erratum name. It's unique and not changeable.\n\nExample: `ELSA-2020-5804`\n" }, { "name": "advisoryNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the erratum advisory name given." }, { "name": "advisoryType", "value": "", "type": "query", "description": "A filter to return only errata that match the given advisory types." }, { "name": "vulnerabilityName", "value": "", "type": "query", "description": "A filter to return vulnerabilities that match the given name. For Linux instances, this refers to the advisory name. For Windows instances, this refers to the Windows update display name." }, { "name": "vulnerabilityNameContains", "value": "", "type": "query", "description": "A filter to return vulnerabilities that partially match the given name. For Linux instances, this refers to the advisory name. For Windows instances, this refers to the Windows update display name." }, { "name": "vulnerabilityType", "value": "", "type": "query", "description": "A filter to return only vulnerabilities matching the given types." }, { "name": "reportFormat", "value": "", "type": "query", "description": "The format of the report to download. Default is CSV." } ] }, "docs": "Returns a report for a single managed instance whose associated erratas match the given filters. You can select CSV, XML, or JSON format.\n" } ] } ], "bundled": true }