Cast AI Index Snapshots API

openapi: 3.2.0
info:
  title: Database Optimizer Index Snapshots API
  version: 0.0.1
  description: IndexSnapshotsAPI provides operations for managing database index snapshots
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: IndexSnapshotsAPI
  description: IndexSnapshotsAPI provides operations for managing database index snapshots
paths:
  ? /database-optimizer/index-advisor/v1alpha/organizations/{organizationId}/cache-groups/{cacheGroupId}/databases/{databaseName}/index-snapshots:batchCreate
  : post:
      tags:
      - IndexSnapshotsAPI
      summary: Push PostgreSQL index snapshots from collector
      description: 'Push PostgreSQL index snapshots of database indexes


        Stores PostgreSQL index snapshots that are used to identify index optimization opportunities'
      operationId: IndexSnapshotsAPI_BatchCreateIndexSnapshots
      parameters:
      - name: organizationId
        in: path
        description: Organization identifier for multi-tenant support
        required: true
        schema:
          type: string
      - name: cacheGroupId
        in: path
        description: Cache group ID
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        description: Database name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateIndexSnapshotsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCreateIndexSnapshotsResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  ? /database-optimizer/index-advisor/v1alpha/organizations/{organizationId}/cache-groups/{cacheGroupId}/databases/{databaseName}/mysql-index-snapshots:batchCreate
  : post:
      tags:
      - IndexSnapshotsAPI
      summary: Push MySQL index snapshots from collector
      description: 'Push MySQL index snapshots of database indexes


        Stores MySQL index snapshots that are used to identify index optimization opportunities'
      operationId: IndexSnapshotsAPI_BatchCreateMySQLIndexSnapshots
      parameters:
      - name: organizationId
        in: path
        description: Organization identifier for multi-tenant support
        required: true
        schema:
          type: string
      - name: cacheGroupId
        in: path
        description: Cache group ID
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        description: Database name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateMySQLIndexSnapshotsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCreateMySQLIndexSnapshotsResponse'
        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).'
    BatchCreateIndexSnapshotsRequest:
      required:
      - organizationId
      - cacheGroupId
      - databaseName
      - requests
      type: object
      properties:
        organizationId:
          type: string
          description: Organization identifier for multi-tenant support
        cacheGroupId:
          type: string
          description: Cache group ID
        databaseName:
          type: string
          description: Database name
        requests:
          type: array
          items:
            $ref: '#/components/schemas/IndexSnapshot'
          description: Index snapshot data for complete database state
        metadata:
          allOf:
          - $ref: '#/components/schemas/RequestMetadata'
          description: Request metadata
      description: Index snapshot payload containing database snapshot data
    BatchCreateMySQLIndexSnapshotsRequest:
      required:
      - organizationId
      - cacheGroupId
      - databaseName
      - requests
      type: object
      properties:
        organizationId:
          type: string
          description: Organization identifier for multi-tenant support
        cacheGroupId:
          type: string
          description: Cache group ID
        databaseName:
          type: string
          description: Database name
        requests:
          type: array
          items:
            $ref: '#/components/schemas/MySQLIndexSnapshot'
          description: MySQL index snapshot data
        metadata:
          allOf:
          - $ref: '#/components/schemas/RequestMetadata'
          description: Request metadata
      description: MySQL index snapshot batch create request
    BatchCreateMySQLIndexSnapshotsResponse:
      type: object
      properties: {}
      description: Response from batch creating MySQL index snapshots
    MySQLIndexSnapshot:
      required:
      - schemaName
      - tableName
      - indexName
      - indexType
      - unique
      - primary
      - columnNames
      - fk
      - countFetch
      type: object
      properties:
        schemaName:
          type: string
          description: Schema name
        tableName:
          type: string
          description: Table name
        indexName:
          type: string
          description: Index name (unique within table)
        indexType:
          type: string
          description: Index type (e.g. BTREE, HASH, FULLTEXT, SPATIAL)
        indexDefinition:
          type: string
          description: Complete index definition SQL
        unique:
          type: boolean
          description: Whether index enforces uniqueness constraint
        primary:
          type: boolean
          description: Whether index is the primary key
        columnNames:
          type: array
          items:
            type: string
          description: Column names included in the index (ordered)
        fk:
          type: boolean
          description: Whether this index covers a foreign key constraint
        countFetch:
          type: string
          description: Cumulative number of times this index was used to fetch rows (resets on server restart or FLUSH STATUS)
      description: MySQLIndexSnapshot represents a point-in-time snapshot of a MySQL database index
    IndexUsageStats:
      required:
      - indexScans
      - tuplesRead
      - tuplesFetched
      - indexSizeBytes
      type: object
      properties:
        indexScans:
          type: string
          description: Number of index scans initiated on this index
        tuplesRead:
          type: string
          description: Number of live rows fetched by index scans
        tuplesFetched:
          type: string
          description: Number of live rows fetched by simple index scans
        indexSizeBytes:
          type: string
          description: Current size of the index in bytes
        hitRatio:
          type: number
          description: Index hit ratio (cache efficiency)
          format: double
      description: Enhanced index usage statistics
    BatchCreateIndexSnapshotsResponse:
      type: object
      properties: {}
      description: Response from batch creating index snapshots
    RequestMetadata:
      type: object
      properties:
        requestId:
          type: string
          description: Request ID for tracing
        clientVersion:
          type: string
          description: Client version information
        collectorId:
          type: string
          description: Collection source identifier
        source:
          type: string
          description: Request source information
      description: Request metadata for tracing
    IndexSnapshot:
      required:
      - schemaName
      - tableName
      - indexName
      - indexType
      - unique
      - primary
      - columnNames
      - usageStats
      - valid
      - ready
      - live
      type: object
      properties:
        schemaName:
          type: string
          description: Schema name
        tableName:
          type: string
          description: Table name
        indexName:
          type: string
          description: Index name (unique within table)
        indexType:
          enum:
          - INDEX_TYPE_UNSPECIFIED
          - BTREE
          - HASH
          - GIST
          - GIN
          - SPGIST
          - BRIN
          type: string
          description: Index type with enumerated values for validation
          format: enum
        indexDefinition:
          type: string
          description: Complete index definition SQL
        unique:
          type: boolean
          description: Whether index enforces uniqueness constraint
        primary:
          type: boolean
          description: Whether index is the primary key
        columnNames:
          type: array
          items:
            type: string
          description: Column names included in the index (ordered)
        partialPredicate:
          type: string
          description: Partial predicate on index if any
        usageStats:
          allOf:
          - $ref: '#/components/schemas/IndexUsageStats'
          description: Enhanced usage statistics
        valid:
          type: boolean
          description: Whether index is valid and ready for queries
        ready:
          type: boolean
          description: Whether index build is complete and ready for inserts
        live:
          type: boolean
          description: Whether index is live and being maintained
      description: IndexSnapshot represents a point-in-time snapshot of a database index
    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