openapi: 3.1.0
info:
  title: Oracle Container Engine for Kubernetes (OKE) Add-ons 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: Add-ons
  description: Cluster add-on management
paths:
  /clusters/{clusterId}/addons:
    get:
      tags:
      - Add-ons
      summary: List add-ons installed on a cluster
      operationId: listAddons
      parameters:
      - $ref: '#/components/parameters/ClusterId'
      responses:
        '200':
          description: Cluster add-ons
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Addon'
    post:
      tags:
      - Add-ons
      summary: Install a cluster add-on
      operationId: installAddon
      parameters:
      - $ref: '#/components/parameters/ClusterId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallAddonDetails'
      responses:
        '202':
          description: Install accepted
components:
  schemas:
    InstallAddonDetails:
      type: object
      required:
      - addonName
      properties:
        addonName:
          type: string
        version:
          type: string
        configurations:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
    Addon:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        currentInstalledVersion:
          type: string
        lifecycleState:
          type: string
        configurations:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
  parameters:
    ClusterId:
      name: clusterId
      in: path
      required: true
      schema:
        type: string
      description: OCID of the cluster
  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/