Oracle Cloud Infrastructure Monitoring API

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

Documentation GitHub OpenAPI

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /alarmSuppressions List suppressions on an alarm · List Alarm Suppressions #

Ask an LLM

“Which suppressions are currently muting notifications for a given alarm?”

“Can I filter alarm suppressions by level, like alarm-wide versus dimension-specific?”

Tell an agent

List the suppressions for alarm {alarmId}.

Show {lifecycleState} alarm suppressions in compartment {compartmentId}.

POST /alarmSuppressions Suppress an alarm's notifications for a time window · Creates a new alarm suppression #

Ask an LLM

“How do I silence alarm notifications during a planned maintenance window?”

“Can I suppress just one dimension of an alarm instead of the whole thing?”

Tell an agent

Suppress target {alarmSuppressionTarget} as {displayName} from {timeSuppressFrom} until {timeSuppressUntil}.

Create suppression {displayName} for target {alarmSuppressionTarget} on dimensions {dimensions}, {timeSuppressFrom} to {timeSuppressUntil}.

DELETE /alarmSuppressions/{alarmSuppressionId} Delete a specific alarm suppression · Delete alarm suppression #

Ask an LLM

“How do I end one suppression early by its ID?”

“Can I delete one alarm suppression by its suppression ID and keep the alarm's other suppressions?”

Tell an agent destructive · confirm first

Delete alarm suppression {alarmSuppressionId}.

Remove the suppression record {alarmSuppressionId} so notifications resume.

GET /alarmSuppressions/{alarmSuppressionId} Get the details of one alarm suppression · Get alarm suppression #

Ask an LLM

“When does a particular alarm suppression start and end?”

“What dimensions does a specific suppression cover?”

Tell an agent

Show alarm suppression {alarmSuppressionId}.

Get the time window of suppression {alarmSuppressionId}.

GET /alarms List the alarms in a compartment · List alarms #

Ask an LLM

“What monitoring alarms are defined in my compartment?”

“Can I include alarms from child compartments in the list?”

Tell an agent

List the alarms in compartment {compartmentId}.

Find alarms named {displayName} in compartment {compartmentId}.

POST /alarms Create a monitoring alarm on a metric query · Creates a new alarm in the specified compartment #

Ask an LLM

“How do I get notified when CPU utilization goes above a threshold in Oracle Cloud?”

“What severity levels and notification destinations can a new alarm use?”

Tell an agent

Create alarm {displayName} in {compartmentId} on {namespace} query {query}, severity {severity}, notifying {destinations}.

Set up an enabled alarm {displayName} watching metrics in compartment {metricCompartmentId} with query {query}.

GET /alarms/status See which alarms are firing in a compartment · List alarms status #

Ask an LLM

“Which of my alarms are currently firing?”

“Can I check alarm status for just one resource or service?”

Tell an agent

Show the current status of every alarm in compartment {compartmentId}.

List alarms with status {status} in compartment {compartmentId}.

DELETE /alarms/{alarmId} Delete an alarm · Deletes an alarm #

Ask an LLM

“How do I permanently remove an alarm I no longer need?”

“Can I delete an alarm by its OCID?”

Tell an agent destructive · confirm first

Delete alarm {alarmId}.

Permanently remove the monitoring alarm {alarmId}.

GET /alarms/{alarmId} Get the definition of one alarm · Get alarm #

Ask an LLM

“What query, threshold and destinations does a specific alarm use?”

“Is a given alarm enabled?”

Tell an agent

Show the configuration of alarm {alarmId}.

Get the query and severity for alarm {alarmId}.

PUT /alarms/{alarmId} Change an existing alarm's settings · Updates an alarm #

Ask an LLM

“Can I change the threshold query on an alarm I already created?”

“How do I disable an alarm without deleting it?”

Tell an agent

Change the query of existing alarm {alarmId} to {query}.

Set isEnabled to {isEnabled} on alarm {alarmId}.

POST /alarms/{alarmId}/actions/changeCompartment Move an alarm to another compartment · Change alarm compartment #

Ask an LLM

“Can I move an alarm into a different compartment in the same tenancy?”

“What's needed to relocate an alarm between compartments?”

Tell an agent

Move alarm {alarmId} to compartment {compartmentId}.

Relocate alarm {alarmId} into compartment {compartmentId}.

POST /alarms/{alarmId}/actions/removeSuppression Clear every suppression on an alarm · Removes any existing suppression for the specified alarm #

Ask an LLM

“How do I unmute an alarm and remove all of its suppressions at once?”

“Is there a way to lift any existing suppression on a single alarm?”

Tell an agent

Remove all suppressions from alarm {alarmId}.

Unmute alarm {alarmId} by clearing its suppression.

POST /alarms/{alarmId}/actions/retrieveDimensionStates Get the alarm status of each metric stream · Retrieve dimension states #

Ask an LLM

“Which specific metric streams or hosts are causing an alarm to fire?”

“Can I filter per-stream alarm states by dimension values?”

Tell an agent

Show the status of each metric stream for alarm {alarmId}.

List metric streams of alarm {alarmId} in status {status} matching dimensions {dimensionFilters}.

POST /alarms/{alarmId}/actions/summarizeAlarmSuppressionHistory Get the suppression history of an alarm · Summarize alarm suppression history #

Ask an LLM

“When has this alarm been suppressed in the past?”

“Can I see past suppressions of an alarm within a date range?”

Tell an agent

Summarize the suppression history of alarm {alarmId}.

Show suppressions of alarm {alarmId} that started on or after {timeSuppressFromGreaterThanOrEqualTo}.

GET /alarms/{alarmId}/history Get the state-change history of an alarm · Get alarm history #

Ask an LLM

“When did an alarm last fire and when did it recover?”

“Can I pull an alarm's state transitions within a time range?”

Tell an agent

Show the history of alarm {alarmId}.

Get {alarmHistorytype} history entries for alarm {alarmId} since {timestampGreaterThanOrEqualTo}.

POST /metrics Publish custom metric data points · Publishes raw metric data points to the Monitoring service #

Ask an LLM

“How do I send my own application metrics into Oracle Cloud Monitoring?”

“How far in the past or future can a posted data point's timestamp be?”

Tell an agent

Publish these custom metric data points: {metricData}.

Post metric data {metricData} with batch atomicity {batchAtomicity}.

POST /metrics/actions/listMetrics Find which metric definitions exist · List metrics based on matching criteria #

Ask an LLM

“What metrics are available to query in my compartment?”

“Can I list metric names within a single namespace, grouped by dimension?”

Tell an agent

List the metric definitions available in compartment {compartmentId}.

Show metric definitions in namespace {namespace} for compartment {compartmentId}.

POST /metrics/actions/summarizeMetricsData Query aggregated metric values over time · Summarizes and returns metrics data filtered using the provided query… #

Ask an LLM

“How do I get average CPU utilization for my instances over the last day?”

“Can I choose the resolution when pulling aggregated metric data?”

Tell an agent

Run metric query {query} in namespace {namespace} for compartment {compartmentId}.

Aggregate {query} from {namespace} in compartment {compartmentId} between {startTime} and {endTime}.

Documentation

📖

Documentation

https://docs.oracle.com/en-us/iaas/Content/Compute/home.htm

📖

Documentation

https://docs.oracle.com/en-us/iaas/Content/Object/home.htm

📖

Documentation

https://docs.oracle.com/en-us/iaas/Content/Network/Concepts/overview.htm

📖

Documentation

https://docs.oracle.com/en-us/iaas/Content/Database/home.htm

📖

Documentation

https://docs.oracle.com/en-us/iaas/Content/Identity/home.htm

📖

Documentation

https://docs.oracle.com/en-us/iaas/Content/ContEng/home.htm

📖

Documentation

https://docs.oracle.com/en-us/iaas/Content/Functions/home.htm

📖

Documentation

https://docs.oracle.com/en-us/iaas/Content/Monitoring/home.htm

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/openapi/oracle-cloud-monitoring-api-openapi.yml

Oracle Cloud Infrastructure Monitoring API

Operations 18

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification