Cast AI Cache Groups API

openapi: 3.2.0
info:
  title: Database Optimizer Cache Groups API
  version: 0.0.1
  description: CacheGroupsAPI provides operations for managing cache groups for Index Advisor
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: CacheGroupsAPI
  description: CacheGroupsAPI provides operations for managing cache groups for Index Advisor
paths:
  /database-optimizer/index-advisor/v1alpha/organizations/{organizationId}/cache-groups:
    get:
      tags:
      - CacheGroupsAPI
      summary: List cache groups
      description: 'List cache groups


        Lists cache groups'
      operationId: CacheGroupsAPI_ListIndexAdvisorCacheGroups
      parameters:
      - name: organizationId
        in: path
        description: Organization identifier
        required: true
        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/ListIndexAdvisorCacheGroupsResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /database-optimizer/index-advisor/v1alpha/organizations/{organizationId}/cache-groups/{id}:
    get:
      tags:
      - CacheGroupsAPI
      summary: Get cache group
      description: 'Get cache group


        Gets a specific cache group'
      operationId: CacheGroupsAPI_GetIndexAdvisorCacheGroup
      parameters:
      - name: organizationId
        in: path
        description: Organization identifier
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Cache group identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexAdvisorCacheGroup'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /database-optimizer/index-advisor/v1alpha/organizations/{organizationId}/cache-groups/{id}:heartbeat:
    post:
      tags:
      - CacheGroupsAPI
      summary: Send agent heartbeat
      description: Send DB agent heartbeat
      operationId: CacheGroupsAPI_SendAgentHeartbeat
      parameters:
      - name: organizationId
        in: path
        description: Organization identifier
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Cache group ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendAgentHeartbeatRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendAgentHeartbeatResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
components:
  schemas:
    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).'
    CacheDatabase:
      required:
      - id
      - name
      - totalIndexes
      - indexesSize
      - recommendationsSummary
      type: object
      properties:
        id:
          type: string
          description: Database ID
        name:
          type: string
          description: Name of the database
        totalIndexes:
          type: integer
          description: Total number of existing indexes
          format: uint32
        indexesSize:
          type: string
          description: Total size of indexes in bytes
        recommendationsSummary:
          allOf:
          - $ref: '#/components/schemas/RecommendationSummary'
          description: Summary of recommendations
      description: Database owned by a cache group
    SendAgentHeartbeatResponse:
      type: object
      properties: {}
      description: Response after recording a heartbeat
    ListIndexAdvisorCacheGroupsResponse:
      required:
      - items
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/IndexAdvisorCacheGroup'
          description: List of cache groups
      description: Response from listing cache groups
    RecommendationSummary:
      required:
      - totalCreateIndex
      - totalDropIndex
      - totalCount
      type: object
      properties:
        totalCreateIndex:
          type: integer
          description: Number of create index recommendations
          format: uint32
        totalDropIndex:
          type: integer
          description: Number of drop index recommendations
          format: uint32
        totalCount:
          type: integer
          description: Total number of recommendations
          format: uint32
      description: Recommendations summary
    IndexAdvisorCacheGroup:
      required:
      - id
      - name
      - protocolType
      - recommendationsSummary
      - enabled
      type: object
      properties:
        id:
          type: string
          description: Cache group ID
        name:
          type: string
          description: Name of the cache group
        protocolType:
          enum:
          - PROTOCOL_TYPE_UNSPECIFIED
          - POSTGRESQL
          - MYSQL
          type: string
          description: Protocol type of the cache group
          format: enum
        totalDbCount:
          type: integer
          description: Number of databases within the cache group
          format: uint32
        databases:
          type: array
          items:
            $ref: '#/components/schemas/CacheDatabase'
          description: Databases within the cache group
        recommendationsSummary:
          allOf:
          - $ref: '#/components/schemas/RecommendationSummary'
          description: Summary of recommendations
        enabled:
          type: boolean
          description: Whether Index Advisor is enabled/deployed for the cache group
      description: Cache group
    SendAgentHeartbeatRequest:
      required:
      - organizationId
      - id
      - chartVersion
      - agentImage
      - namespace
      - releaseName
      type: object
      properties:
        organizationId:
          type: string
          description: Organization identifier
        id:
          type: string
          description: Cache group ID
        chartVersion:
          type: string
          description: Agent chart version
        agentImage:
          type: string
          description: Agent container image reference
        namespace:
          type: string
          description: Kubernetes namespace where the agent is deployed
        releaseName:
          type: string
          description: Helm chart release name
      description: Request to record a heartbeat
    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/advisorapi_batchgetadvisordatabasestats.md
  - https://docs.cast.ai/reference/advisorapi_closeadvisorrecommendation.md
  - https://docs.cast.ai/reference/advisorapi_getadvisorcachegroup.md
  - https://docs.cast.ai/reference/advisorapi_getadvisordatabase.md
  - https://docs.cast.ai/reference/advisorapi_getadvisordatabaseinstance.md
  - https://docs.cast.ai/reference/advisorapi_getadvisorrecommendationdetail.md
  - https://docs.cast.ai/reference/advisorapi_listadvisorcachegroups.md
  - https://docs.cast.ai/reference/advisorapi_listadvisordatabaseinstances.md
  - https://docs.cast.ai/reference/advisorapi_listadvisordatabases.md
  - https://docs.cast.ai/reference/advisorapi_listadvisorrecommendations.md
  - https://docs.cast.ai/reference/advisorapi_listtoprecommendations.md
  - https://docs.cast.ai/reference/advisorapi_markadvisordbagentuninstalled.md
  - https://docs.cast.ai/reference/advisorapi_reopenadvisorrecommendation.md
  - https://docs.cast.ai/reference/advisorapi_resendadvisorvalidationrequest.md
  - https://docs.cast.ai/reference/advisorapi_resetadvisorrecommendations.md
  - https://docs.cast.ai/reference/cachegroupsapi_getindexadvisorcachegroup.md
  - https://docs.cast.ai/reference/cachegroupsapi_listindexadvisorcachegroups.md
  - https://docs.cast.ai/reference/cachegroupsapi_sendagentheartbeat.md
  - https://docs.cast.ai/reference/cachingapi_createcacherule.md
  - https://docs.cast.ai/reference/cachingapi_createproxy.md
  - https://docs.cast.ai/reference/cachingapi_deletecacherule.md
  - https://docs.cast.ai/reference/cachingapi_exchangeproxystate.md
  - https://docs.cast.ai/reference/cachingapi_getinstanceproxycachemetrics.md
  - https://docs.cast.ai/reference/cachingapi_getproxycachemetrics.md
  - https://docs.cast.ai/reference/cachingapi_getproxycachequeryinsights.md
  - https://docs.cast.ai/reference/cachingapi_getproxycachequerytemplate.md
  - https://docs.cast.ai/reference/cachingapi_getproxycachesummary.md
  - https://docs.cast.ai/reference/cachingapi_getproxyconnectionsmetrics.md
  - https://docs.cast.ai/reference/cachingapi_getproxyperformancemetrics.md
  - https://docs.cast.ai/reference/cachingapi_getproxyqueries.md
  - https://docs.cast.ai/reference/cachingapi_listcacherules.md
  - https://docs.cast.ai/reference/cachingapi_reportoperationalmetrics.md
  - https://docs.cast.ai/reference/cachingapi_reportpoolingmetrics.md
  - https://docs.cast.ai/reference/cachingapi_reportquerymetrics.md
  - https://docs.cast.ai/reference/cachingapi_updatecacherule.md
  - https://docs.cast.ai/reference/cachingapi_updateproxydatabase.md
  - https://docs.cast.ai/reference/databaseinstanceconfigapi_reportdatabaseinstanceconfig.md
  - https://docs.cast.ai/reference/databaseinstancesapi_createdatabase.md
  - https://docs.cast.ai/reference/databaseinstancesapi_createdatabaseinstance.md
  - https://docs.cast.ai/reference/databaseinstancesapi_deletedatabase.md
  - https://docs.cast.ai/reference/databaseinstancesapi_deletedatabaseinstance.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getcloudsyncstatus.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabase.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancecachingsummary.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancedetails.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancehealthmetrics.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancemetricsfilteroptions.md
  - https://docs.cast.ai/reference/databaseinstancesapi_getdatabaseinstancescloudintegrationsummary.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listcachingpotentialdatabases.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listcloudoptimizationcandidates.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listconnectionpoolingcandidates.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listdatabaseinstancemembers.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listdatabaseinstances.md
  - https://docs.cast.ai/reference/databaseinstancesapi_listtopqueryrecommendations.md
  - https://docs.cast.ai/reference/databaseinstancesapi_updatedatabaseinstance.md
  - https://docs.cast.ai/reference/databasesapi_getcachedatabase.md
  - https://docs.cast.ai/reference/databasesapi_listcachedatabases.md
  - https://docs.cast.ai/reference/dbagentapi_ingestagentheartbeat.md
  - https://docs.cast.ai/reference/dbagentapi_ingestmysqlindexsnapshots.md
  - https://docs.cast.ai/reference/dbagentapi_ingestmysqlquerystats.md
  - https://docs.cast.ai/reference/dbagentapi_ingestmysqltablesmetadata.md
  - https://docs.cast.ai/reference/dbagentapi_ingestpostgresindexsnapshots.md
  - https://docs.cast.ai/reference/dbagentapi_ingestpostgresquerystats.md
  - https://docs.cast.ai/reference/dbagentapi_ingestpostgrestablesmetadata.md
  - https://docs.cast.ai/reference/indexrecommendationsapi_listindexrecommendations.md
  - https://docs.cast.ai/reference/indexsnapshotsapi_batchcreateindexsnapshots.md
  - https://docs.cast.ai/reference/indexsnapshotsapi_batchcreatemysqlindexsnapshots.md
  - https://docs.cast.ai/reference/querystatsapi_batchcreatemysqlquerystats.md
  - https://docs.cast.ai/reference/querystatsapi_batchcreatepgquerystats.md
  - https://docs.cast.ai/reference/querystatsapi_batchcreatequerystats.md
  - https://docs.cast.ai/reference/tablemetadataapi_batchcreatemysqltablesmetadata.md
  - https://docs.cast.ai/reference/tablemetadataapi_batchcreatetablesmetadata.md
  - https://docs.cast.ai/reference/telemetryapi_ingesttelemetryevents.md
  - https://docs.cast.ai/reference/telemetryapi_listtelemetryevents.md
  merge:
    pages: 74
    deduped: 412
    conflicts_kept_first: 0