Oracle Management Cloud Common REST API

All REST Endpoints

Common APIs/Entities

Entities represent a monitored resource such as a database, a host, or an application server, other entity types may be created using the Entity Types API. Each entity instance is of a specific entity type. Entities may have data collected about them, which is represented as metrics.

Create or Update an Entity: Method: post
Path: /serviceapi/entityModel/uds/entities
Delete an Entity: Method: delete
Path: /serviceapi/entityModel/uds/entities
Get Entities: Method: get
Path: /serviceapi/entityModel/uds/entities
Query Entities: Method: post
Path: /serviceapi/entityModel/uds/entities/query

Common APIs/EntityTypes

Entity Types describe the characteristics of the entities, such as name and metrics.

Create or Update an Entity Type: Method: post
Path: /serviceapi/entityModel/uds/entityTypes
Delete an entity type and/or optional metric type: Method: delete
Path: /serviceapi/entityModel/uds/entityTypes
Get an Entity Type: Method: get
Path: /serviceapi/entityModel/uds/entityTypes/{entityType}
Get Entity Types: Method: get
Path: /serviceapi/entityModel/uds/entityTypes

Common APIs/Groups

Groups are an efficient way to organize, manage, and query the entities and entity types in your environment using Tags.

Create a Group: Method: post
Path: /serviceapi/entityModel/uds/groups
Delete a Group: Method: delete
Path: /serviceapi/entityModel/uds/groups/{groupName}
Get Group Members: Method: get
Path: /serviceapi/entityModel/uds/groups/{groupName}/members
Get Groups: Method: get
Path: /serviceapi/entityModel/uds/groups

Common APIs/Metrics

Metrics represent the information monitored by Oracle Management Cloud. The Metrics API lets you upload and query your metrics. The following functions are supported:

STDDEV
MAX
MEDIAN
MIN
PERCENTILE_DISC
LAST_VALUE
FIRST_VALUE
AVG

Get metric timeseries: Method: get
Path: /serviceapi/entityModel/uds/metrics
Get records for batch metric upload: Method: get
Path: /serviceapi/entityModel/uds/metrics/status/{ecId}/records
Get status for batch metric upload: Method: get
Path: /serviceapi/entityModel/uds/metrics/status/{ecId}
Upload metrics: Method: post
Path: /serviceapi/entityModel/uds/metrics

Common APIs/Tags

Tags are the way to categorize, search, and sort entities and entity types attached to them.

Creates tags: Method: post
Path: /serviceapi/entityModel/uds/tags
Delete tags: Method: delete
Path: /serviceapi/entityModel/uds/tags
Query tags: Method: get
Path: /serviceapi/entityModel/uds/tags

Working with Agents

Oracle Management Cloud agents collect configuration, performance, availability, and log data from monitored entities and make this information available in Oracle Management Cloud. This set of endpoints will help you in managing the status of agents.

De-install a Single Agent by AgentId: Method: delete
Path: /serviceapi/agentlifecycle/deinstall/{agenttype}/id/{agentId}
De-install a Single Agent by Name: Method: delete
Path: /serviceapi/agentlifecycle/deinstall/{agenttype}/name/{agentname}
De-install all Agents: Method: delete
Path: /serviceapi/agentlifecycle/deinstall/{agenttype}/all/
De-install Multiple Agents by AgentId: Method: delete
Path: /serviceapi/agentlifecycle/deinstall/{agenttype}/id/
De-install Multiple Agents by Name: Method: delete
Path: /serviceapi/agentlifecycle/deinstall/{agenttype}/name/
Delete a Single Agent by AgentId: Method: delete
Path: /serviceapi/agentlifecycle/delete/{agenttype}/id/{agentId}
Delete a Single Agent by Name: Method: delete
Path: /serviceapi/agentlifecycle/delete/{agenttype}/name/{agentname}
Delete all Agents: Method: delete
Path: /serviceapi/agentlifecycle/delete/{agenttype}/all/
Delete Multiple Agents by AgentId: Method: delete
Path: /serviceapi/agentlifecycle/delete/{agenttype}/id/
Delete Multiple Agents by Name: Method: delete
Path: /serviceapi/agentlifecycle/delete/{agenttype}/name/
Get agent information for a tenant: Method: get
Path: /serviceapi/entityModel/data/entities/agents
Upgrade a Single Agent by Id: Method: put
Path: /serviceapi/agentlifecycle/upgrade/{agenttype}/id/{agentId}
Upgrade a Single Agent by Name: Method: put
Path: /serviceapi/agentlifecycle/upgrade/{agenttype}/name/{agentname}
Upgrade all Agents: Method: put
Path: /serviceapi/agentlifecycle/upgrade/{agenttype}/all/
Upgrade Multiple Agents by AgentId: Method: put
Path: /serviceapi/agentlifecycle/upgrade/{agenttype}/id/
Upgrade Multiple Agents by Name: Method: put
Path: /serviceapi/agentlifecycle/upgrade/{agenttype}/name/

