Oracle Monitoring API

openapi: 3.2.0
info:
  description: 'Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.

    Endpoints vary by operation. For PostMetricData, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.

    For more information, see

    [the Monitoring documentation](/iaas/Content/Monitoring/home.htm).

    '
  license:
    name: Oracle Corporation
  title: Monitoring API
  version: '20180401'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/69b9986d0d4ba07ab7f8c49624363def032da8d0c5b981e5dc6cea8a473e309f.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Monitoring 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/69b9986d0d4ba07ab7f8c49624363def032da8d0c5b981e5dc6cea8a473e309f.yaml
    what: the harvested document for Monitoring API
servers:
- url: /20180401
tags:
- name: monitoring
paths:
  /alarmSuppressions:
    get:
      description: 'Lists alarm suppressions for the specified alarm. For more information, see

        [Listing Alarm Suppressions](/iaas/Content/Monitoring/Tasks/list-alarm-suppression.htm).


        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: ListAlarmSuppressions
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/AlarmIdQueryParam'
      - $ref: '#/components/parameters/FilterByAlarmSuppressionDisplayNameQueryParam'
      - $ref: '#/components/parameters/FilterByAlarmSuppressionLifecycleStateQueryParam'
      - $ref: '#/components/parameters/AlarmSuppressionLevelQueryParam'
      - $ref: '#/components/parameters/AlarmSuppressionCompartmentIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/AlarmSuppressionTargetTypeQueryParam'
      - $ref: '#/components/parameters/IsAllSuppressionsQueryParam'
      - $ref: '#/components/parameters/AlarmSuppressionSortByQueryParam'
      - $ref: '#/components/parameters/AlarmSuppressionSortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: alarm suppression items
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, next page of results remains.

                For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-previous-page:
              description: 'For list pagination. When this header appears in the response, previous pages of results remains.

                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/AlarmSuppressionCollection'
        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/DefaultError'
      summary: List Alarm Suppressions
      tags:
      - monitoring
      x-example: 'GET /20180401/alarmSuppressions?alarmId=<var>&lt;alarm_OCID&gt;</var>

        Host: telemetry.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    post:
      description: 'Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific).

        For more information, see

        [Suppressing a Single Alarm](/iaas/Content/Monitoring/Tasks/create-alarm-suppression.htm) and

        [Suppressing Multiple Alarms](/iaas/Content/Monitoring/Tasks/create-alarm-suppression-multiple.htm).


        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: CreateAlarmSuppression
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      responses:
        200:
          description: 'Successfully created alarm suppression.

            '
          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/AlarmSuppression'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Creates a new alarm suppression
      tags:
      - monitoring
      x-example: "POST /20180401/alarmSuppressions\nHost: telemetry.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"alarmSuppressionTarget\" : {\n      \"targetType\" : \"ALARM\",\n      \"alarmId\" : \"<var>&lt;alarm_OCID&gt;</var>\"\n  },\n  \"level\": \"DIMENSION\",\n  \"displayName\": \"Suppression for monthly downtime of resource ABC\",\n  \"description\": \"Suppression for monthly downtime of resource ABC, for support ticket IT-ABC\",\n  \"dimensions\": {\"resourceId\": <var>&lt;resource_OCID&gt;</var>}\n  \"timeSuppressFrom\": \"2023-03-04T05:00:00.600Z\",\n  \"timeSuppressUntil\": \"2023-03-31T17:00:00.000Z\",\n  \"suppressionConditions\": [{\n    \"conditionType\": \"RECURRENCE\",\n    \"suppressionRecurrence\":\"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;BYMINUTE=00;BYSECOND=00\",\n    \"suppressionDuration\":\"PT1H\"\n  }]\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAlarmSuppressionDetails'
        description: 'The details of the alarm suppression to be created

          '
        required: true
  /alarmSuppressions/{alarmSuppressionId}:
    delete:
      description: 'Deletes the specified alarm suppression. For more information, see

        [Removing a Suppression from a Single Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression.htm) and

        [Removing a Suppression from Multiple Alarms](/iaas/Content/Monitoring/Tasks/delete-alarm-suppression-multiple.htm).


        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: DeleteAlarmSuppression
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/AlarmSuppressionIdPathParam'
      responses:
        204:
          description: Successfully deleted the alarm suppression.
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      tags:
      - monitoring
      x-example: 'DELETE /20180401/alarmSuppressions/<var>&lt;alarmSuppression_OCID&gt;</var>

        Host: telemetry.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/AlarmSuppression'
    get:
      description: 'Gets the specified alarm suppression. For more information, see

        [Getting an Alarm-wide Suppression](/iaas/Content/Monitoring/Tasks/get-alarm-suppression.htm).


        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: GetAlarmSuppression
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/AlarmSuppressionIdPathParam'
      responses:
        200:
          description: 'Successfully retrieved alarm suppression.

            '
          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/AlarmSuppression'
        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/DefaultError'
      tags:
      - monitoring
      x-example: 'GET /20180401/alarmSuppressions/<var>&lt;alarmSuppression_OCID&gt;</var>

        Host: telemetry.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /alarms:
    get:
      description: 'Lists the alarms for the specified compartment.

        For more information, see

        [Listing Alarms](/iaas/Content/Monitoring/Tasks/list-alarm.htm).

        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: ListAlarms
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
      - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      responses:
        200:
          description: Successfully retrieved alarms for listing.
          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:
                items:
                  $ref: '#/components/schemas/AlarmSummary'
                type: array
        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/DefaultError'
      tags:
      - monitoring
      x-example: 'Sample 1: List all alarms in a compartment, sorted by display name


        GET /20180401/alarms?compartmentId=<var>&lt;compartment_OCID&gt;</var>&sortBy=displayName

        Host: telemetry.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>


        Sample 2: List the alarm named "CPU" in a compartment


        GET /20180401/alarms?compartmentId=<var>&lt;compartment_OCID&gt;</var>&displayName=CPU

        Host: telemetry.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    post:
      description: 'Creates a new alarm in the specified compartment.

        For more information, see

        [Creating an Alarm](/iaas/Content/Monitoring/Tasks/create-alarm.htm).

        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: CreateAlarm
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      responses:
        200:
          description: Successfully created alarm.
          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/Alarm'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: 'Creates a new alarm in the specified compartment.

        '
      tags:
      - monitoring
      x-example: "Sample 1: Single condition\n\nPOST /20180401/alarms\nHost: telemetry.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"body\": \"CPU utilization has reached high values.\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"destinations\": [ \"<var>&lt;topic_OCID&gt;</var>\" ],\n  \"displayName\": \"High CPU Utilization\",\n  \"isEnabled\": true,\n  \"isNotificationsPerMetricDimensionEnabled\": true,\n  \"messageFormat\": \"ONS_OPTIMIZED\",\n  \"metricCompartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"namespace\": \"oci_computeagent\",\n  \"pendingDuration\": \"PT5M\",\n  \"query\": \"CpuUtilization[1m]{availabilityDomain = \\\"cumS:PHX-AD-1\"\\}.groupBy(availabilityDomain).percentile(0.9) > 85\",\n  \"repeatNotificationDuration\": \"PT2H\",\n  \"severity\": \"WARNING\",\n  \"suppression\":\n  {\n    \"description\": \"System Maintenance\",\n    \"timeSuppressFrom\": \"2023-02-04T05:00:00.600Z\",\n    \"timeSuppressUntil\": \"2023-02-04T07:00:00.600Z\"\n  }\n}\n        \nSample 2: Multiple conditions, with dynamic variables and a five-minute evaluation slack duration\n\nPOST /20180401/alarms\nHost: telemetry.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"alarmSummary\": \"test summary with severity = {{severity}} and query = {{{query}}}\",\n  \"body\": \"{{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"destinations\": [ \"<var>&lt;topic_OCID&gt;</var>\" ],\n  \"displayName\": \"High CPU Utilization\",\n  \"evaluationSlackDuration\": \"PT5M\",\n  \"isEnabled\": true,\n  \"isNotificationsPerMetricDimensionEnabled\": true,\n  \"messageFormat\": \"ONS_OPTIMIZED\",\n  \"metricCompartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"namespace\": \"oci_computeagent\",\n  \"notificationTitle\": \"Sample title with severity {{severity}}\",\n  \"overrides\":\n    [\n      {\"body\": \"95% CPU utilization\", \"query\": \"CPUUtilization[1m].mean()>95\", \"severity\": \"CRITICAL\"},\n      {\"body\": \"80% CPU utilization\", \"query\": \"CPUUtilization[1m].mean()>80\", \"severity\": \"WARNING\"}\n    ],\n  \"pendingDuration\": \"PT5M\",\n  \"query\": \"CpuUtilization[1m]{availabilityDomain=\\\"cumS:PHX-AD-1\\\"}.groupBy(availabilityDomain).percentile(0.9) > 85\",\n  \"repeatNotificationDuration\": \"PT2H\",\n  \"ruleName\": \"BASE\",\n  \"severity\": \"INFO\"\n}        \n\nSample 3: Event-based alarm\n\nPOST /20180401/alarms\nHost: telemetry.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"body\": \"Database instance terminated.\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"destinations\": [ \"<var>&lt;topic_OCID&gt;</var>\" ],\n  \"displayName\": \"Database instance shutdown\",\n  \"isEnabled\": true,\n  \"isNotificationsPerMetricDimensionEnabled\": true,\n  \"messageFormat\": \"ONS_OPTIMIZED\",\n  \"metricCompartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"namespace\": \"oci_database\",\n  \"pendingDuration\": \"PT1M\",\n  \"query\": \"DatabaseInstance.Shutdown[1m].groupBy(availabilityDomain).count() > 0\",\n  \"repeatNotificationDuration\": \"PT0M\",\n  \"severity\": \"INFO\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAlarmDetails'
        description: Document for creating an alarm.
        required: true
  /alarms/status:
    get:
      description: 'List the status of each alarm in the specified compartment.

        Status is collective, across all metric streams in the alarm.

        To list alarm status for each metric stream, use [RetrieveDimensionStates](#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).

        Optionally filter by resource or status value.


        For more information, see

        [Listing Alarm Statuses](/iaas/Content/Monitoring/Tasks/list-alarm-status.htm).

        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: ListAlarmsStatus
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ResourceIdQueryParam'
      - $ref: '#/components/parameters/ServiceNameQueryParam'
      - $ref: '#/components/parameters/EntityIdQueryParam'
      - $ref: '#/components/parameters/StatusQueryParam'
      responses:
        200:
          description: 'Successfully retrieved alarms status for listing.

            '
          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:
                items:
                  $ref: '#/components/schemas/AlarmStatusSummary'
                type: array
        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/DefaultError'
      tags:
      - monitoring
      x-example: 'GET /20180401/alarms/status?compartmentId=<var>&lt;compartment_OCID&gt;</var>&resourceId=<var>&lt;resource_OCID&gt;</var>

        Host: telemetry.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
  /alarms/{alarmId}:
    delete:
      description: 'Deletes the specified alarm.

        For more information, see

        [Deleting an Alarm](/iaas/Content/Monitoring/Tasks/delete-alarm.htm).

        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: DeleteAlarm
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/AlarmIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: Successfully deleted the alarm.
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: 'Deletes an alarm.

        '
      tags:
      - monitoring
      x-example: 'DELETE /20180401/alarms/<var>&lt;alarm_OCID&gt;</var>

        Host: telemetry.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Alarm'
    get:
      description: 'Gets the specified alarm.

        For more information, see

        [Getting an Alarm](/iaas/Content/Monitoring/Tasks/get-alarm.htm).

        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: GetAlarm
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/AlarmIdPathParam'
      responses:
        200:
          description: Successfully retrieved alarm.
          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/Alarm'
        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/DefaultError'
      tags:
      - monitoring
      x-example: 'GET /20180401/alarms/<var>&lt;alarm_OCID&gt;</var>

        Host: telemetry.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: 'Updates the specified alarm.

        For more information, see

        [Updating an Alarm](/iaas/Content/Monitoring/Tasks/update-alarm.htm).

        For important limits information, see

        [Limits on Monitoring](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).


        This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.

        Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,

        or transactions, per second (TPS) for a given tenancy.

        '
      operationId: UpdateAlarm
      parameters:
      - $ref: '#/components/parameters/AlarmIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Successfully updated alarm.
          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/Alarm'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: 'Updates an alarm.

        '
      tags:
      - monitoring
      x-example: "Sample 1: Updating displayName\n\nPUT /20180401/alarms/<var>&lt;alarm_OCID&gt;</var>\nHost: telemetry.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"System Down\"\n}\n\nSample 2: Removing an override (AlarmOverride)\n\nPUT /20180401/alarms/<var>&lt;alarm_OCID&gt;</var>\nHost: telemetry.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"overrides\": []\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAlarmDetails'
        description: Document for updating an alarm.
        required: true
  /alarms/{alarmId}/actions/changeCompartment:
    post:
      description: 'Moves an alarm into a different compartment within the same tenancy.

        For more information, see

        [Moving an Alarm](/iaas/Content/Monitoring/Tasks/change-compartment-alarm.htm).

        '
      operationId: ChangeAlarmCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/AlarmIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      responses:
        204:
          description: Successfully changed compartment for the specified alarm.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assig

# --- truncated at 32 KB (188 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-monitoring-api-openapi.yml