Oracle Container Engine API
API operations for working with the container engine service.
Oracle Container Engine 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 50 operations across 34 paths, and defines 97 schemas. It is described by OpenAPI 3.2.0, at version 20180222.
Requests are made against a single base URL, /20180222.
50 operations
34 paths
97 schemas
7 DELETE23 GET15 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 50
Across 34 paths, the API surfaces 50 operations — 7 DELETE, 23 GET, 15 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
containerEngine 50
API operations for working with the container engine service.
GET
/addonOptions
Get list of supported addons for a specific kubernetes version.
GET
/clusterOptions/{clusterOptionId}
Get cluster options.
GET
/clusters
List all cluster objects.
POST
/clusters
Create a new cluster.
DELETE
/clusters/{clusterId}
Delete a cluster.
GET
/clusters/{clusterId}
Get cluster details.
PUT
/clusters/{clusterId}
Update cluster details.
POST
/clusters/{clusterId}/actions/completeCredentialRotation
Complete cluster credential rotation.
POST
/clusters/{clusterId}/actions/extendEndpointDecommissionRollbackDeadline
Extend the rollback deadline of public api endpoint decommission for a cluster.
POST
/clusters/{clusterId}/actions/migrateToNativeVcn
Initiates cluster migration to use native VCN.
POST
/clusters/{clusterId}/actions/rollbackPublicApiEndpointDecommission
Rollback public api endpoint decommission for a cluster.
POST
/clusters/{clusterId}/actions/startCredentialRotation
Start cluster credential rotation.
POST
/clusters/{clusterId}/actions/startPublicApiEndpointDecommission
Start public api endpoint decommission for a cluster.
POST
/clusters/{clusterId}/actions/updateEndpointConfig
Update cluster endpoint details.
GET
/clusters/{clusterId}/addons
List addon for a cluster.
POST
/clusters/{clusterId}/addons
Install addon for a cluster.
DELETE
/clusters/{clusterId}/addons/{addonName}
Disable addon for a cluster.
GET
/clusters/{clusterId}/addons/{addonName}
Get addon details.
PUT
/clusters/{clusterId}/addons/{addonName}
Update addon details for a cluster.
GET
/clusters/{clusterId}/credentialRotationStatus
Get cluster credential rotation status.
POST
/clusters/{clusterId}/kubeconfig/content
Create the cluster kubeconfig.
GET
/clusters/{clusterId}/migrateToNativeVcnStatus
Get details on a cluster's migration to native VCN.
POST
/clusters/{clusterId}/nodes/{nodeId}/actions/reboot
perform reboot action to node in cluster
POST
/clusters/{clusterId}/nodes/{nodeId}/actions/replaceBootVolume
perform boot volume replacement action to node in cluster
GET
/clusters/{clusterId}/publicApiEndpointDecommissionStatus
Get cluster public api endpoint decommission status.
GET
/clusters/{clusterId}/workloadMappings
List workloadMappings for a cluster.
POST
/clusters/{clusterId}/workloadMappings
Create workloadMapping for a cluster.
DELETE
/clusters/{clusterId}/workloadMappings/{workloadMappingId}
Delete workloadMapping for a cluster.
GET
/clusters/{clusterId}/workloadMappings/{workloadMappingId}
Get workloadMapping details.
PUT
/clusters/{clusterId}/workloadMappings/{workloadMappingId}
Update workloadMapping details for a cluster.
GET
/nodePoolOptions/{nodePoolOptionId}
Get node pool options.
GET
/nodePools
List all node pools.
POST
/nodePools
Create a new node pool.
DELETE
/nodePools/{nodePoolId}
Delete a node pool.
GET
/nodePools/{nodePoolId}
Get node pool details.
PUT
/nodePools/{nodePoolId}
Update node pool details.
DELETE
/nodePools/{nodePoolId}/node/{nodeId}
Delete node.
GET
/podShapes
List Pod Shapes.
GET
/virtualNodePools
List all virtual node pools.
POST
/virtualNodePools
Create a new virtual node pool.
DELETE
/virtualNodePools/{virtualNodePoolId}
Delete a virtual node pool.
GET
/virtualNodePools/{virtualNodePoolId}
Get virtual node pool details.
PUT
/virtualNodePools/{virtualNodePoolId}
Update virtual node pool details.
GET
/virtualNodePools/{virtualNodePoolId}/virtualNodes
List virtual nodes in a virtual node pool.
GET
/virtualNodePools/{virtualNodePoolId}/virtualNodes/{virtualNodeId}
Get virtual node details.
GET
/workRequests
List all work requests.
DELETE
/workRequests/{workRequestId}
Cancel a work request.
GET
/workRequests/{workRequestId}
Get work request details.
GET
/workRequests/{workRequestId}/errors
Get work request errors.
GET
/workRequests/{workRequestId}/logs
Get work request logs.
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are NodePool (28 properties), NodePoolSummary (26 properties), CreateNodePoolDetails (21 properties), Cluster (21 properties). Each schema is shown below with its type and property counts.
WorkloadMappingSummary
object
The properties that define an workloadMapping summary.
10 properties
7 required
ShapeMemoryOptions
object
Memory properties.
5 properties
NodePoolSummary
object
The properties that define a node pool summary.
26 properties
ClusterCreateOptions
object
The properties that define extra options for a cluster.
9 properties
UpdateNodeShapeConfigDetails
The shape configuration of the nodes.
WorkRequestSummary
object
The properties that define a work request summary.
8 properties
NodeEvictionSettings
object
Node Eviction Configuration
2 properties
ShapeOcpuOptions
object
Properties of OCPUs.
2 properties
UpdateNodePoolNodeConfigDetails
object
The size and placement configuration of nodes in the node pool.
8 properties
RebootClusterNodeDetails
object
The properties that define a node reboot action.
1 property
UpdateWorkloadMappingDetails
object
The properties that define a workloadMapping
3 properties
NodePoolSecondaryVnicDetails
object
Details for secondary vnic attachments to Nodes
3 properties
1 required
UpdateClusterDetails
object
The properties that define a request to update a cluster.
7 properties
StartCredentialRotationDetails
object
Properties that define a request to start credential rotation on a kubernetes cluster.
1 property
1 required
PersistentVolumeConfigDetails
object
Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)
2 properties
ClusterSummary
object
The properties that define a cluster summary.
18 properties
VirtualNodeTags
object
The tags associated to the virtual nodes in this virtual node pool.
2 properties
KubernetesNetworkConfig
object
The properties that define the network configuration for Kubernetes.
2 properties
OpenIdConnectDiscovery
object
The property that define the status of the OIDC Discovery feature for a cluster.
1 property
Taint
object
taints
3 properties
NodeEvictionNodePoolSettings
object
Node Eviction Details configuration
3 properties
ClusterOptions
object
Options for creating or updating clusters.
2 properties
WorkRequestError
object
Errors related to a specific work request.
3 properties
3 required
ShapeNetworkBandwidthOptions
object
Properties of network bandwidth.
3 properties
PreemptibleNodeConfigDetails
object
Configuration options for preemptible nodes.
1 property
1 required
NodePoolPrimaryVnicDetails
object
Details for node's primary VNIC
1 property
AddOnOptions
object
The properties that define options for supported add-ons.
2 properties
AddonVersionConfiguration
object
Addon version configuration details.
5 properties
UpdateVirtualNodePoolDetails
object
The properties that define a request to update a virtual node pool.
11 properties
UpdateNodePoolDetails
object
The properties that define a request to update a node pool.
18 properties
CycleMode
string
BOOTVOLUMEREPLACE cycling swaps the boot volume on the same node, while INSTANCEREPLACE cycling deletes and recreates a new node with the changes applied. Only…
CreateNodeShapeConfigDetails
The shape configuration of the nodes.
ClusterEndpoints
object
The properties that define endpoints for a cluster.
5 properties
AddonOptionSummary
object
The properties that define addon summary.
11 properties
4 required
Ipv6AddressIpv6SubnetCidrPairDetails
object
Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses
2 properties
ClusterPodNetworkOptionDetails
object
The CNI type and relevant network details potentially applicable to the node pools of the cluster
1 property
1 required
Cluster
object
A Kubernetes cluster. Avoid entering confidential information.
21 properties
NodeSourceDetails
object
The details of the node's source.
1 property
1 required
ImagePolicyConfig
object
The properties that define a image verification policy.
2 properties
ClusterEndpointConfig
object
The properties that define the network configuration for the Cluster endpoint.
4 properties
ClusterMigrateToNativeVcnDetails
object
The properties that define a request to migrate a cluster to Native VCN.
2 properties
1 required
WorkRequestLogEntry
object
Log entries related to a specific work request.
2 properties
NodeShapeConfig
object
The shape configuration of the nodes.
2 properties
UpdateClusterEndpointConfigDetails
object
The properties that define a request to update a cluster endpoint config.
3 properties
CreateNodePoolNodeConfigDetails
object
The size and placement configuration of nodes in the node pool.
9 properties
2 required
OpenIdConnectTokenAuthenticationConfig
object
The properties that configure OIDC token authentication in kube-apiserver. For more information, see [Configuring the API Server](https://kubernetes.io/docs/re…
11 properties
1 required
VirtualNodeSummary
object
The properties that define a virtual node summary.
16 properties
3 required
InitialVirtualNodeLabel
object
The properties that define a key value pair.
2 properties
ClusterMigrateToNativeVcnStatus
object
Information regarding a cluster's move to Native VCN.
2 properties
1 required
NodePool
object
A pool of compute nodes attached to a cluster. Avoid entering confidential information.
28 properties
PreemptionAction
object
The action to run when the preemptible node is interrupted for eviction.
1 property
1 required
VirtualNode
object
The properties that define a virtual node.
16 properties
3 required
NodePoolCyclingDetails
object
Node Pool Cycling Details
4 properties
WorkRequest
object
An asynchronous work request.
8 properties
CreateVnicDetails
object
The properties of the secondary vnics
12 properties
1 required
AdmissionControllerOptions
object
The properties that define supported admission controllers.
1 property
UpdateAddonDetails
object
The properties that define to update addon details.
2 properties
VirtualNodePool
object
A pool of virtual nodes attached to a cluster.
20 properties
8 required
CredentialRotationStatus
object
Information regarding cluster's credential rotation.
3 properties
2 required
WorkloadMapping
object
The properties that define an workloadMapping.
10 properties
7 required
Node
object
The properties that define a node.
15 properties
KeyValue
object
The properties that define a key value pair.
2 properties
AddonConfiguration
object
Defines the configuration of available addons for a cluster
2 properties
CreateVirtualNodePoolDetails
object
The properties that define a request to create a virtual node pool.
13 properties
6 required
NodePoolNodeConfigDetails
object
The size and placement configuration of nodes in the node pool.
9 properties
Addon
object
The properties that define an addon.
7 properties
2 required
NodePoolPlacementConfigDetails
object
The location where a node pool will place nodes.
6 properties
2 required
CreateClusterEndpointConfigDetails
The properties that define the network configuration for the Cluster endpoint.
CreateClusterKubeconfigContentDetails
object
The properties that define a request to create a cluster kubeconfig.
3 properties
NodePoolPodNetworkOptionDetails
object
The CNI type and relevant network details for the pods of a given node pool
1 property
1 required
VirtualNodePoolSummary
object
The properties that define a virtual node pool summary.
20 properties
8 required
InstallAddonDetails
object
The properties that define to install/enable addon on a cluster
4 properties
1 required
WorkRequestResource
object
The properties that define a work request resource.
4 properties
AddonError
object
The error info of the addon.
3 properties
VirtualNodePoolCyclingDetails
object
Virtual Node Pool Cycling Details
3 properties
PublicApiEndpointDecommissionStatus
object
Information regarding a cluster's public api endpoint decommission.
2 properties
2 required
UpdateClusterOptionsDetails
object
The properties that define extra options updating a cluster.
5 properties
CreateImagePolicyConfigDetails
The properties that define a image verification policy.
NodeError
object
The properties that define an upstream error while managing a node.
4 properties
2 required
CreateWorkloadMappingDetails
object
The properties that define a workloadMapping
4 properties
2 required
NodePoolOptions
object
Options for creating or updating node pools.
4 properties
ClusterMetadata
object
The properties that define meta data for a cluster.
10 properties
ReplaceBootVolumeClusterNodeDetails
object
The properties that define a node boot volume replacement action.
1 property
NodeSourceOption
object
The source option for the node.
2 properties
1 required
CreateClusterDetails
object
The properties that define a request to create a cluster.
12 properties
4 required
CreateNodePoolDetails
object
The properties that define a request to create a node pool.
21 properties
4 required
ServiceLbConfigDetails
object
Configuration to be applied to load balancers created by Kubernetes services
3 properties
PlacementConfiguration
object
The information of virtual node placement in the virtual node pool.
3 properties
2 required
Error
object
The properties that define an error.
2 properties
2 required
AddonVersions
object
The properties that define a work request resource.
5 properties
KeyDetails
object
The properties that define the kms keys used by OKE for Image Signature verification.
1 property
ExtendEndpointDecommissionRollbackDeadlineDetails
object
The properties that define a request to extend the rollback deadline for a public api endpoint decommission.
1 property
1 required
PodConfiguration
object
The pod configuration for pods run on virtual nodes of this virtual node pool.
3 properties
2 required
AddonSummary
object
The properties that define an addon summary.
6 properties
2 required
KubernetesVersionsFilters
object
The range of kubernetes versions an addon can be configured.
3 properties
PodShapeSummary
object
Pod shape.
5 properties
1 required
UpdateImagePolicyConfigDetails
The properties that define a image verification policy.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
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 Container Engine 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.