Working with Alerts

Oracle Management Cloud provides comprehensive monitoring for all your applications. This REST API provides a simple programmatic way to query alerts data.

Clear the alert: Method: post
Path: /serviceapi/eventServices/alerts/{alertId}/actions/clear
Get alert history: Method: get
Path: /serviceapi/eventServices/alerts/{alertId}/history
Get alerts: Method: get
Path: /serviceapi/eventServices/alerts
Get details of the alert: Method: get
Path: /serviceapi/eventServices/alerts/{alertId}
Get details of the associated tickets for the alert: Method: get
Path: /serviceapi/eventServices/alerts/{alertId}/tickets

Working with Dashboards

Dashboards are a way to visualize your information at a glance. This set of endpoints will help you in managing dashboard access privileges.

Export Dashboard: Method: put
Path: /serviceapi/dashboards.service/export
Import Dashboard: Method: put
Path: /serviceapi/dashboards.service/import
List Dashboard History: Method: get
Path: /serviceapi/dashboardModel/history/dashboards/{dashboardId}
List Dashboard Privileges: Method: get
Path: /serviceapi/dashboardModel/privilege/dashboards/{dashboardId}
List Dashboard User History: Method: get
Path: /serviceapi/dashboardModel/history/users/{userName}
List Widget History: Method: get
Path: /serviceapi/savedsearchModel/history/searches/{searchId}
List Widget Privileges: Method: get
Path: /serviceapi/savedsearchModel/privilege/searches/{searchId}
List Widget User History: Method: get
Path: /serviceapi/savedsearchModel/history/users/{userName}
Revoke Dashboard Privilege: Method: delete
Path: /serviceapi/dashboardModel/privilege/{id}
Revoke Widget Privilege: Method: delete
Path: /serviceapi/savedsearchModel/privilege/{id}
Update Dashboard Privilege: Method: put
Path: /serviceapi/dashboardModel/privilege/
Update Widget Privilege: Method: put
Path: /serviceapi/savedsearchModel/privilege

Working with Licenses

The Licenses API is used to administer licensing tasks related to entities in your infrastructure.

Change default licenses for tenant: Method: post
Path: /serviceapi/entityModel/metadata/entityTypes/license
Change License Package for Entities: Method: post
Path: /serviceapi/entityModel/data/entities/license
Get default license for tenant: Method: get
Path: /serviceapi/entityModel/metadata/entityTypes/license
Get License Infomation: Method: get
Path: /serviceapi/entityModel/data/entities/license/summary
Query entities: Method: get
Path: /serviceapi/entityModel/data/entities/license

Working with Log Analytics/Content

The operations from the Working with Log Analytics/Content category.

Export Source: Method: post
Path: /serviceapi/logan.content/export
Import Source: Method: post
Path: /serviceapi/logan.content/import

Working with Log Analytics/Query

The Query API is primarily used by consumers like the search UI to execute queries and return results. In addition, the service also provides support for manipulations of the query as might be needed when editing the query or building variations of a query to create additional related views of the data.

Perform search (JSON): Method: post
Path: /serviceapi/querylanguage.query
Perform search (Stream): Method: post
Path: /serviceapi/querylanguage.export

Working with Log Analytics/Upload

The On-Demand Upload API lets a customer upload, query, and manipulate a file or archive of files into Log Analytics.

Delete Upload: Method: delete
Path: /serviceapi/logan.uploads/{uploadId}
Delete Upload or File: Method: delete
Path: /serviceapi/logan.uploads
Perform Upload: Method: post
Path: /serviceapi/logan.uploads
Search Uploads: Method: post
Path: /serviceapi/logan.uploads/searches
View All Instances: Method: get
Path: /serviceapi/logan.uploads/{uploadId}/instances
View All Uploads: Method: get
Path: /serviceapi/logan.uploads
View An Instance of an Upload: Method: get
Path: /serviceapi/logan.uploads/{uploadId}/instances/{instanceId}
View An Upload: Method: get
Path: /serviceapi/logan.uploads/{uploadId}

Working with Maintenance Activities

The Maintenance Activities API is used to administer maintenance activity tasks.

Create a Maintenance Activity: Method: post
Path: /serviceapi/entityModel/data/entities/maintenances
Delete a given maintenance activity: Method: delete
Path: /serviceapi/entityModel/data/entities/maintenances/{maintenanceId}
Get details of a given maintenance activity: Method: get
Path: /serviceapi/entityModel/data/entities/maintenances/{maintenanceId}
List maintenance activities: Method: get
Path: /serviceapi/entityModel/data/entities/maintenances
Stop a given maintenance activity: Method: post
Path: /serviceapi/entityModel/data/entities/maintenances/{maintenanceId}/actions/stopMaintenance