Cast AI Reliability Metrics API

openapi: 3.2.0
info:
  title: Reporting Reliability Metrics API
  version: 0.0.1
  description: Manages Reliability Metrics API.
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: ReliabilityMetricsAPI
  description: Manages Reliability Metrics API.
paths:
  /reporting/v1beta/organizations/{organizationId}/clusters/reliability-metrics:
    get:
      tags:
      - ReliabilityMetricsAPI
      summary: Returns reliability metrics summary per cluster for an organization
      description: Returns a reliability metrics summary per cluster for an organization.
      operationId: ReliabilityMetricsAPI_GetOrganizationClustersReliabilityMetrics
      parameters:
      - name: organizationId
        in: path
        description: ID of the organization.
        required: true
        schema:
          type: string
      - name: startTime
        in: query
        description: Filter items to include from specified time.
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        description: Filter items to include up to specified time.
        schema:
          type: string
          format: date-time
      - name: timeZone
        in: query
        description: Timezone for time-based aggregation, default UTC.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationClustersReliabilityMetrics'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /reporting/v1beta/organizations/{organizationId}/clusters/{clusterId}/reliability-metrics:
    get:
      tags:
      - ReliabilityMetricsAPI
      summary: Returns cluster-level reliability metrics
      description: Returns cluster-level reliability metrics (request rate, error rate, latency percentiles).
      operationId: ReliabilityMetricsAPI_GetClusterReliabilityMetrics
      parameters:
      - name: organizationId
        in: path
        description: ID of the organization.
        required: true
        schema:
          type: string
      - name: clusterId
        in: path
        description: ID of the cluster.
        required: true
        schema:
          type: string
      - name: startTime
        in: query
        description: Filter items to include from specified time.
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        description: Filter items to include up to specified time.
        schema:
          type: string
          format: date-time
      - name: step
        in: query
        description: Granularity of aggregated data points. Defaults to ONE_DAY when unspecified.
        schema:
          enum:
          - STEP_UNSPECIFIED
          - ONE_MINUTE
          - FIVE_MINUTES
          - ONE_HOUR
          - ONE_DAY
          type: string
          format: enum
      - name: timeZone
        in: query
        description: Timezone for time-based aggregation, default UTC.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterReliabilityMetrics'
        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).'
    ClusterReliabilityMetricsSummary:
      type: object
      properties:
        clusterId:
          type: string
          description: ID of the cluster.
        requestRate:
          type: number
          description: Average request rate in requests per second over the time range.
          format: double
        errorRate:
          type: number
          description: Average error rate in errors per second over the time range.
          format: double
        latencyP50:
          type: number
          description: 50th percentile latency in seconds over the time range.
          format: double
        latencyP95:
          type: number
          description: 95th percentile latency in seconds over the time range.
          format: double
        latencyP99:
          type: number
          description: 99th percentile latency in seconds over the time range.
          format: double
      description: Reliability metrics summary for a single cluster.
    ClusterReliabilityMetrics_Metric:
      type: object
      properties:
        summary:
          type: number
          description: Summary is a single aggregated value over the full time range.
          format: double
        values:
          type: array
          items:
            $ref: '#/components/schemas/Metric_Value'
          description: Time-series data points.
      description: A single metric with summary and time-series values.
    Metric_Value:
      type: object
      properties:
        timestamp:
          type: string
          description: Time of the data point.
          format: date-time
        value:
          type: number
          description: Numeric metric value at the timestamp.
          format: double
      description: A single time-series data point.
    OrganizationClustersReliabilityMetrics:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ClusterReliabilityMetricsSummary'
          description: Per-cluster reliability metrics summaries.
      description: Response containing reliability metrics summaries for each cluster in an organization.
    ClusterReliabilityMetrics:
      type: object
      properties:
        requestRate:
          allOf:
          - $ref: '#/components/schemas/ClusterReliabilityMetrics_Metric'
          description: Request rate in requests per second.
        errorRate:
          allOf:
          - $ref: '#/components/schemas/ClusterReliabilityMetrics_Metric'
          description: Error rate in errors per second.
        latencyP50:
          allOf:
          - $ref: '#/components/schemas/ClusterReliabilityMetrics_Metric'
          description: 50th percentile latency in seconds.
        latencyP95:
          allOf:
          - $ref: '#/components/schemas/ClusterReliabilityMetrics_Metric'
          description: 95th percentile latency in seconds.
        latencyP99:
          allOf:
          - $ref: '#/components/schemas/ClusterReliabilityMetrics_Metric'
          description: 99th percentile latency in seconds.
        noDataReason:
          enum:
          - NO_DATA_REASON_UNSPECIFIED
          - NO_DATA_REASON_MISSING_RELIABILITY_METRICS
          type: string
          description: Reason why the metrics are empty, if applicable.
          format: enum
      description: Cluster-level reliability metrics.
    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/budgetsapi_createbudget.md
  - https://docs.cast.ai/reference/budgetsapi_deletebudget.md
  - https://docs.cast.ai/reference/budgetsapi_getbudget.md
  - https://docs.cast.ai/reference/budgetsapi_listbudgets.md
  - https://docs.cast.ai/reference/budgetsapi_previewbudgetcost.md
  - https://docs.cast.ai/reference/budgetsapi_updatebudget.md
  - https://docs.cast.ai/reference/clusterscoreapi_getclusterrestrictiondetails.md
  - https://docs.cast.ai/reference/clusterscoreapi_listclusterrestrictions.md
  - https://docs.cast.ai/reference/containerlivemigrationapi_getcontainerlivemigrationdetail.md
  - https://docs.cast.ai/reference/containerlivemigrationapi_getcontainerlivemigrationsummary.md
  - https://docs.cast.ai/reference/containerlivemigrationapi_listcontainerlivemigrationevents.md
  - https://docs.cast.ai/reference/containerlivemigrationapi_listcontainerlivemigrationfiltervalues.md
  - https://docs.cast.ai/reference/containerlivemigrationapi_listcontainerlivemigrationincompatibleworkloads.md
  - https://docs.cast.ai/reference/containerlivemigrationapi_listcontainerlivemigrations.md
  - https://docs.cast.ai/reference/containerlivemigrationapi_listcontainerlivemigrationworkloads.md
  - https://docs.cast.ai/reference/instanceapi_getinstancessummary.md
  - https://docs.cast.ai/reference/instanceapi_listinstances.md
  - https://docs.cast.ai/reference/nodeconditioneventsapi_listnodeconditionevents.md
  - https://docs.cast.ai/reference/nodetemplateapi_getspotinterruptionpredictionperformancesummary.md
  - https://docs.cast.ai/reference/nodetemplateapi_listnodetemplatesmetrics.md
  - https://docs.cast.ai/reference/nodetemplateapi_listnodetemplatesmetricsfiltered.md
  - https://docs.cast.ai/reference/nodetemplateapi_listspotinterruptionpredictionperformancemetrics.md
  - https://docs.cast.ai/reference/optimizationapi_runclusteroptimizationsreport.md
  - https://docs.cast.ai/reference/reliabilitymetricsapi_getclusterreliabilitymetrics.md
  - https://docs.cast.ai/reference/reliabilitymetricsapi_getorganizationclustersreliabilitymetrics.md
  - https://docs.cast.ai/reference/valuerealizationapi_getbaselineparams.md
  - https://docs.cast.ai/reference/valuerealizationapi_recalculatebaselineparams.md
  - https://docs.cast.ai/reference/valuerealizationapi_runclustersvaluerealizationreport.md
  - https://docs.cast.ai/reference/valuerealizationapi_runvaluerealizationtimelinereport.md
  - https://docs.cast.ai/reference/valuerealizationapi_runworkloadsvaluerealizationreport.md
  - https://docs.cast.ai/reference/valuerealizationapi_updatebaselineparams.md
  merge:
    pages: 31
    deduped: 179
    conflicts_kept_first: 0