Oracle Cloud Infrastructure

Container Engine for Kubernetes API

Manage Kubernetes clusters and node pools.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.oracle.com/en-us/iaas/Content/ContEng/home.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/openapi/oracle-cloud-oke-openapi.yaml

Examples

📝
Example
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/examples/oke-cluster-summary-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/examples/oke-create-cluster-details-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/examples/oke-cluster-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/examples/oke-node-pool-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/examples/oke-update-cluster-details-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/examples/oke-node-pool-summary-example.json
📝
Example
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/examples/oke-create-node-pool-details-example.json

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-schema/oke-node-pool-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-schema/oke-node-pool-summary-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-schema/oke-create-cluster-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-schema/oke-create-node-pool-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-schema/oke-update-cluster-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-schema/oke-cluster-summary-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-schema/oke-cluster-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/oke-cluster-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/oke-node-pool-summary-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/oke-update-cluster-details-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/oke-create-node-pool-details-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/oke-node-pool-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/oke-create-cluster-details-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/oracle-cloud/refs/heads/main/json-structure/oke-cluster-summary-structure.json

OpenAPI Specification

oracle-cloud-oke-openapi.yaml Raw ↑ 
openapi: 3.0.3
info:
  title: Oracle Cloud Container Engine for Kubernetes API
  description: Manage Kubernetes clusters and node pools in Oracle Cloud Infrastructure.
  version: '20180222'
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
servers:
- url: https://containerengine.{region}.oraclecloud.com/20180222
  variables:
    region:
      default: us-ashburn-1
