Oracle Enterprise Manager Incidents API

openapi: 3.2.0
info:
  title: Oracle Enterprise Manager Cloud Control REST Blackouts Incidents API
  description: REST API for Oracle Enterprise Manager Cloud Control providing programmatic access to monitoring, configuration, and administration capabilities. This specification covers core resources including targets, metrics, incidents, and blackouts for managing Oracle IT infrastructure and applications.
  version: 13.5.0.23
  contact:
    name: Oracle Support
    url: https://www.oracle.com/support/
    email: support@oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-logo:
    url: https://www.oracle.com/a/ocom/img/oracle-enterprise-manager.jpg
servers:
- url: https://{emHost}:{emPort}/em/api
  description: Enterprise Manager Cloud Control server
  variables:
    emHost:
      default: localhost
      description: Enterprise Manager OMS hostname
    emPort:
      default: '7803'
      description: Enterprise Manager HTTPS console port
security:
- basicAuth: []
tags:
- name: Incidents
  description: Search, view, and manage incidents and events. Incidents represent actionable issues detected by Enterprise Manager monitoring, with operations for clearing, suppressing, and annotating.
  externalDocs:
    url: https://docs.oracle.com/en/enterprise-manager/cloud-control/enterprise-manager-cloud-control/13.5/emrest/rest-endpoints.html
