Oracle Cloud Infrastructure Alarms API

openapi: 3.0.3
info:
  title: Oracle Cloud Compute Alarms API
  description: Manage compute instances, images, shapes, and related resources in Oracle Cloud Infrastructure.
  version: '20160918'
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
  contact:
    name: Oracle Cloud Infrastructure
    url: https://docs.oracle.com/en-us/iaas/Content/Compute/home.htm
servers:
- url: https://iaas.{region}.oraclecloud.com/20160918
  description: OCI Compute API server
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
security:
- ociSignature: []
tags:
- name: Alarms
paths:
  /alarms:
    get:
      operationId: listAlarms
      summary: Oracle Cloud List Alarms
      description: Lists the alarms in the specified compartment.
      tags:
      - Alarms
      parameters:
      - name: compartmentId
        in: query
        required: true
        description: The OCID of the compartment.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved alarms.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AlarmSummary'
              examples:
                ListAlarms200Example:
                  summary: Default listAlarms 200 response
                  x-microcks-default: true
                  value:
                  - id: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: my-resource
                    severity: example-value
                    isEnabled: true
                    lifecycleState: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createAlarm
      summary: Oracle Cloud Create Alarm
      description: Creates a new monitoring alarm.
      tags:
      - Alarms
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAlarmDetails'
            examples:
              CreateAlarmRequestExample:
                summary: Default createAlarm request
                x-microcks-default: true
                value:
                  compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                  displayName: my-resource
                  metricCompartmentId: ocid1.resource.oc1.iad.abcdefg123456
                  namespace: oci_computeagent
                  query: CpuUtilization[1m].mean()
                  severity: CRITICAL
                  isEnabled: true
                  destinations:
                  - example-value
      responses:
        '200':
          description: Successfully created alarm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alarm'
              examples:
                CreateAlarm200Example:
                  summary: Default createAlarm 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.alarm.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: High CPU Alarm
                    metricCompartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    namespace: oci_computeagent
                    query: CpuUtilization[1m].mean() > 90
                    severity: CRITICAL
                    isEnabled: true
                    lifecycleState: ACTIVE
                    destinations:
                    - example-value
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /alarms/{alarmId}:
    get:
      operationId: getAlarm
      summary: Oracle Cloud Get Alarm
      description: Gets the specified alarm.
      tags:
      - Alarms
      parameters:
      - name: alarmId
        in: path
        required: true
        description: The OCID of the alarm.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved alarm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alarm'
              examples:
                GetAlarm200Example:
                  summary: Default getAlarm 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.alarm.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: High CPU Alarm
                    metricCompartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    namespace: oci_computeagent
                    query: CpuUtilization[1m].mean() > 90
                    severity: CRITICAL
                    isEnabled: true
                    lifecycleState: ACTIVE
                    destinations:
                    - example-value
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateAlarm
      summary: Oracle Cloud Update Alarm
      description: Updates the specified alarm.
      tags:
      - Alarms
      parameters:
      - name: alarmId
        in: path
        required: true
        description: The OCID of the alarm.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAlarmDetails'
            examples:
              UpdateAlarmRequestExample:
                summary: Default updateAlarm request
                x-microcks-default: true
                value:
                  displayName: my-resource
                  query: CpuUtilization[1m].mean()
                  severity: example-value
                  isEnabled: true
      responses:
        '200':
          description: Successfully updated alarm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alarm'
              examples:
                UpdateAlarm200Example:
                  summary: Default updateAlarm 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.alarm.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: High CPU Alarm
                    metricCompartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    namespace: oci_computeagent
                    query: CpuUtilization[1m].mean() > 90
                    severity: CRITICAL
                    isEnabled: true
                    lifecycleState: ACTIVE
                    destinations:
                    - example-value
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteAlarm
      summary: Oracle Cloud Delete Alarm
      description: Deletes the specified alarm.
      tags:
      - Alarms
      parameters:
      - name: alarmId
        in: path
        required: true
        description: The OCID of the alarm.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '204':
          description: Successfully deleted alarm.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UpdateAlarmDetails:
      type: object
      properties:
        displayName:
          type: string
          example: my-resource
        query:
          type: string
          example: CpuUtilization[1m].mean()
        severity:
          type: string
          example: example-value
        isEnabled:
          type: boolean
          example: true
    CreateAlarmDetails:
      type: object
      required:
      - compartmentId
      - displayName
      - metricCompartmentId
      - namespace
      - query
      - severity
      - isEnabled
      - destinations
      properties:
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        displayName:
          type: string
          example: my-resource
        metricCompartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        namespace:
          type: string
          example: oci_computeagent
        query:
          type: string
          example: CpuUtilization[1m].mean()
        severity:
          type: string
          enum:
          - CRITICAL
          - ERROR
          - WARNING
          - INFO
          example: CRITICAL
        isEnabled:
          type: boolean
          example: true
        destinations:
          type: array
          items:
            type: string
          example:
          - example-value
    AlarmSummary:
      type: object
      properties:
        id:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        displayName:
          type: string
          example: my-resource
        severity:
          type: string
          example: example-value
        isEnabled:
          type: boolean
          example: true
        lifecycleState:
          type: string
          example: example-value
    Alarm:
      type: object
      description: A monitoring alarm.
      properties:
        id:
          type: string
          example: ocid1.alarm.oc1.iad.abcdefg123456
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        displayName:
          type: string
          example: High CPU Alarm
        metricCompartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        namespace:
          type: string
          example: oci_computeagent
        query:
          type: string
          example: CpuUtilization[1m].mean() > 90
        severity:
          type: string
          enum:
          - CRITICAL
          - ERROR
          - WARNING
          - INFO
          example: CRITICAL
        isEnabled:
          type: boolean
          example: true
        lifecycleState:
          type: string
          enum:
          - ACTIVE
          - DELETING
          - DELETED
          example: ACTIVE
        destinations:
          type: array
          items:
            type: string
          example:
          - example-value
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys.