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 Opensearch Cluster Pipeline API

The opensearchClusterPipeline API from Oracle — 4 operation(s) for opensearchclusterpipeline.

Oracle Opensearch Cluster Pipeline 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 7 operations across 4 paths, and defines 7 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.

7 operations 4 paths 7 schemas 1 DELETE2 GET3 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 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

opensearchClusterPipeline 7
GET
/opensearchClusterPipelines
Gets a list of all OpensearchClusterPipelines in a compartment
ListOpensearchClusterPipelines 10 params → 200400401404429500default
POST
/opensearchClusterPipelines
Creates a new OpensearchCluster Pipeline
CreateOpensearchClusterPipeline 3 params body → 202204400401404409429500
DELETE
/opensearchClusterPipelines/{opensearchClusterPipelineId}
Delete a provisioned OpensearchCluster Pipeline
DeleteOpensearchClusterPipeline 3 params → 202400401404412429500default
GET
/opensearchClusterPipelines/{opensearchClusterPipelineId}
Get OpensearchCluster Pipeline
GetOpensearchClusterPipeline 2 params → 200400401404429500default
PUT
/opensearchClusterPipelines/{opensearchClusterPipelineId}
Update the OpensearchCluster Pipeline identified by the id
UpdateOpensearchClusterPipeline 4 params body → 202204400401404412429500
POST
/opensearchClusterPipelines/{opensearchClusterPipelineId}/actions/startPipeline
Start the pipeline.
StartPipeline 4 params → 202400401404409412429500
POST
/opensearchClusterPipelines/{opensearchClusterPipelineId}/actions/stopPipeline
Stop the pipeline.
StopPipeline 4 params → 202400401404409412429500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are OpensearchClusterPipeline (24 properties), OpensearchClusterPipelineSummary (18 properties), CreateOpensearchClusterPipelineDetails (16 properties), UpdateOpensearchClusterPipelineDetails (15 properties). Each schema is shown below with its type and property counts.

CreateOpensearchClusterPipelineDetails
object
The configuration details for a new OpenSearch cluster pipeline.
16 properties 7 required
UpdateOpensearchClusterPipelineDetails
object
The configuration to update on an existing OpenSearch cluster pipeline. You can only edit capacity limits and pipeline configurations. You can't edit its netwo…
15 properties 1 required
OpensearchClusterPipeline
object
An OpenSearch cluster Pipeline resource. An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more i…
24 properties 16 required
OpensearchClusterPipelineCollection
object
The list of cluster pipelines returned in a cluster pipeline search.
1 property 1 required
OpensearchPipelineReverseConnectionEndpoint
object
The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.
2 properties 2 required
OpensearchClusterPipelineSummary
object
The summary of information about an OpenSearch cluster Pipeline.
18 properties 10 required
Error
object
Error Information.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-opensearchclusterpipeline-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 Opensearch Cluster Pipeline 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.