> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xenovia.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Provider connection health

> Every provider connection of the organisation over the window, from
telemetry: upstream attempts by any agent, failures with a failure class
the runtime fails over on, the last one, and a status (``failing`` at a
failure rate of 50% or more, ``degraded`` at 10% or more, each with at
least 5 attempts; ``idle`` without attempts; else ``healthy``).
``available: false`` with no entries when telemetry cannot be read.



## OpenAPI

````yaml https://cp.xenovia.io/openapi.json get /api/v1/providers/health
openapi: 3.1.0
info:
  title: Xenovia Control Plane API
  version: 1.0.0
  description: >-
    Management API for agents, providers, policies, telemetry, alerts and
    organization settings.
servers:
  - url: https://cp.xenovia.io
    description: Production
security:
  - BearerAuth: []
paths:
  /api/v1/providers/health:
    get:
      tags:
        - providers
      summary: Provider connection health
      description: |-
        Every provider connection of the organisation over the window, from
        telemetry: upstream attempts by any agent, failures with a failure class
        the runtime fails over on, the last one, and a status (``failing`` at a
        failure rate of 50% or more, ``degraded`` at 10% or more, each with at
        least 5 attempts; ``idle`` without attempts; else ``healthy``).
        ``available: false`` with no entries when telemetry cannot be read.
      operationId: provider_health_route_api_v1_providers_health_get
      parameters:
        - name: window
          in: query
          required: false
          schema:
            enum:
              - 15m
              - 1h
              - 24h
            type: string
            description: 15m, 1h or 24h
            default: 15m
            title: Window
          description: 15m, 1h or 24h
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderHealthRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ProviderHealthRead:
      properties:
        window:
          type: string
          enum:
            - 15m
            - 1h
            - 24h
          title: Window
        available:
          type: boolean
          title: Available
          default: true
        providers:
          items:
            $ref: '#/components/schemas/ProviderHealth'
          type: array
          title: Providers
      type: object
      required:
        - window
      title: ProviderHealthRead
      description: |-
        GET /providers/health: every provider connection of the organisation
        over a window, from telemetry. ``available`` is false (and the list
        empty) when the telemetry store cannot be read.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProviderHealth:
      properties:
        provider_id:
          type: string
          format: uuid
          title: Provider Id
        attempts:
          type: integer
          title: Attempts
        failures:
          type: integer
          title: Failures
        failure_rate:
          type: number
          title: Failure Rate
        last_failure_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Failure At
        status:
          type: string
          enum:
            - healthy
            - degraded
            - failing
            - idle
          title: Status
      type: object
      required:
        - provider_id
        - attempts
        - failures
        - failure_rate
        - status
      title: ProviderHealth
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token: an organization API key (`ak_…`) created under Settings →
        API Keys, or a dashboard user session token. Agent keys (`xe_…`) are not
        accepted here. Endpoints marked as user-only in their description reject
        organization keys with `403`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.