Oracle Cloud Infrastructure Notification Control Plane API

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

Documentation GitHub OpenAPI

Operations 22

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 /publisherMapGroups List publisher map groups in a compartment · List publisher map groups #

Ask an LLM

“Which publisher map groups are set up in my compartment?”

“Where can I see all the groups that bundle my notification publisher maps?”

Tell an agent

List the publisher map groups in compartment {compartmentId}.

Show every publisher map group defined under compartment {compartmentId}.

POST /publisherMapGroups Create a publisher map group · Create publisher map group #

Ask an LLM

“How do I bundle several publisher maps into one group for notifications?”

“Can I create a publisher map group with a description and tags?”

Tell an agent

Create a publisher map group named {name} in compartment {compartmentId}.

Create publisher map group {name} in compartment {compartmentId} containing maps {publisherMapIds}.

DELETE /publisherMapGroups/{publisherMapGroupId} Delete a publisher map group · Delete publisher map group #

Ask an LLM

“How do I remove a publisher map group I no longer use?”

“Can I delete a publisher map group that has a lock on it?”

Tell an agent destructive · confirm first

Delete publisher map group {publisherMapGroupId}.

Delete publisher map group {publisherMapGroupId}, overriding its lock: {isLockOverride}.

GET /publisherMapGroups/{publisherMapGroupId} Get a publisher map group's configuration · Get publisher map group #

Ask an LLM

“Which publisher maps are included in a particular publisher map group?”

“What does a given publisher map group's configuration look like?”

Tell an agent

Get publisher map group {publisherMapGroupId}.

Show the maps inside publisher map group {publisherMapGroupId}.

PUT /publisherMapGroups/{publisherMapGroupId} Change the maps in a publisher map group · Update publisher map group #

Ask an LLM

“How do I change which publisher maps belong to a group?”

“Can I update a locked publisher map group by overriding its lock?”

Tell an agent

Set the publisher maps in group {publisherMapGroupId} to {publisherMapIds}.

Update the description of publisher map group {publisherMapGroupId} to {description}.

POST /publisherMapGroups/{publisherMapGroupId}/actions/addLock Lock a publisher map group · Adds a lock to a PublisherMapGroup resource #

Ask an LLM

“How do I protect a publisher map group from being changed or deleted?”

“Can I put a resource lock on a publisher map group?”

Tell an agent

Add a lock to publisher map group {publisherMapGroupId}.

Lock publisher map group {publisherMapGroupId} with {AddResourceLockDetails}.

POST /publisherMapGroups/{publisherMapGroupId}/actions/removeLock Unlock a publisher map group · Removes a lock to a PublisherMapGroup resource #

Ask an LLM

“How do I take the lock off a publisher map group?”

“Can I remove a delete-protection lock from a publisher map group?”

Tell an agent

Remove the lock from publisher map group {publisherMapGroupId}.

Unlock publisher map group {publisherMapGroupId} using {RemoveResourceLockDetails}.

GET /publisherMaps List publisher maps in a compartment · List publisher maps #

Ask an LLM

“What publisher maps exist in my compartment?”

“Where do I see the message body mappings set up for notifications?”

Tell an agent

List the publisher maps in compartment {compartmentId}.

Show all individual publisher maps under compartment {compartmentId}.

POST /publisherMaps Create a publisher map for message formatting · Create publisher map #

Ask an LLM

“How do I create a publisher map that maps a message body for a delivery provider?”

“Which provider name and version does a new publisher map need?”

Tell an agent

Create publisher map {name} in compartment {compartmentId} for provider {providerName} version {providerVersion} with body map {bodyMap}.

Add a publisher map named {name} for {providerName} {providerVersion} in compartment {compartmentId}, mapping {bodyMap}.

DELETE /publisherMaps/{publisherMapId} Delete a publisher map · Delete publisher map #

Ask an LLM

“How do I delete a single publisher map?”

“Is it possible to delete a publisher map that is locked?”

Tell an agent destructive · confirm first

Delete publisher map {publisherMapId}.

Remove publisher map {publisherMapId} with lock override set to {isLockOverride}.

GET /publisherMaps/{publisherMapId} Get a publisher map's configuration · Get publisher map #

Ask an LLM

“What body map does a specific publisher map apply?”

“Which provider and version is a particular publisher map for?”

Tell an agent

Get publisher map {publisherMapId}.

Show the body mapping in publisher map {publisherMapId}.

PUT /publisherMaps/{publisherMapId} Update a publisher map's body mapping · Update publisher map #

Ask an LLM

“How do I change the body mapping of an existing publisher map?”

“Can I edit a locked publisher map if I override the lock?”

Tell an agent

Replace the body map of publisher map {publisherMapId} with {bodyMap}.

Change publisher map {publisherMapId} description to {description}.

POST /publisherMaps/{publisherMapId}/actions/addLock Lock a publisher map · Adds a lock to a PublisherMap resource #

Ask an LLM

“How do I stop a publisher map from being deleted by accident?”

“Can I add a resource lock to an individual publisher map?”

Tell an agent

Protect the single publisher map {publisherMapId} with a lock.

Lock publisher map {publisherMapId} using {AddResourceLockDetails}.

POST /publisherMaps/{publisherMapId}/actions/removeLock Unlock a publisher map · Removes a lock to a PublisherMap resource #

Ask an LLM

“How do I remove the lock on a publisher map?”

“Can I release a resource lock from one publisher map?”

Tell an agent

Release the lock held on individual publisher map {publisherMapId}.

Unlock publisher map {publisherMapId} with {RemoveResourceLockDetails}.

GET /topics List notification topics in a compartment · List topics #

Ask an LLM

“What notification topics exist in my compartment?”

“Can I find a notification topic by its name?”

Tell an agent

List the notification topics in compartment {compartmentId}.

Find the topic named {name} in compartment {compartmentId}.

POST /topics Create a notification topic · Create topic #

Ask an LLM

“How do I create a topic in OCI Notifications to send alerts to?”

“Can a new notification topic have a description and tags?”

Tell an agent

Create a notification topic named {name} in compartment {compartmentId}.

Create topic {name} in compartment {compartmentId} described as {description}.

DELETE /topics/{topicId} Delete a notification topic · Delete topic #

Ask an LLM

“How do I delete a notification topic?”

“Can I delete a topic that has a lock on it?”

Tell an agent destructive · confirm first

Delete notification topic {topicId}.

Remove topic {topicId}, overriding locks: {isLockOverride}.

GET /topics/{topicId} Get a notification topic and its API endpoint · Get topic #

Ask an LLM

“How do I find the API endpoint of a notification topic for publishing?”

“What configuration does a specific notification topic have?”

Tell an agent

Get notification topic {topicId}.

Show the API endpoint for topic {topicId}.

PUT /topics/{topicId} Update a notification topic's description · Update topic #

Ask an LLM

“How do I change a notification topic's description?”

“Can I retag a topic that already exists?”

Tell an agent

Set the description of topic {topicId} to {description}.

Update notification topic {topicId} with description {description} and tags {freeformTags}.

POST /topics/{topicId}/actions/addLock Lock a notification topic · Adds a lock to a Topic resource #

Ask an LLM

“How do I protect a notification topic from deletion with a lock?”

“Can I add a resource lock to a topic?”

Tell an agent

Add a lock to topic {topicId}.

Lock notification topic {topicId} using {AddResourceLockDetails}.

POST /topics/{topicId}/actions/changeCompartment Move a notification topic to another compartment · Change topic compartment #

Ask an LLM

“How do I move a notification topic to a different compartment?”

“Can a topic be relocated within my tenancy?”

Tell an agent

Move topic {topicId} to compartment {compartmentId}.

Relocate notification topic {topicId} into compartment {compartmentId}.

POST /topics/{topicId}/actions/removeLock Unlock a notification topic · Removes a lock to a Topic resource #

Ask an LLM

“How do I remove a lock from a notification topic?”

“Can I unlock a topic so it can be deleted?”

Tell an agent

Remove the lock from topic {topicId}.

Unlock notification topic {topicId} with {RemoveResourceLockDetails}.

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-notificationcontrolplane-api-openapi.yml

Oracle Cloud Infrastructure Notification Control Plane API

Operations 22

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