Canopy Health Check API

openapi: 3.2.0
info:
  title: Canopy Servicing Core Healthcheck API
  description: 'Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective -

    whether newly launched or migrated from existing systems. using canopy, you can track balances and transactions for each customer of your product, both in real-time and historically.

    You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

    Canopy additionally surfaces information around all of your lending activity through its intuitive ui which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

    Simply configure your product`s policies through our create product api endpoint, and then you can immediately begin adding customer accounts and relying on canopy for accurate servicing information.'
  contact:
    name: Canopy Support
    url: https://www.canopyservicing.com/contact
    email: support@canopyservicing.com
  version: 1.0.0
servers:
- url: Contact sales to enable your sandbox
  description: Your private sandbox environment
- url: https://demo-api.us.canopyservicing.com
  description: Demo environment
tags:
- name: Health Check
paths:
  /public/v1/health-check:
    get:
      tags:
      - Health Check
      summary: Check health of the application (reader and writer DB endpoints)
      description: Checks the health of the application by performing a full healthcheck.
      operationId: HealthCheckCBV_healthcheck_public_v1_health_check_get
      responses:
        '200':
          description: Returns the health of the application
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthcheckResponse'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
components:
  schemas:
    HealthcheckResponse:
      properties:
        status:
          type: string
          enum:
          - healthy
          - unhealthy
          title: Status
        database:
          additionalProperties:
            $ref: '#/components/schemas/ComponentHealth'
          type: object
          title: Database
      type: object
      required:
      - status
      - database
      title: HealthcheckResponse
      description: Response schema for the get health-check endpoint.
    ComponentHealth:
      properties:
        status:
          type: string
          enum:
          - healthy
          - unhealthy
          title: Status
        error:
          type: string
          title: Error
      type: object
      required:
      - status
      title: ComponentHealth
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer