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

# Get health

> Read the health signals, objectives, drift and last repair of the Genesys Cloud connection.



## OpenAPI

````yaml get /integrations/genesys/health
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /integrations/genesys/health:
    get:
      summary: Get Genesys Cloud health
      description: >-
        Read the health signals, objectives, drift and last repair of the
        connection. Answers `connected: false` with `health: null` when Genesys
        Cloud is not connected.
      operationId: getGenesysHealth
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenesysHealthEnvelopeDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    GenesysHealthEnvelopeDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/GenesysHealthEnvelopeDto'
      type: object
      properties:
        connected:
          type: boolean
        health:
          anyOf:
            - type: object
              properties:
                status:
                  type: string
                  enum:
                    - healthy
                    - degraded
                    - needs_reconnect
                checked_at:
                  anyOf:
                    - type: string
                    - type: 'null'
                signals:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                        enum:
                          - handoff_failures
                          - relay_failures
                          - call_recordings
                          - webhook
                          - poll
                          - token
                          - drift
                          - directory
                          - threading
                      status:
                        type: string
                        enum:
                          - ok
                          - warn
                          - error
                      at:
                        anyOf:
                          - type: string
                          - type: 'null'
                      value:
                        anyOf:
                          - type: number
                          - type: 'null'
                      code:
                        anyOf:
                          - type: string
                          - type: 'null'
                      fix_step:
                        anyOf:
                          - type: string
                            enum:
                              - messaging
                              - flow
                              - threading
                              - directory
                          - type: 'null'
                    required:
                      - key
                      - status
                      - at
                      - value
                      - code
                      - fix_step
                    additionalProperties: false
                slos:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                        enum:
                          - handoff_delivery
                          - inbound_processing
                          - request_budget
                      target:
                        type: number
                      actual:
                        anyOf:
                          - type: number
                          - type: 'null'
                      status:
                        type: string
                        enum:
                          - met
                          - breached
                          - no_data
                      good:
                        type: number
                      total:
                        type: number
                      window_hours:
                        type: number
                    required:
                      - key
                      - target
                      - actual
                      - status
                      - good
                      - total
                      - window_hours
                    additionalProperties: false
                governor:
                  type: object
                  properties:
                    status:
                      type: string
                      enum:
                        - ok
                        - throttled
                        - circuit_open
                    budget_per_minute:
                      type: number
                    used_in_window:
                      type: number
                    paused_until:
                      anyOf:
                        - type: string
                        - type: 'null'
                    circuit_open_until:
                      anyOf:
                        - type: string
                        - type: 'null'
                    requests_24h:
                      type: number
                    rate_limited_24h:
                      type: number
                    server_errors_24h:
                      type: number
                    circuit_opened_24h:
                      type: number
                    top_rate_limited_endpoints:
                      type: array
                      items:
                        type: object
                        properties:
                          endpoint:
                            type: string
                          count:
                            type: number
                        required:
                          - endpoint
                          - count
                        additionalProperties: false
                  required:
                    - status
                    - budget_per_minute
                    - used_in_window
                    - paused_until
                    - circuit_open_until
                    - requests_24h
                    - rate_limited_24h
                    - server_errors_24h
                    - circuit_opened_24h
                    - top_rate_limited_endpoints
                  additionalProperties: false
                reconnect:
                  type: object
                  properties:
                    required:
                      type: boolean
                    since:
                      anyOf:
                        - type: string
                        - type: 'null'
                    action:
                      anyOf:
                        - type: string
                          enum:
                            - reconnect_oauth
                            - update_credentials
                        - type: 'null'
                  required:
                    - required
                    - since
                    - action
                  additionalProperties: false
                drift:
                  type: object
                  properties:
                    codes:
                      type: array
                      items:
                        type: string
                    repair_steps:
                      type: array
                      items:
                        type: string
                        enum:
                          - messaging
                          - flow
                          - threading
                    last_repair:
                      anyOf:
                        - type: object
                          properties:
                            at:
                              type: string
                            trigger:
                              type: string
                              enum:
                                - auto
                                - manual
                            results:
                              type: array
                              items:
                                type: object
                                properties:
                                  step:
                                    type: string
                                    enum:
                                      - messaging
                                      - flow
                                      - threading
                                  status:
                                    type: string
                                  code:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - step
                                  - status
                                  - code
                                additionalProperties: false
                          required:
                            - at
                            - trigger
                            - results
                          additionalProperties: false
                        - type: 'null'
                  required:
                    - codes
                    - repair_steps
                    - last_repair
                  additionalProperties: false
                expired_events:
                  type: object
                  properties:
                    count:
                      type: number
                    oldest_at:
                      anyOf:
                        - type: string
                        - type: 'null'
                  required:
                    - count
                    - oldest_at
                  additionalProperties: false
                region:
                  type: string
                secrets:
                  type: object
                  properties:
                    messaging_secret_rotation_grace_until:
                      anyOf:
                        - type: string
                        - type: 'null'
                  required:
                    - messaging_secret_rotation_grace_until
                  additionalProperties: false
              required:
                - status
                - checked_at
                - signals
                - slos
                - governor
                - reconnect
                - drift
                - expired_events
                - region
                - secrets
              additionalProperties: false
            - type: 'null'
      required:
        - connected
        - health
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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