How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Monitoring API

The monitoring API from Oracle — 13 operation(s) for monitoring.

Oracle Monitoring API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Monitoring. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 18 operations across 13 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 20180401.

Requests are made against a single base URL, /20180401.

18 operations 13 paths 33 schemas 2 DELETE6 GET9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20180401
Base URL
https://{host}:{port}/ords/
License
Oracle Corporation
Resource Areas
1

Paths & Operations 18

Across 13 paths, the API surfaces 18 operations — 2 DELETE, 6 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

monitoring 18
GET
/alarmSuppressions
List Alarm Suppressions
ListAlarmSuppressions 13 params → 200400401404429500default
POST
/alarmSuppressions
Creates a new alarm suppression
CreateAlarmSuppression 2 params body → 200400401404409429500default
DELETE
/alarmSuppressions/{alarmSuppressionId}
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 Suppressio…
DeleteAlarmSuppression 3 params → 204400401404412429500default
GET
/alarmSuppressions/{alarmSuppressionId}
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 [L…
GetAlarmSuppression 2 params → 200400401404429500default
GET
/alarms
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]…
ListAlarms 9 params → 200400401404429500default
POST
/alarms
Creates a new alarm in the specified compartment.
CreateAlarm 2 params body → 200400401404409429500default
GET
/alarms/status
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](/e…
ListAlarmsStatus 12 params → 200400401404429500default
DELETE
/alarms/{alarmId}
Deletes an alarm.
DeleteAlarm 3 params → 204400401404412429500default
GET
/alarms/{alarmId}
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/Monito…
GetAlarm 2 params → 200400401404429500default
PUT
/alarms/{alarmId}
Updates an alarm.
UpdateAlarm 3 params body → 200400401404412429500default
POST
/alarms/{alarmId}/actions/changeCompartment
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).
ChangeAlarmCompartment 4 params body → 204400401404409412429500
POST
/alarms/{alarmId}/actions/removeSuppression
Removes any existing suppression for the specified alarm.
RemoveAlarmSuppression 3 params → 200400401404409412429500
POST
/alarms/{alarmId}/actions/retrieveDimensionStates
Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition. Optionally filter by status value and one or more dimension key-valu…
RetrieveDimensionStates 4 params body → 200400401404429500default
POST
/alarms/{alarmId}/actions/summarizeAlarmSuppressionHistory
Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions. For more information, see [Getting Suppression History for an Alarm](/iaas/…
SummarizeAlarmSuppressionHistory 4 params body → 200400401404429500default
GET
/alarms/{alarmId}/history
Get the history of the specified alarm. For more information, see [Getting History of an Alarm](/iaas/Content/Monitoring/Tasks/get-alarm-history.htm). For important limits information, see [Limits on…
GetAlarmHistory 7 params → 200400401404429500default
POST
/metrics
Publishes raw metric data points to the Monitoring service.
PostMetricData 2 params body → 200400401404429500default
POST
/metrics/actions/listMetrics
List metrics based on matching criteria.
ListMetrics 5 params body → 200400401404429500default
POST
/metrics/actions/summarizeMetricsData
Summarizes and returns metrics data filtered using the provided query expression and compartmentId.
SummarizeMetricsData 3 params body → 200400401404429500default

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Alarm (29 properties), UpdateAlarmDetails (25 properties), CreateAlarmDetails (25 properties), AlarmSummary (21 properties). Each schema is shown below with its type and property counts.

ChangeAlarmCompartmentDetails
object
The configuration details for moving an alarm.
1 property 1 required
AlarmSuppression
object
The configuration details for an alarm suppression.
15 properties 10 required
AlarmOverride
object
Values to use for an independent evaluation of the alarm. You can specify values for query, severity, body, and pending duration. When an alarm contains overri…
5 properties
AlarmSuppressionCollection
object
Collection of property summaries for alarm suppressions.
1 property 1 required
RetrieveDimensionStatesDetails
object
The configuration details for retrieving the alarm state entries. Filter retrieved alarm state entries by status value and dimension key-value pairs.
2 properties
AlarmDimensionStatesCollection
object
The list of current alarm state entries for each metric stream that matches the filters.
4 properties 4 required
UpdateAlarmDetails
object
The configuration details for updating an alarm.
25 properties
Metric
object
The properties that define a metric. For information about metrics, see [Metrics Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htmMetricsOverv…
5 properties
PostMetricDataResponseDetails
object
The response object returned from a PostMetricData operation.
2 properties 1 required
Suppression
object
The configuration details for an alarm-wide suppression. For dimension-specific suppressions, see [AlarmSuppression](/en/monitoring/latest/AlarmSuppression). F…
3 properties 2 required
MetricData
object
The set of aggregated data returned for a metric. For information about metrics, see [Metrics Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.ht…
8 properties 5 required
AlarmSuppressionHistoryItem
object
A summary of properties for the specified alarm suppression history item.
9 properties 6 required
SummarizeAlarmSuppressionHistoryDetails
object
The configuration details for returning history of suppressions for the specified alarm.
3 properties
AlarmHistoryCollection
object
The configuration details for retrieving alarm history.
3 properties 3 required
MetricDataDetails
object
A metric object containing raw metric data points to be posted to the Monitoring service.
7 properties 5 required
ListMetricsDetails
object
The request details for retrieving metric definitions. Specify optional properties to filter the returned results. Use an asterisk () as a wildcard character,…
7 properties
PostMetricDataDetails
object
An array of metric objects containing raw metric data points to be posted to the Monitoring service.
2 properties 1 required
AlarmStatusSummary
object
A summary of properties for the specified alarm and its current evaluation status. For information about alarms, see [Alarms Overview](/iaas/Content/Monitoring…
8 properties 7 required
Datapoint
object
Metric value for a specific timestamp.
3 properties 2 required
FailedMetricRecord
object
The record of a single metric object that failed input validation and the reason for the failure.
2 properties 2 required
AggregatedDatapoint
object
A timestamp-value pair returned for the specified request.
2 properties 2 required
Error
object
An error has occurred.
2 properties 2 required
CreateAlarmSuppressionDetails
object
The configuration details for creating an alarm suppression.
10 properties 4 required
AlarmSummary
object
A summary of properties for the specified alarm. For information about alarms, see [Alarms Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htmAl…
21 properties 10 required
CreateAlarmDetails
object
The configuration details for creating an alarm.
25 properties 8 required
AlarmDimensionStatesEntry
object
A timestamped alarm state entry for a metric stream.
5 properties 5 required
AlarmHistoryEntry
object
An alarm history entry indicating a description of the entry and the time that the entry occurred. If the entry corresponds to a state transition, such as OK t…
4 properties 3 required
AlarmSuppressionSummary
object
A summary of properties for the specified alarm suppression.
15 properties 10 required
Alarm
object
The properties that define an alarm. For information about alarms, see [Alarms Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htmAlarmsOverview…
29 properties 12 required
SuppressionCondition
object
Precondition for an alarm suppression within the suppression date and time range (timeSuppressFrom to timeSuppressUntil).
1 property 1 required
AlarmSuppressionHistoryItemCollection
object
Collection of property summaries for alarm suppression history items.
1 property 1 required
SummarizeMetricsDataDetails
object
The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.
6 properties 2 required
AlarmSuppressionTarget
object
The target of the alarm suppression.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-monitoring-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Monitoring API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.