Cast AI Ops Pilot Read API

openapi: 3.2.0
info:
  title: Kent Ops Pilot Read API
  version: 0.0.1
  description: 'Provides read-only access to live Kubernetes resources in Karpenter-managed

    clusters for the OpsPilot agent. Backed by the resource action service

    (kentroller stream); supports only GET and LIST operations.'
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: OpsPilotReadAPI
  description: 'Provides read-only access to live Kubernetes resources in Karpenter-managed

    clusters for the OpsPilot agent. Backed by the resource action service

    (kentroller stream); supports only GET and LIST operations.'
paths:
  /kent/v1alpha/organizations/{organizationId}/clusters/{clusterId}/resources:
    get:
      tags:
      - OpsPilotReadAPI
      summary: Lists live Kubernetes resources of a given GVR from the cluster (read-only)
      description: Lists live Kubernetes resources of a given GVR from the cluster.
      operationId: OpsPilotReadAPI_ListResources
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      - name: clusterId
        in: path
        description: The ID of the cluster.
        required: true
        schema:
          type: string
      - name: group
        in: query
        description: The API group of the resource. Empty string for the core group (e.g. pods, nodes).
        schema:
          type: string
      - name: version
        in: query
        description: The API version of the resource (e.g. "v1", "v1alpha1").
        schema:
          type: string
      - name: resource
        in: query
        description: The plural resource name (e.g. "pods", "nodeclaims", "poddisruptionbudgets").
        schema:
          type: string
      - name: namespace
        in: query
        description: The Kubernetes namespace to scope the list to. Empty lists across the whole cluster.
        schema:
          type: string
      - name: labelSelector
        in: query
        description: Label selector to filter the list (optional).
        schema:
          type: string
      - name: fieldSelector
        in: query
        description: Field selector to filter the list (optional).
        schema:
          type: string
      - name: page.limit
        in: query
        description: Defines the number of items that should be returned
        schema:
          type: string
      - name: page.cursor
        in: query
        description: "Cursor that defines token indicating where to start the next page.\n Empty value indicates to start from beginning of the dataset."
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResourcesResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /kent/v1alpha/organizations/{organizationId}/clusters/{clusterId}/resources/{name}:
    get:
      tags:
      - OpsPilotReadAPI
      summary: Gets a single live Kubernetes resource by GVR and name from the cluster…
      description: Gets a single live Kubernetes resource by GVR and name from the cluster.
      operationId: OpsPilotReadAPI_GetResource
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      - name: clusterId
        in: path
        description: The ID of the cluster.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The Kubernetes resource name.
        required: true
        schema:
          type: string
      - name: group
        in: query
        description: The API group of the resource. Empty string for the core group (e.g. pods, nodes).
        schema:
          type: string
      - name: version
        in: query
        description: The API version of the resource (e.g. "v1", "v1alpha1").
        schema:
          type: string
      - name: resource
        in: query
        description: The plural resource name (e.g. "pods", "nodeclaims", "poddisruptionbudgets").
        schema:
          type: string
      - name: namespace
        in: query
        description: The Kubernetes namespace. Empty for cluster-scoped resources.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResourceResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
