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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Oracle

Oracle Opensearch Cluster API

The opensearchCluster API from Oracle — 16 operation(s) for opensearchcluster.

Documentation Provider Profile APIs.io OpenAPI GitHub

Oracle Opensearch Cluster 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 19 operations across 16 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 20180828.

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

19 operations 16 paths 35 schemas 1 DELETE9 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 19

Across 16 paths, the API surfaces 19 operations — 1 DELETE, 9 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

opensearchCluster 19
GET
/opensearch/versions
List Opensearch Versions
ListOpensearchVersions 3 params → 200400401404429500default
GET
/opensearchClusters
Gets a list of all OpensearchClusters in a compartment
ListOpensearchClusters 9 params → 200400401404429500default
POST
/opensearchClusters
Creates a new OpensearchCluster
CreateOpensearchCluster 2 params body → 202400401404409429500default
DELETE
/opensearchClusters/{opensearchClusterId}
Delete a provisioned OpensearchCluster
DeleteOpensearchCluster 3 params → 202400401404412429500default
GET
/opensearchClusters/{opensearchClusterId}
Get OpensearchCluster
GetOpensearchCluster 2 params → 200400401404429500default
PUT
/opensearchClusters/{opensearchClusterId}
Update the OpensearchCluster identified by the id
UpdateOpensearchCluster 3 params body → 202400401404412429500default
POST
/opensearchClusters/{opensearchClusterId}/actions/backup
Backup the opensearch cluster.
BackupOpensearchCluster 4 params body → 202400401404409412429500
POST
/opensearchClusters/{opensearchClusterId}/actions/configureOutboundCluster
Configure Outbound cluster for cross-cluster operations
ConfigureOutboundCluster 4 params body → 202400401404409412429500
POST
/opensearchClusters/{opensearchClusterId}/actions/configureRemote
Configure the cluster to work remotely.
ConfigureRemoteCluster 4 params body → 202400401404409412429500
POST
/opensearchClusters/{opensearchClusterId}/actions/resizeHorizontal
Resize the opensearch cluster horizontal details.
ResizeOpensearchClusterHorizontal 4 params body → 202400401404409412429500
POST
/opensearchClusters/{opensearchClusterId}/actions/resizeVertical
Resize the opensearch cluster vertical details.
ResizeOpensearchClusterVertical 4 params body → 202400401404409412429500
POST
/opensearchClusters/{opensearchClusterId}/actions/restore
Restore the opensearch cluster.
OpensearchClusterRestore 4 params body → 202400401404409412429500
POST
/opensearchClusters/{opensearchClusterId}/actions/upgrade
Upgrade the opensearch Cluster.
UpgradeOpenSearchCluster 4 params body → 202400401404409412429500
GET
/opensearchClusters/{opensearchClusterId}/internal
Get OpensearchCluster Internal Details
GetOpensearchClusterInternalDetails 2 params → 200400401404429500default
GET
/shapes
Retrieves available OpenSearch Cluster node shapes.
ListOpensearchClusterShapes → 200400401404429500default
GET
/workRequests
List Work Requests
ListWorkRequests 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}
GET Work Request Status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Lists work request errors
ListWorkRequestErrors 4 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Lists work request logs
ListWorkRequestLogs 4 params → 200400401404429500default

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are OpensearchCluster (52 properties), CreateOpensearchClusterDetails (39 properties), OpensearchClusterSummary (18 properties), UpdateOpensearchClusterDetails (14 properties). Each schema is shown below with its type and property counts.