paths:
  /clusters:
    get:
      operationId: listClusters
      summary: Oracle Cloud List Clusters
      description: List all Kubernetes clusters in a compartment.
      tags:
      - Clusters
      parameters:
      - name: compartmentId
        in: query
        required: true
        description: The OCID of the compartment.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterSummary'
              examples:
                ListClusters200Example:
                  summary: Default listClusters 200 response
                  x-microcks-default: true
                  value:
                  - id: ocid1.resource.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    name: example-value
                    kubernetesVersion: v1.28.2
                    lifecycleState: example-value
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createCluster
      summary: Oracle Cloud Create Cluster
      description: Create a new Kubernetes cluster.
      tags:
      - Clusters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClusterDetails'
            examples:
              CreateClusterRequestExample:
                summary: Default createCluster request
                x-microcks-default: true
                value:
                  compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                  name: example-value
                  vcnId: ocid1.resource.oc1.iad.abcdefg123456
                  kubernetesVersion: v1.28.2
      responses:
        '200':
          description: Successfully created.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /clusters/{clusterId}:
    get:
      operationId: getCluster
      summary: Oracle Cloud Get Cluster
      description: Get the specified Kubernetes cluster.
      tags:
      - Clusters
      parameters:
      - name: clusterId
        in: path
        required: true
        description: The OCID of the cluster.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
              examples:
                GetCluster200Example:
                  summary: Default getCluster 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.cluster.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    name: my-cluster
                    kubernetesVersion: v1.28.2
                    vcnId: ocid1.resource.oc1.iad.abcdefg123456
                    lifecycleState: CREATING
                    endpoints: &id001
                      kubernetes: example-value
                      publicEndpoint: example-value
                      privateEndpoint: example-value
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateCluster
      summary: Oracle Cloud Update Cluster
      description: Update the specified Kubernetes cluster.
      tags:
      - Clusters
      parameters:
      - name: clusterId
        in: path
        required: true
        description: The OCID of the cluster.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClusterDetails'
            examples:
              UpdateClusterRequestExample:
                summary: Default updateCluster request
                x-microcks-default: true
                value:
                  name: example-value
                  kubernetesVersion: v1.28.2
      responses:
        '200':
          description: Successfully updated.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteCluster
      summary: Oracle Cloud Delete Cluster
      description: Delete a Kubernetes cluster.
      tags:
      - Clusters
      parameters:
      - name: clusterId
        in: path
        required: true
        description: The OCID of the cluster.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '204':
          description: Successfully deleted.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /nodePools:
    get:
      operationId: listNodePools
      summary: Oracle Cloud List Node Pools
      description: List all node pools in a compartment.
      tags:
      - Node Pools
      parameters:
      - name: compartmentId
        in: query
        required: true
        description: The OCID of the compartment.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      - name: clusterId
        in: query
        required: false
        description: The OCID of the cluster.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NodePoolSummary'
              examples:
                ListNodePools200Example:
                  summary: Default listNodePools 200 response
                  x-microcks-default: true
                  value:
                  - id: ocid1.resource.oc1.iad.abcdefg123456
                    clusterId: ocid1.resource.oc1.iad.abcdefg123456
                    name: example-value
                    kubernetesVersion: v1.28.2
                    nodeShape: VM.Standard.E4.Flex
                    lifecycleState: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createNodePool
      summary: Oracle Cloud Create Node Pool
      description: Create a new node pool in a cluster.
      tags:
      - Node Pools
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNodePoolDetails'
            examples:
              CreateNodePoolRequestExample:
                summary: Default createNodePool request
                x-microcks-default: true
                value:
                  compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                  clusterId: ocid1.resource.oc1.iad.abcdefg123456
                  name: example-value
                  kubernetesVersion: v1.28.2
                  nodeShape: VM.Standard.E4.Flex
                  quantityPerSubnet: 1
      responses:
        '200':
          description: Successfully created.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /nodePools/{nodePoolId}:
    get:
      operationId: getNodePool
      summary: Oracle Cloud Get Node Pool
      description: Get the specified node pool.
      tags:
      - Node Pools
      parameters:
      - name: nodePoolId
        in: path
        required: true
        description: The OCID of the node pool.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodePool'
              examples:
                GetNodePool200Example:
                  summary: Default getNodePool 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.resource.oc1.iad.abcdefg123456
                    clusterId: ocid1.resource.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    name: pool1
                    kubernetesVersion: v1.28.2
                    nodeShape: VM.Standard.E4.Flex
                    quantityPerSubnet: 3
                    lifecycleState: example-value
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteNodePool
      summary: Oracle Cloud Delete Node Pool
      description: Delete a node pool.
      tags:
      - Node Pools
      parameters:
      - name: nodePoolId
        in: path
        required: true
        description: The OCID of the node pool.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '204':
          description: Successfully deleted.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication.
  schemas:
    Cluster:
      type: object
      description: A Kubernetes cluster managed by OKE.
      properties:
        id:
          type: string
          description: The OCID of the cluster.
          example: ocid1.cluster.oc1.iad.abcdefg123456
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        name:
          type: string
          example: my-cluster
        kubernetesVersion:
          type: string
          example: v1.28.2
        vcnId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        lifecycleState:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - FAILED
          - DELETING
          - DELETED
          - UPDATING
          example: CREATING
        endpoints:
          type: object
          properties:
            kubernetes:
              type: string
            publicEndpoint:
              type: string
            privateEndpoint:
              type: string
          example: *id001
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
    ClusterSummary:
      type: object
      description: Cluster summary.
      properties:
        id:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        name:
          type: string
          example: example-value
        kubernetesVersion:
          type: string
          example: v1.28.2
        lifecycleState:
          type: string
          example: example-value
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
    CreateClusterDetails:
      type: object
      required:
      - compartmentId
      - name
      - vcnId
      - kubernetesVersion
      properties:
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        name:
          type: string
          example: example-value
        vcnId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        kubernetesVersion:
          type: string
          example: v1.28.2
    UpdateClusterDetails:
      type: object
      properties:
        name:
          type: string
          example: example-value
        kubernetesVersion:
          type: string
          example: v1.28.2
    NodePool:
      type: object
      description: A node pool in a Kubernetes cluster.
      properties:
        id:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        clusterId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        name:
          type: string
          example: pool1
        kubernetesVersion:
          type: string
          example: v1.28.2
        nodeShape:
          type: string
          example: VM.Standard.E4.Flex
        quantityPerSubnet:
          type: integer
          example: 3
        lifecycleState:
          type: string
          example: example-value
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
    NodePoolSummary:
      type: object
      properties:
        id:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        clusterId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        name:
          type: string
          example: example-value
        kubernetesVersion:
          type: string
          example: v1.28.2
        nodeShape:
          type: string
          example: VM.Standard.E4.Flex
        lifecycleState:
          type: string
          example: example-value
    CreateNodePoolDetails:
      type: object
      required:
      - compartmentId
      - clusterId
      - name
      - kubernetesVersion
      - nodeShape
      properties:
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        clusterId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        name:
          type: string
          example: example-value
        kubernetesVersion:
          type: string
          example: v1.28.2
        nodeShape:
          type: string
          example: VM.Standard.E4.Flex
        quantityPerSubnet:
          type: integer
          example: 1
    Error:
      type: object
      properties:
        code:
          type: string
          example: example-value
        message:
          type: string
          example: example-value
        status:
          type: integer
          example: 1
security:
- ociSignature: []