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 Management Agent API

The managementAgent API from Oracle — 22 operation(s) for managementagent.

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

The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 34 operations across 22 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 20200202.

Requests are made against 2 base URLs: http://127.0.0.1/20200202, https://127.0.0.1/20200202.

34 operations 22 paths 42 schemas 5 DELETE20 GET5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20200202
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 34

Across 22 paths, the API surfaces 34 operations — 5 DELETE, 20 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

managementAgent 34
GET
/managementAgentCounts
Get Management Agent Count Summary
SummarizeManagementAgentCounts 7 params → 200400401404429500default
GET
/managementAgentImages
Return supported agent image information
ListManagementAgentImages 10 params → 200400401404409429500default
GET
/managementAgentInstallKeys
Gets a list of all Management Agent installed Keys in a compartment
ListManagementAgentInstallKeys 9 params → 200400401404429500default
POST
/managementAgentInstallKeys
Agent's install Key creation request with Management Agent Cloud Service.
CreateManagementAgentInstallKey 2 params body → 200400401404409429500default
DELETE
/managementAgentInstallKeys/{managementAgentInstallKeyId}
Delete a Management Agent install Key
DeleteManagementAgentInstallKey 3 params → 204400401404412429500default
GET
/managementAgentInstallKeys/{managementAgentInstallKeyId}
Get Management Agent install Key
GetManagementAgentInstallKey 2 params → 200400401404429500default
PUT
/managementAgentInstallKeys/{managementAgentInstallKeyId}
API to update the modifiable properties of the Management Agent install key.
UpdateManagementAgentInstallKey 4 params body → 200400401404409412429500
GET
/managementAgentInstallKeys/{managementAgentInstallKeyId}/content
Download file with Management Agent install Key
GetManagementAgentInstallKeyContent 3 params → 200400401404429500default
GET
/managementAgentPluginCounts
Get Management Agent Plugin Count Summary
SummarizeManagementAgentPluginCounts 5 params → 200400401404429500default
GET
/managementAgentPlugins
Gets a list of all ManagementAgentPlugins in a compartment
ListManagementAgentPlugins 10 params → 200400401404429500default
GET
/managementAgents
Gets a list of all Management Agent in a compartment
ListManagementAgents 20 params → 200400401404429500default
POST
/managementAgents/actions/deployPlugins
Deploys Plugins to a given list of agentIds
DeployPlugins 2 params body → 202400401404409429500default
GET
/managementAgents/actions/getAutoUpgradableConfig
Get the AutoUpgradable configuration for all agents in a tenancy.
GetAutoUpgradableConfig 2 params → 200400401404409429500default
POST
/managementAgents/actions/setAutoUpgradableConfig
Sets the AutoUpgradable configuration for all agents in a tenancy.
SetAutoUpgradableConfig 2 params body → 200400401404409429500default
GET
/managementAgents/namedCredentialsMetadata
Return the Metadata definition for Named Credentials supported by Management Agent.
GetNamedCredentialsMetadatum 3 params → 200400401404429500default
DELETE
/managementAgents/{managementAgentId}
Delete a provisioned Management Agent
DeleteManagementAgent 3 params → 204400401404412429500default
GET
/managementAgents/{managementAgentId}
Get Management Agent
GetManagementAgent 2 params → 200400401404429500default
PUT
/managementAgents/{managementAgentId}
API to update the console managed properties of the Management Agent.
UpdateManagementAgent 4 params body → 200400401404409412429500
GET
/managementAgents/{managementAgentId}/availabilityHistories
Lists the availability history records of Management Agent
ListAvailabilityHistories 8 params → 200400401404429500default
GET
/managementAgents/{managementAgentId}/dataSources
A list of Management Agent Data Sources for the given Management Agent Id.
ListDataSources 7 params → 200400401404429500default
POST
/managementAgents/{managementAgentId}/dataSources
Datasource creation request to given Management Agent.
CreateDataSource 4 params body → 202400401404409412429500
DELETE
/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}
Datasource delete request to given Management Agent.
DeleteDataSource 4 params → 202400401404412429500default
GET
/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}
Get Datasource details for given Id.
GetDataSource 4 params → 200400401404409412429500
PUT
/managementAgents/{managementAgentId}/dataSources/{dataSourceKey}
Datasource update request to given Management Agent.
UpdateDataSource 5 params body → 202400401404409412429500
GET
/namedCredentials
A list of Management Agent Named Credentials for the given Management Agent Id.
ListNamedCredentials 10 params → 200400401404429500default
POST
/namedCredentials
Named credential creation request to given Management Agent.
CreateNamedCredential 3 params body → 201400401404409412429500
DELETE
/namedCredentials/{namedCredentialId}
Named credential delete request to for associated Management Agent.
DeleteNamedCredential 3 params → 202400401404412429500default
GET
/namedCredentials/{namedCredentialId}
Get Named credential details for given name.
GetNamedCredential 3 params → 200400401404409412429500
PUT
/namedCredentials/{namedCredentialId}
Named credential update request.
UpdateNamedCredential 4 params body → 202400401404409412429500
GET
/workRequests
List Work Requests
ListWorkRequests 10 params → 200400401404429500default
DELETE
/workRequests/{workRequestId}
Cancel Work Request
DeleteWorkRequest 3 params → 204400401404412429500default
GET
/workRequests/{workRequestId}
GET Work Request Status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Lists work request errors
ListWorkRequestErrors 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Lists work request logs
ListWorkRequestLogs 6 params → 200400401404429500default

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are ManagementAgent (27 properties), ManagementAgentSummary (26 properties), ManagementAgentInstallKey (16 properties), ManagementAgentInstallKeySummary (14 properties). Each schema is shown below with its type and property counts.

