Forithmus

Forithmus Health API

The Health API from Forithmus — 2 operation(s) for health.

GitHub OpenAPI

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/forithmus/refs/heads/main/openapi/forithmus-health-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/forithmus/refs/heads/main/errors/forithmus-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/forithmus/refs/heads/main/data-model/forithmus-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/forithmus/refs/heads/main/conventions/forithmus-conventions.yml

OpenAPI Specification

forithmus-health-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Forithmus Challenge Platform 2fa Health API
  version: 1.0.0
tags:
- name: Health
paths:
  /health:
    get:
      summary: Health
      description: 'Quick health check: just confirms the API process is alive.'
      operationId: health_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Health
  /health/deep:
    get:
      summary: Health Deep
      description: 'Deep health check: verifies DB, Redis, and Celery workers are reachable.

        Used by monitoring systems. Returns 503 if any dependency is down.'
      operationId: health_deep_health_deep_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Health