paths:
  /incidents:
    get:
      operationId: listIncidents
      summary: Oracle Enterprise Manager List Incidents
      description: Returns a list of incidents in Enterprise Manager. Supports filtering by severity, priority, status, target, and time range. Incidents represent actionable issues detected by monitoring rules.
      tags:
      - Incidents
      parameters:
      - name: severity
        in: query
        description: Filter by incident severity level.
        schema:
          type: string
          enum:
          - FATAL
          - CRITICAL
          - WARNING
          - ADVISORY
          - INFORMATIONAL
        example: FATAL
      - name: priority
        in: query
        description: Filter by incident priority.
        schema:
          type: string
          enum:
          - URGENT
          - HIGH
          - MEDIUM
          - LOW
          - NONE
        example: URGENT
      - name: status
        in: query
        description: Filter by incident status.
        schema:
          type: string
          enum:
          - NEW
          - WORK_IN_PROGRESS
          - RESOLVED
          - CLOSED
          - SUPPRESSED
        example: NEW
      - name: targetName
        in: query
        description: Filter incidents by target name.
        schema:
          type: string
        example: example_value
      - name: targetType
        in: query
        description: Filter incidents by target type.
        schema:
          type: string
        example: example_value
      - name: sinceTime
        in: query
        description: Return incidents created after this time in ISO 8601 format.
        schema:
          type: string
          format: date-time
        example: '2026-01-15T10:30:00Z'
      - $ref: '#/components/parameters/limitQuery'
      - $ref: '#/components/parameters/offsetQuery'
      responses:
        '200':
          description: A paginated list of incidents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentCollection'
              examples:
                Listincidents200Example:
                  summary: Default listIncidents 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - incidentId: '500123'
                      summary: example_value
                      severity: FATAL
                      priority: URGENT
                      status: NEW
                      category: AVAILABILITY
                      targetName: example_value
                      targetType: example_value
                      escalationLevel: 10
                      owner: example_value
                      acknowledgedBy: example_value
                      resolutionState: example_value
                      ruleSetName: example_value
                      timeRaised: '2026-01-15T10:30:00Z'
                      timeUpdated: '2026-01-15T10:30:00Z'
                      timeResolved: '2026-01-15T10:30:00Z'
                      eventCount: 10
                      canonicalLink: https://www.example.com
                    totalCount: 10
                    limit: 10
                    offset: 10
                    hasMore: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /incidents/{incidentId}:
    get:
      operationId: getIncident
      summary: Oracle Enterprise Manager Get Incident Details
      description: Returns detailed information about a specific incident including severity, priority, status, associated target, timeline, and resolution information.
      tags:
      - Incidents
      parameters:
      - $ref: '#/components/parameters/incidentIdPath'
      responses:
        '200':
          description: Incident details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
              examples:
                Getincident200Example:
                  summary: Default getIncident 200 response
                  x-microcks-default: true
                  value:
                    incidentId: '500123'
                    summary: example_value
                    severity: FATAL
                    priority: URGENT
                    status: NEW
                    category: AVAILABILITY
                    targetName: example_value
                    targetType: example_value
                    escalationLevel: 10
                    owner: example_value
                    acknowledgedBy: example_value
                    resolutionState: example_value
                    ruleSetName: example_value
                    timeRaised: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
                    timeResolved: '2026-01-15T10:30:00Z'
                    eventCount: 10
                    canonicalLink: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /incidents/{incidentId}/actions/clear:
    post:
      operationId: clearIncident
      summary: Oracle Enterprise Manager Clear an Incident
      description: Clears an incident, indicating that the issue has been resolved. The incident status is set to CLOSED.
      tags:
      - Incidents
      parameters:
      - $ref: '#/components/parameters/incidentIdPath'
      responses:
        '200':
          description: Incident cleared successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
              examples:
                Clearincident200Example:
                  summary: Default clearIncident 200 response
                  x-microcks-default: true
                  value:
                    incidentId: '500123'
                    summary: example_value
                    severity: FATAL
                    priority: URGENT
                    status: NEW
                    category: AVAILABILITY
                    targetName: example_value
                    targetType: example_value
                    escalationLevel: 10
                    owner: example_value
                    acknowledgedBy: example_value
                    resolutionState: example_value
                    ruleSetName: example_value
                    timeRaised: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
                    timeResolved: '2026-01-15T10:30:00Z'
                    eventCount: 10
                    canonicalLink: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /incidents/{incidentId}/actions/suppress:
    post:
      operationId: suppressIncident
      summary: Oracle Enterprise Manager Suppress an Incident
      description: Suppresses an incident so it does not appear in active incident views or trigger notifications. Useful for known issues under investigation.
      tags:
      - Incidents
      parameters:
      - $ref: '#/components/parameters/incidentIdPath'
      responses:
        '200':
          description: Incident suppressed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
              examples:
                Suppressincident200Example:
                  summary: Default suppressIncident 200 response
                  x-microcks-default: true
                  value:
                    incidentId: '500123'
                    summary: example_value
                    severity: FATAL
                    priority: URGENT
                    status: NEW
                    category: AVAILABILITY
                    targetName: example_value
                    targetType: example_value
                    escalationLevel: 10
                    owner: example_value
                    acknowledgedBy: example_value
                    resolutionState: example_value
                    ruleSetName: example_value
                    timeRaised: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
                    timeResolved: '2026-01-15T10:30:00Z'
                    eventCount: 10
                    canonicalLink: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /incidents/{incidentId}/actions/unsuppress:
    post:
      operationId: unsuppressIncident
      summary: Oracle Enterprise Manager Unsuppress an Incident
      description: Reverses the suppression of an incident, restoring it to active visibility and notification eligibility.
      tags:
      - Incidents
      parameters:
      - $ref: '#/components/parameters/incidentIdPath'
      responses:
        '200':
          description: Incident unsuppressed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
              examples:
                Unsuppressincident200Example:
                  summary: Default unsuppressIncident 200 response
                  x-microcks-default: true
                  value:
                    incidentId: '500123'
                    summary: example_value
                    severity: FATAL
                    priority: URGENT
                    status: NEW
                    category: AVAILABILITY
                    targetName: example_value
                    targetType: example_value
                    escalationLevel: 10
                    owner: example_value
                    acknowledgedBy: example_value
                    resolutionState: example_value
                    ruleSetName: example_value
                    timeRaised: '2026-01-15T10:30:00Z'
                    timeUpdated: '2026-01-15T10:30:00Z'
                    timeResolved: '2026-01-15T10:30:00Z'
                    eventCount: 10
                    canonicalLink: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /incidents/{incidentId}/events:
    get:
      operationId: getIncidentEvents
      summary: Oracle Enterprise Manager Get Incident Events
      description: Returns the list of events associated with an incident. Events are the underlying monitoring detections that were correlated to form the incident.
      tags:
      - Incidents
      parameters:
      - $ref: '#/components/parameters/incidentIdPath'
      responses:
        '200':
          description: A list of events for the incident.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventCollection'
              examples:
                Getincidentevents200Example:
                  summary: Default getIncidentEvents 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - eventId: '500123'
                      eventType: METRIC_ALERT
                      severity: FATAL
                      message: example_value
                      targetName: example_value
                      targetType: example_value
                      metricGroupName: example_value
                      metricColumnName: example_value
                      metricValue: 42.5
                      timeRaised: '2026-01-15T10:30:00Z'
                      timeResolved: '2026-01-15T10:30:00Z'
                      canonicalLink: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /incidents/{incidentId}/annotations:
    get:
      operationId: getIncidentAnnotations
      summary: Oracle Enterprise Manager Get Incident Annotations
      description: Returns annotations (comments and notes) associated with an incident. Annotations provide a record of investigation and remediation steps.
      tags:
      - Incidents
      parameters:
      - $ref: '#/components/parameters/incidentIdPath'
      responses:
        '200':
          description: A list of annotations for the incident.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnotationCollection'
              examples:
                Getincidentannotations200Example:
                  summary: Default getIncidentAnnotations 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - annotationId: '500123'
                      summary: example_value
                      details: example_value
                      author: example_value
                      timeCreated: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    InternalServerError:
      description: An unexpected error occurred on the server.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request was invalid. Check the request body and parameters for errors.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication failed. Provide valid Enterprise Manager credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Annotation:
      type: object
      description: A comment or note attached to an incident, providing investigation details or remediation notes.
      properties:
        annotationId:
          type: string
          description: Unique identifier of the annotation.
          example: '500123'
        summary:
          type: string
          description: Summary text of the annotation.
          example: example_value
        details:
          type: string
          description: Detailed content of the annotation.
          example: example_value
        author:
          type: string
          description: Username of the annotation author.
          example: example_value
        timeCreated:
          type: string
          format: date-time
          description: Timestamp when the annotation was created.
          example: '2026-01-15T10:30:00Z'
    AnnotationCollection:
      type: object
      description: Collection of annotations.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Annotation'
          example: []
    IncidentCollection:
      type: object
      description: Paginated collection of incidents.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Incident'
          example: []
        totalCount:
          type: integer
          description: Total number of incidents matching the query.
          example: 10
        limit:
          type: integer
          example: 10
        offset:
          type: integer
          example: 10
        hasMore:
          type: boolean
          example: true
    Error:
      type: object
      description: Error response returned by the API.
      properties:
        errorCode:
          type: string
          description: Machine-readable error code.
          example: example_value
        message:
          type: string
          description: Human-readable error message.
          example: example_value
        details:
          type: string
          description: Additional details about the error.
          example: example_value
        httpStatusCode:
          type: integer
          description: HTTP status code.
          example: 10
    Event:
      type: object
      description: Represents a monitoring event detected by Enterprise Manager. Events are the atomic detections that are correlated into incidents.
      properties:
        eventId:
          type: string
          description: Unique identifier of the event.
          example: '500123'
        eventType:
          type: string
          description: Type of the event.
          enum:
          - METRIC_ALERT
          - TARGET_AVAILABILITY
          - JOB_STATUS_CHANGE
          - COMPLIANCE_VIOLATION
          - USER_REPORTED
          example: METRIC_ALERT
        severity:
          type: string
          description: Severity of the event.
          enum:
          - FATAL
          - CRITICAL
          - WARNING
          - ADVISORY
          - INFORMATIONAL
          - CLEAR
          example: FATAL
        message:
          type: string
          description: Descriptive message for the event.
          example: example_value
        targetName:
          type: string
          description: Name of the target that generated this event.
          example: example_value
        targetType:
          type: string
          description: Type of the target that generated this event.
          example: example_value
        metricGroupName:
          type: string
          description: Name of the metric group, if this is a metric alert event.
          example: example_value
        metricColumnName:
          type: string
          description: Name of the metric column, if this is a metric alert event.
          example: example_value
        metricValue:
          type: number
          description: Metric value that triggered the event.
          example: 42.5
        timeRaised:
          type: string
          format: date-time
          description: Timestamp when the event was raised.
          example: '2026-01-15T10:30:00Z'
        timeResolved:
          type: string
          format: date-time
          description: Timestamp when the event was resolved.
          example: '2026-01-15T10:30:00Z'
        canonicalLink:
          type: string
          format: uri
          description: Canonical URI for this event resource.
          example: https://www.example.com
    Incident:
      type: object
      description: Represents an incident in Enterprise Manager. Incidents are actionable issues detected by monitoring rules, correlated from one or more events.
      properties:
        incidentId:
          type: string
          description: Unique identifier of the incident.
          example: '500123'
        summary:
          type: string
          description: Brief summary of the incident.
          example: example_value
        severity:
          type: string
          description: Severity level of the incident.
          enum:
          - FATAL
          - CRITICAL
          - WARNING
          - ADVISORY
          - INFORMATIONAL
          example: FATAL
        priority:
          type: string
          description: Priority assigned to the incident.
          enum:
          - URGENT
          - HIGH
          - MEDIUM
          - LOW
          - NONE
          example: URGENT
        status:
          type: string
          description: Current status of the incident.
          enum:
          - NEW
          - WORK_IN_PROGRESS
          - RESOLVED
          - CLOSED
          - SUPPRESSED
          example: NEW
        category:
          type: string
          description: Category of the incident.
          enum:
          - AVAILABILITY
          - PERFORMANCE
          - SECURITY
          - CONFIGURATION
          - ERROR
          - CAPACITY
          - COMPLIANCE
          example: AVAILABILITY
        targetName:
          type: string
          description: Name of the target associated with this incident.
          example: example_value
        targetType:
          type: string
          description: Type of the target associated with this incident.
          example: example_value
        escalationLevel:
          type: integer
          description: Current escalation level of the incident.
          example: 10
        owner:
          type: string
          description: Username of the incident owner or assignee.
          example: example_value
        acknowledgedBy:
          type: string
          description: Username of the person who acknowledged the incident.
          example: example_value
        resolutionState:
          type: string
          description: Resolution state providing closure details.
          example: example_value
        ruleSetName:
          type: string
          description: Name of the incident rule set that created this incident.
          example: example_value
        timeRaised:
          type: string
          format: date-time
          description: Timestamp when the incident was first raised.
          example: '2026-01-15T10:30:00Z'
        timeUpdated:
          type: string
          format: date-time
          description: Timestamp of the last incident update.
          example: '2026-01-15T10:30:00Z'
        timeResolved:
          type: string
          format: date-time
          description: Timestamp when the incident was resolved.
          example: '2026-01-15T10:30:00Z'
        eventCount:
          type: integer
          description: Number of events correlated into this incident.
          example: 10
        canonicalLink:
          type: string
          format: uri
          description: Canonical URI for this incident resource.
          example: https://www.example.com
    EventCollection:
      type: object
      description: Collection of events.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Event'
          example: []
  parameters:
    limitQuery:
      name: limit
      in: query
      description: Maximum number of items to return per page.
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 1000
    offsetQuery:
      name: offset
      in: query
      description: Number of items to skip for pagination.
      schema:
        type: integer
        default: 0
        minimum: 0
    incidentIdPath:
      name: incidentId
      in: path
      required: true
      description: Unique identifier of the incident.
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Enterprise Manager administrator credentials. All API requests must include valid credentials.
externalDocs:
  description: Oracle Enterprise Manager Cloud Control REST API Documentation
  url: https://docs.oracle.com/en/enterprise-manager/cloud-control/enterprise-manager-cloud-control/13.5/emrest/APIOverview.html