WorkRequestSummary
object
A description of workrequest status
9 properties 6 required
ManagementAgentAggregationCollection
object
The summary of Management Agent count items
1 property 1 required
DataSourceSummary
object
The information about the dataSources that agent is associated to.
3 properties 3 required
ManagementAgentPluginAggregationCollection
object
The summary of Management Agent Plugin count items
1 property 1 required
UpdateManagementAgentInstallKeyDetails
object
Details required to change Management Agent install key.
2 properties
UpdateManagementAgentDetails
object
Details required to update console-managed properties of the Management Agent.
3 properties
CreateManagementAgentInstallKeyDetails
object
The information about new Management Agent install Key.
5 properties 2 required
ManagementAgentInstallKey
object
The details of the Agent install Key
16 properties 2 required
CreateDataSourceDetails
object
A new data source.
3 properties 3 required
NamedCredentialFieldDefinition
object
A named credential field metadata definition
7 properties 3 required
ManagementAgentAggregation
object
A count of Management Agents sharing the values for specified dimensions.
2 properties
ManagementAgent
object
The details of the Management Agent inventory including the associated plugins.
27 properties 3 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties 3 required
ManagementAgentProperty
object
Property item in name/value pair, with optional unit type.
3 properties 2 required
DataSourceSummaryItem
object
The information about the dataSources that agent is associated to.
3 properties 3 required
ManagementAgentError
object
Error Information.
2 properties 2 required
ManagementAgentInstallKeySummary
object
The summary of the Agent Install Key details.
14 properties 2 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties 2 required
NamedCredentialCollection
object
Results of a Named Credential list request.
1 property 1 required
CreateNamedCredentialDetails
object
A representation of a named credential subresource for the Management Agent resource.
7 properties 4 required
UpdateDataSourceDetails
object
A request to change the data source.
1 property 1 required
NamedCredentialProperty
object
Property item in name/value pair
3 properties 3 required
ManagementAgentPluginDetails
object
The information about the current management agent plugins that agent is having.
7 properties 1 required
ManagementAgentImageSummary
object
Supported Agent downloads
11 properties 3 required
WorkRequest
object
A description of workrequest status
9 properties 7 required
AutoUpgradableConfig
object
The tenancy-level agent AutoUpgradable configuration.
1 property 1 required
ManagementAgentPluginAggregationDimensions
object
The Aggregation of Management Agent Plugin Dimensions
2 properties
DataSource
object
A representation of a source configuration setup in the Management Agent.
7 properties 7 required
ManagementAgentPluginSummary
object
Summary of the ManagementAgentPlugin.
8 properties 3 required
WorkRequestResource
object
A resource created or operated on by a work request.
11 properties 3 required
NamedCredentialsMetadatum
object
Supported named credentials for the given management agent.
1 property 1 required
AvailabilityHistorySummary
object
Availability history of Management Agent.
4 properties 2 required
ManagementAgentPluginAggregation
object
A count of Management Agents Plugins sharing the values for specified dimensions.
2 properties
SetAutoUpgradableConfigDetails
object
Details for configuring tenancy-level agent AutoUpgradable configuration.
2 properties 2 required
ObjectDetails
object
Details of the Objectstorage object
5 properties 3 required
NamedCredentialSummary
object
A representation of a named credential in the Management Agent.
12 properties 9 required
DeployPluginsDetails
object
The information required to deploy new Management Agent Plugins.
3 properties 3 required
UpdateNamedCredentialDetails
object
A representation of a named credential in the Management Agent.
4 properties 1 required
NamedCredential
object
A representation of a named credential in the Management Agent.
12 properties 7 required
ManagementAgentAggregationDimensions
object
The Aggregation of Management Agent Dimensions
5 properties
ManagementAgentSummary
object
The summary of the Management Agent inventory including the associated plugins.
26 properties 3 required
NamedCredentialMetadataDefinition
object
A named credential metadata definition
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-managementagent-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 Management Agent 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.