openapi: 3.1.0
info:
  title: Oracle Container Engine for Kubernetes (OKE) Add-ons Node Pools API
  description: Oracle Container Engine for Kubernetes (OKE) is a managed Kubernetes service on Oracle Cloud Infrastructure. The API exposes endpoints for managing Kubernetes clusters, node pools, virtual node pools, add-ons, work requests, and cluster credentials within OCI compartments.
  version: 20180222
  contact:
    name: Oracle Cloud Infrastructure Support
    url: https://support.oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/cloud/cloud-services-agreements/
servers:
- url: https://containerengine.{region}.oci.oraclecloud.com/20180222
  description: OCI Container Engine regional endpoint
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
security:
- ociAuth: []
tags:
- name: Node Pools
  description: Worker node pool management
paths:
  /nodePools:
    get:
      tags:
      - Node Pools
      summary: List node pools
      operationId: listNodePools
      parameters:
      - $ref: '#/components/parameters/CompartmentId'
      - name: clusterId
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Node pool list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NodePoolSummary'
    post:
      tags:
      - Node Pools
      summary: Create a node pool
      operationId: createNodePool
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNodePoolDetails'
      responses:
        '202':
          description: Node pool creation accepted
  /nodePools/{nodePoolId}:
    get:
      tags:
      - Node Pools
      summary: Get a node pool
      operationId: getNodePool
      parameters:
      - name: nodePoolId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Node pool details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodePool'
    delete:
      tags:
      - Node Pools
      summary: Delete a node pool
      operationId: deleteNodePool
      parameters:
      - name: nodePoolId
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Deletion accepted
components:
  schemas:
    NodePool:
      allOf:
      - $ref: '#/components/schemas/NodePoolSummary'
      - type: object
        properties:
          nodeImageId:
            type: string
          nodeSource:
            type: object
            additionalProperties: true
          quantityPerSubnet:
            type: integer
          subnetIds:
            type: array
            items:
              type: string
          nodeConfigDetails:
            type: object
            properties:
              size:
                type: integer
              placementConfigs:
                type: array
                items:
                  type: object
                  properties:
                    availabilityDomain:
                      type: string
                    subnetId:
                      type: string
    NodePoolSummary:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        clusterId:
          type: string
        compartmentId:
          type: string
        kubernetesVersion:
          type: string
        nodeShape:
          type: string
        lifecycleState:
          type: string
    CreateNodePoolDetails:
      type: object
      required:
      - name
      - clusterId
      - compartmentId
      - nodeShape
      - kubernetesVersion
      properties:
        name:
          type: string
        clusterId:
          type: string
        compartmentId:
          type: string
        kubernetesVersion:
          type: string
        nodeShape:
          type: string
        nodeImageId:
          type: string
  parameters:
    CompartmentId:
      name: compartmentId
      in: query
      required: true
      schema:
        type: string
      description: OCID of the compartment
  securitySchemes:
    ociAuth:
      type: apiKey
      in: header
      name: Authorization
      description: OCI request signing (RFC 7615) using API key pair
externalDocs:
  description: OCI Container Engine API Reference
  url: https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/