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 Event 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: event
paths:
/events:
get:
description: 'Lists events that match the specified criteria, such as compartment, state, and event type.
'
operationId: ListEvents
parameters:
- $ref: '#/components/parameters/EventSummaryQueryParam'
- $ref: '#/components/parameters/EventSummaryContainsQueryParam'
- $ref: '#/components/parameters/EventIdentifierQueryParam'
- $ref: '#/components/parameters/EventFingerprintQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/EventLifecycleStateQueryParam'
- $ref: '#/components/parameters/ResourceIdentifierQueryParam'
- $ref: '#/components/parameters/MultiEventTypeQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/TimeCreatedLessThanQueryParam'
- $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/EventSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IsManagedByAutonomousLinuxQueryParam'
responses:
200:
description: A list of event summary objects 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/EventCollection'
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: Returns a list of events.
tags:
- event
x-example: 'GET /20220901/events?compartmentId=<compartment_OCID>
Host: osmh.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/EventCollection'
/events/{eventId}:
delete:
description: Deletes the specified event.
operationId: DeleteEvent
parameters:
- $ref: '#/components/parameters/EventIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: For kernel OOPs and crash events, the event will be deleted from the instance and then deleted for the kernel OOPs or crash. For other event types, the event will be deleted from the service.
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: Deletes an event.
tags:
- event
x-example: 'DELETE /20220901/events/<resource_OCID>
Host: osmh.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Event'
get:
description: Returns information about the specified event.
operationId: GetEvent
parameters:
- $ref: '#/components/parameters/EventIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The event 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
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
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: Returns an event.
tags:
- event
x-example: 'GET /20220901/events/<resource_OCID>
Host: osmh.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates the tags for an event.
operationId: UpdateEvent
parameters:
- $ref: '#/components/parameters/EventIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The event has been 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/Event'
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: Updates event tags.
tags:
- event
x-example: "PUT /20220901/events/<resource_OCID>\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n"
x-related-resource: '#/definitions/Event'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEventDetails'
description: Provides the information used to update the event tags.
required: true
/events/{eventId}/actions/changeCompartment:
post:
description: "Moves an event into a different compartment within the same tenancy. For information about moving resources between \ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n"
operationId: ChangeEventCompartment
parameters:
- $ref: '#/components/parameters/EventIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The event was successfully moved to the specified compartment
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves an event into a different compartment.
tags:
- event
x-example: "POST /20220901/events/<resource_OCID>/actions/changeCompartment\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\"\n}\n"
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/Event'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEventCompartmentDetails'
description: Specifies the compartment to move the event to.
required: true
/events/{eventId}/actions/importContent:
post:
description: 'Uploads an event content ZIP archive from an instance to the service.
'
operationId: ImportEventContent
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/EventIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Request accepted. The event content will be uploaded to the service.
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: Uploads event content from an instance to the service.
tags:
- event
x-example: 'POST /20220901/events/<resource_OCID>/actions/importContent
Host: osmh.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
{
}
'
x-related-resource: '#/definitions/Event'
/events/{eventId}/content:
delete:
description: 'Deletes an event content ZIP archive from the service.
'
operationId: DeleteEventContent
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/EventIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The event content was successfully deleted from the service.
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: Deletes event content from the service.
tags:
- event
x-example: 'DELETE /20220901/events/<resource_OCID>/content
Host: osmh.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Event'
get:
description: 'Returns a ZIP archive with additional information about an event. The archive content depends on the event type.
'
operationId: GetEventContent
parameters:
- $ref: '#/components/parameters/EventIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Event content 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
content:
application/octet-stream:
schema:
format: binary
type: string
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 additional event information.
tags:
- event
x-example: 'GET /20220901/events/<resource_OCID>/content
Host: osmh.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Event'
components:
parameters:
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
ResourceIdentifierQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. This filter returns resources associated with the specified resource.
in: query
name: resourceId
x-default-description: 'null'
schema:
type: string
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
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
TimeCreatedGreaterThanOrEqualToQueryParam:
description: "A filter that returns events that occurred on or after the date provided. \nExample: `2016-08-25T21:10:29.600Z`\n"
in: query
name: timeCreatedGreaterThanOrEqualTo
x-default-description: 'null'
schema:
type: string
format: date-time
EventSummaryContainsQueryParam:
description: A filter to return only events with a summary that contains the value provided.
in: query
name: eventSummaryContains
required: false
x-default-description: 'null'
schema:
type: string
EventIdentifierQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the event.
in: query
name: id
required: false
x-default-description: 'null'
schema:
type: string
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
TimeCreatedLessThanQueryParam:
description: "A filter that returns events that occurred on or before the date provided. \nExample: `2016-08-25T21:10:29.600Z`\n"
in: query
name: timeCreatedLessThan
x-default-description: 'null'
schema:
type: string
format: date-time
EventFingerprintQueryParam:
description: The eventFingerprint of the KernelEventData.
in: query
name: eventFingerprint
required: false
x-default-description: 'null'
schema:
type: string
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
EventLifecycleStateQueryParam:
description: 'A filter to return only events that match the state provided. The state value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/Event/lifecycleState'
x-obmcs-inline-enum: true
schema:
type: string
EventIdentifierPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the event.
in: path
name: eventId
required: true
schema:
type: string
EventSummaryQueryParam:
description: A filter to return only events whose summary matches the given value.
in: query
name: eventSummary
required: false
x-default-description: 'null'
schema:
type: string
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
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
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
EventSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated, timeOccurredAt and timeUpdated is descending. Default order for eventSummary is ascending.
'
in: query
name: sortBy
x-obmcs-inline-enum: true
schema:
type: string
enum:
- timeCreated
- timeOccurredAt
- timeUpdated
- eventSummary
default: timeCreated
MultiEventTypeQueryParam:
description: A filter to return only resources whose type matches the given value.
in: query
name: type
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- KERNEL_OOPS
- KERNEL_CRASH
- EXPLOIT_ATTEMPT
- SOFTWARE_UPDATE
- KSPLICE_UPDATE
- SOFTWARE_SOURCE
- AGENT
- MANAGEMENT_STATION
- SYSADMIN
- REBOOT
- SNAP_UPDATE
type: string
x-obmcs-top-level-enum: '#/definitions/EventType'
maxItems: 10
uniqueItems: true
schemas:
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
EventCollection:
description: A set of events returned for the [ListEvents](#/en/osmh/latest/EventCollection/ListEvents) operation. The list contains a summary of each event and other information, such as metadata.
properties:
items:
description: List of events.
items:
$ref: '#/components/schemas/EventSummary'
type: array
required:
- items
type: object
Event:
description: "An event is an occurrence of something of interest on a managed instance, \nsuch as a kernel crash, software package update, or software source \nupdate.\n"
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
eventDetails:
description: Details of an event.
type: string
eventSummary:
description: Summary of the event.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the event.
type: string
isManagedByAutonomousLinux:
description: Indicates whether the event occurred on a resource that is managed by the Autonomous Linux service.
type: boolean
lifecycleDetails:
description: "Describes the current state of the event in more detail. For example, the \nmessage can provide actionable information for a resource in the 'FAILED' state.\n"
type: string
lifecycleState:
description: The current state of the event.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
resourceId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance or resource where the event occurred.
type: string
systemDetails:
$ref: '#/components/schemas/SystemDetails'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time the Event was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeOccurred:
description: The date and time that the event occurred.
format: date-time
type: string
timeUpdated:
description: 'The date and time that the event was updated (in [RFC 3339](https://tools.ietf.org/html/rfc3339) format).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
type:
description: "Event type:\n * `KERNEL_OOPS` - Used to identify a kernel panic condition event\n * `KERNEL_CRASH` - Used to identify an internal fatal kernel error that cannot be safely recovered from\n * `EXPLOIT_ATTEMPT` - Used to identify a known exploit detection as identified by Ksplice\n * `SOFTWARE_UPDATE` - Software updates - Packages\n * `KSPLICE_UPDATE` - Ksplice updates\n * `SOFTWARE_SOURCE` - Software source\n * `AGENT` - Agent\n * `MANAGEMENT_STATION` - Management Station\n * `SYSADMIN` - Used to identify attempts on fixing agent errors on the instance\n * `REBOOT` - Reboot\n"
enum:
- KERNEL_OOPS
- KERNEL_CRASH
- EXPLOIT_ATTEMPT
- SOFTWARE_UPDATE
- KSPLICE_UPDATE
- SOFTWARE_SOURCE
- AGENT
- MANAGEMENT_STATION
- SYSADMIN
- REBOOT
- SNAP_UPDATE
type: string
x-obmcs-top-level-enum: '#/definitions/EventType'
required:
- id
- compartmentId
- type
- lifecycleState
- timeCreated
- eventSummary
- freeformTags
- definedTags
type: object
UpdateEventDetails:
description: Provides the information for updating the tags of an event for the [UpdateEvent](#/en/osmh/latest/Event/UpdateEvent) operation.
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
type: object
ChangeEventCompartmentDetails:
description: Specifies which compartment to move the event to for the [ChangeEventCompartment](#/en/osmh/latest/Event/ChangeEventCompartment) operation.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the event to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
SystemDetails:
description: Provides information about the system architecture and operating system.
properties:
architecture:
description: Architecture type.
enum:
- X86_64
- AARCH64
- I686
- NOARCH
- SRC
- I386
- AMD64
- ARM64
- ALL
type: string
x-obmcs-top-level-enum: '#/definitions/ArchType'
kspliceEffectiveKernelVersion:
description: Version of the Ksplice effective kernel.
type: string
osFamily:
description: Operating system type.
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'
osKernelRelease:
description: Release of the kernel.
type: string
osKernelVersion:
description: Version of the kernel.
type: string
osName:
description: Name of the operating system.
type: string
osSystemVersion:
description: Version of the operating system.
type: string
required:
- architecture
- osFamily
- osName
- osSystemVersion
x-example: "{\n \"architecture\": \"X86_64\",\n \"kspliceEffectiveKernelVersion\": \"5.4.17-2102.201.3.el7uek.x86_64\",\n \"osFamily\": \"LINUX\",\n \"osName\": \"ORACLE_LINUX_SERVER\",\n \"osKernelRelease\": \"#2 SMP Fri Apr 23 09:05:55 PDT 2021\",\n \"osKernelVersion\": \"5.4.17-2102.201.3.el7uek.x86_64\",\n \"osSystemVersion\": \"7.9\"\n}\n"
EventSummary:
description: Provides summary information about an event.
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
eventSummary:
description: Summary of the event.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the event.
type: string
isManagedByAutonomousLinux:
description: Indicates whether the event occurred on a resource that is managed by the Autonomous Linux service.
type: boolean
lifecycleDetails:
description: "Describes the current state of the event in more detail. For example, the \nmessage can provide actionable information for a resource in the 'FAILED' \nstate.\n"
type: string
lifecycleState:
description: The current state of the event.
type: string
x-obmcs-enumref: '#/definitions/Event/lifecycleState'
resourceId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance or resource where the event occurred.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The date and time that the event was created (in [RFC 3339](https://tools.ietf.org/html/rfc3339) format).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeOccurred:
description: 'The date and time that the event occurred (in [RFC 3339](https://tools.ietf.org/html/rfc3339) format).
Example: 2016-08-25T21:10:29.600Z
'
format: date-time
type: string
timeUpdated:
description: 'The date and time that the event was updated (in [RFC 3339](https://tools.ietf.org/html/rfc3339) format).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
type:
description: Type of event.
enum:
- KERNEL_OOPS
- KERNEL_CRASH
- EXPLOIT_ATTEMPT
- SOFTWARE_UPDATE
- KSPLICE_UPDATE
- SOFTWARE_SOURCE
- AGENT
- MANAGEMENT_STATION
- SYSADMIN
- REBOOT
- SNAP_UPDATE
type: string
x-obmcs-top-level-enum: '#/definitions/EventType'
required:
- id
- compartmentId
- type
- lifecycleState
- timeCreated
- timeOccurred
- eventSummary
- freeformTags
- definedTags
type: object
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