ShapesDetails
object
Shapes for OpenSearch Cluster.
1 property
OpensearchVersionsSummary
object
A description of Opensearch versions
1 property 1 required
OpensearchClusterInternalDetails
object
This is the ClusterLoadBalancer which can store the State of the cluster, opensearchLoadbalancerIps, remoteLoadbalancerIps
6 properties 3 required
WorkRequestErrorCollection
object
The list of work request errors returned in a work request error search.
1 property 1 required
OpensearchVersionsCollection
object
The list of OpenSearch versions returned in an OpenSearch version search.
1 property 1 required
WorkRequestError
object
An error encountered while executing an operation that is tracked by a work request.
3 properties 3 required
SecuritySamlConfig
object
SAML policy is optionally used for Opensearch cluster to config SAML authentication
7 properties 3 required
WorkRequest
object
An asynchronous work request.
9 properties 7 required
CertificateConfig
object
Custom certificate config.
4 properties
OutboundClusterSummary
object
Contains details of a Outbound cluster
5 properties 2 required
WorkRequestLogEntryCollection
object
The list of work request log entries returned in a work request log search.
1 property 1 required
ResizeOpensearchClusterVerticalDetails
object
The OCPU and memory configuration to update on an existing OpenSearch cluster for [vertical resizing](/iaas/Content/search-opensearch/Tasks/resizingacluster.ht…
12 properties
OpensearchClusterSummary
object
The summary of information about an OpenSearch cluster.
18 properties 4 required
LoadBalancerConfig
object
This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers.
3 properties 1 required
ConfigureOutboundClusterDetails
object
Details for configuring the cluster to work as an Outbound cluster
1 property 1 required
BackupOpensearchClusterDetails
object
Information about an OpenSearch cluster backup.
2 properties 2 required
RestoreOpensearchClusterDetails
object
Information about the OpenSearch cluster backup to restore.
3 properties 2 required
OpensearchCluster
object
An OpenSearch cluster resource. An OpenSearch cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more…
52 properties 28 required
RemoteClusterSummary
object
This config is used to pass request information to add remote cluster/s to the coordinating cluster which in this case is the cluster from which request is ori…
5 properties 2 required
RemoteClusterConfig
object
This config is used to pass request information to add remote cluster/s to the coordinating cluster which in this case is the cluster from which request is ori…
2 properties 2 required
Error
object
Error Information.
2 properties 2 required
WorkRequestCollection
object
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
1 property 1 required
UpgradeOpenSearchClusterDetails
object
Minor or major version upgrade of a cluster.
7 properties 3 required
OpensearchClusterCollection
object
The list of OpenSearch clusters returned in a cluster search.
1 property 1 required
MaintenanceDetails
object
Details for the maintenance activity.
4 properties 1 required
WorkRequestLogEntry
object
A log message from executing an operation that is tracked by a work request.
2 properties 2 required
ResizeOpensearchClusterHorizontalDetails
object
The node count configuration to update on an existing OpenSearch cluster for [horizontal resizing](/iaas/Content/search-opensearch/Tasks/resizingacluster.htmho…
5 properties
UpdateOpensearchClusterDetails
object
The configuration to update on an existing OpenSearch cluster. Software version and security config are not allowed to be updated at the same time.
14 properties 1 required
BackupPolicy
object
Backup policy as optionally used for Opensearch cluster.
3 properties
CreateOpensearchClusterDetails
object
The configuration details for a new OpenSearch cluster.
39 properties 19 required
OutboundClusterConfig
object
This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)
2 properties 2 required
UpdateMaintenanceDetails
object
Details for update of maintenance details
1 property
WorkRequestResource
object
A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
4 properties 3 required
CreateMaintenanceDetails
object
Details for creation of maintenance details
1 property
ConfigureRemoteClusterDetails
object
Details for configuring the cluster to work as remote cluster.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-opensearchcluster-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
AE Profile APIs.io
Oracle Integration Cloud API
AE Profile APIs.io
Oracle Fusion Cloud Applications API
AE Profile APIs.io
Oracle Fusion Cloud Financials REST API
AE Profile APIs.io
Oracle Fusion Cloud HCM REST API
AE Profile APIs.io
Oracle Fusion Cloud CX Sales and Service REST API
AE Profile APIs.io
Oracle Fusion Cloud SCM REST API
AE Profile APIs.io
Oracle Fusion Cloud Procurement REST API
AE Profile APIs.io
Oracle Content Management API
AE Profile APIs.io
OCI Generative AI API
AE Profile APIs.io
OCI AI Vision API
AE Profile APIs.io
OCI AI Language API
AE Profile APIs.io
← Back to O APIs
API Details
ID
oracle:oracle-opensearchcluster-api
Base URL
https://{host}:{port}/ords/
Docs
https://docs.oracle.com/en/database/oracle/oracle-database/
Provider
Oracle
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=oracle-opensearchcluster-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/oracle-opensearchcluster-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Oracle Opensearch Cluster 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.