components:
  schemas:
    GetResourceResponse:
      type: object
      properties:
        item:
          readOnly: true
          type: object
          description: The raw resource object as returned by the Kubernetes API.
        resourceVersion:
          readOnly: true
          type: string
          description: The resourceVersion of the returned object.
      description: Response containing a single live Kubernetes resource.
    ListResourcesResponse:
      type: object
      properties:
        items:
          readOnly: true
          type: array
          items:
            type: object
          description: The raw resource objects as returned by the Kubernetes API.
      description: Response containing a list of live Kubernetes resources.
    Status:
      type: object
      properties:
        code:
          type: integer
          description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
          format: int32
        message:
          type: string
          description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/GoogleProtobufAny'
          description: A list of messages that carry the error details.  There is a common set of message types for APIs to use.
      description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
    GoogleProtobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: The type of the serialized message.
      additionalProperties: true
      description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-provenance:
  method: searched
  source: https://docs.cast.ai/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.cast.ai/reference/awsdataproxyapi_getdata.md
  - https://docs.cast.ai/reference/azuredataproxyapi_getdata.md
  - https://docs.cast.ai/reference/clustersapi_onboardclusterscript-1.md
  - https://docs.cast.ai/reference/featuresapi_configurefeature.md
  - https://docs.cast.ai/reference/featuresapi_getclusterfeatureinstallscript.md
  - https://docs.cast.ai/reference/featuresapi_getclusterinstallscript.md
  - https://docs.cast.ai/reference/featuresapi_getfeature.md
  - https://docs.cast.ai/reference/featuresapi_getinstallscript.md
  - https://docs.cast.ai/reference/featuresapi_getorganizationfeatureinstallscript.md
  - https://docs.cast.ai/reference/featuresapi_getorganizationinstallscript.md
  - https://docs.cast.ai/reference/featuresapi_getoverview.md
  - https://docs.cast.ai/reference/featuresapi_getsummary.md
  - https://docs.cast.ai/reference/featuresapi_listfeaturecompatibilities.md
  - https://docs.cast.ai/reference/featuresapi_listfeatureconfigs.md
  - https://docs.cast.ai/reference/featuresapi_listfeatures.md
  - https://docs.cast.ai/reference/kentrollerapi_creatediagnosticreport.md
  - https://docs.cast.ai/reference/kentrollerapi_getdiagnosticreport.md
  - https://docs.cast.ai/reference/kentrollerapi_listdiagnosticreports.md
  - https://docs.cast.ai/reference/machinelearningapi_predictspotinterruption.md
  - https://docs.cast.ai/reference/nodeclassesapi_listaksnodeclasses.md
  - https://docs.cast.ai/reference/nodeclassesapi_listec2nodeclasses.md
  - https://docs.cast.ai/reference/nodeclassesapi_listnodeclasses.md
  - https://docs.cast.ai/reference/nodeclassesapi_updateaksnodeclass.md
  - https://docs.cast.ai/reference/nodeclassesapi_updateec2nodeclass.md
  - https://docs.cast.ai/reference/nodeclassesapi_updatenodeclass.md
  - https://docs.cast.ai/reference/nodeoverlaysapi_getnodeoverlay.md
  - https://docs.cast.ai/reference/nodeoverlaysapi_listnodeoverlays.md
  - https://docs.cast.ai/reference/nodepoolsapi_listnodepools.md
  - https://docs.cast.ai/reference/nodepoolsapi_updatenodepool.md
  - https://docs.cast.ai/reference/nodesapi_deletenode.md
  - https://docs.cast.ai/reference/nodesapi_drainnode.md
  - https://docs.cast.ai/reference/nodesapi_interruptnode.md
  - https://docs.cast.ai/reference/operationsapi_getoperation-3.md
  - https://docs.cast.ai/reference/opspilotreadapi_getresource.md
  - https://docs.cast.ai/reference/opspilotreadapi_listresources.md
  - https://docs.cast.ai/reference/rebalancingapi_cancelrebalancingplan.md
  - https://docs.cast.ai/reference/rebalancingapi_createrebalancingplan.md
  - https://docs.cast.ai/reference/rebalancingapi_executerebalancingplan.md
  - https://docs.cast.ai/reference/rebalancingapi_getrebalancingconstraints.md
  - https://docs.cast.ai/reference/rebalancingapi_getrebalancingplan.md
  - https://docs.cast.ai/reference/rebalancingapi_listrebalancingplans.md
  - https://docs.cast.ai/reference/rebalancingapi_listworkloads.md
  - https://docs.cast.ai/reference/scheduledrebalancingapi_createrebalancingschedule-1.md
  - https://docs.cast.ai/reference/scheduledrebalancingapi_deleterebalancingschedule-1.md
  - https://docs.cast.ai/reference/scheduledrebalancingapi_getrebalancingschedule-1.md
  - https://docs.cast.ai/reference/scheduledrebalancingapi_listrebalancingschedules-1.md
  - https://docs.cast.ai/reference/scheduledrebalancingapi_togglerebalancingschedule.md
  - https://docs.cast.ai/reference/scheduledrebalancingapi_updaterebalancingschedule-1.md
  - https://docs.cast.ai/reference/statusapi_getkentstatus.md
  merge:
    pages: 49
    deduped: 542
    conflicts_kept_first: 0