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

# Readiness check

> Comprehensive readiness check that verifies all system dependencies are available.

**Dependencies Checked**:
- Database connectivity
- Redis cache connectivity
- Cerbos authorization service connectivity

**Use Cases**:
- Kubernetes readiness probes
- Load balancer health checks
- Service mesh health verification
- Deployment validation



## OpenAPI

````yaml https://raw.githubusercontent.com/prefeitura-rio/heimdall/main/docs/api/openapi.json get /api/v1/readyz
openapi: 3.1.0
info:
  title: Heimdall Admin Service
  description: >-
    # Heimdall Admin Service API


    A comprehensive admin service for user and group management with
    authorization powered by Cerbos.


    ## Features


    - **User Management**: Automatic user creation from JWT tokens with
    role-based access control

    - **Group Management**: Create, manage, and assign users to groups with
    hierarchical permissions

    - **Role Management**: Define and assign roles to users and groups

    - **Mapping Management**: Configure API endpoint to action mappings for
    authorization

    - **Action Management**: Define available actions for fine-grained
    permission control

    - **Cerbos Integration**: Policy-based authorization with external Cerbos
    service

    - **Audit Logging**: Comprehensive audit trail for all administrative
    operations

    - **Redis Caching**: High-performance caching for frequently accessed data
  version: 1.0.0
servers:
  - url: https://services.pref.rio/heimdall-admin
    description: Production server
  - url: https://services.staging.app.dados.rio/heimdall-admin
    description: Staging server
security: []
tags:
  - name: health
    description: Service health and readiness checks
  - name: users
    description: >-
      User management operations. Users are automatically created from JWT
      tokens.
  - name: groups
    description: >-
      Group management operations. Groups organize users and can have roles
      assigned.
  - name: memberships
    description: Group membership management. Assign and remove users from groups.
  - name: roles
    description: >-
      Role management operations. Roles define permissions that can be assigned
      to users or groups.
  - name: actions
    description: >-
      Action management operations. Actions define the granular permissions
      available in the system.
  - name: mappings
    description: >-
      API endpoint to action mapping configuration. Maps HTTP endpoints to
      authorization actions.
paths:
  /api/v1/readyz:
    get:
      tags:
        - health
        - health
      summary: Readiness check
      description: >-
        Comprehensive readiness check that verifies all system dependencies are
        available.


        **Dependencies Checked**:

        - Database connectivity

        - Redis cache connectivity

        - Cerbos authorization service connectivity


        **Use Cases**:

        - Kubernetes readiness probes

        - Load balancer health checks

        - Service mesh health verification

        - Deployment validation
      operationId: readiness_check_api_v1_readyz_get
      responses:
        '200':
          description: Service is ready and all dependencies are healthy
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Readiness Check Api V1 Readyz Get
              example:
                status: ready
                service: heimdall-admin-service
                timestamp: '2024-01-01T12:00:00.000Z'
                dependencies:
                  database: healthy
                  redis: healthy
                  cerbos: healthy
        '503':
          description: Service unavailable - one or more dependencies are unhealthy
          content:
            application/json:
              example:
                status: not_ready
                service: heimdall-admin-service
                timestamp: '2024-01-01T12:00:00.000Z'
                dependencies:
                  database: healthy
                  redis: unhealthy
                  cerbos: healthy
                errors:
                  - 'Redis connection failed: Connection refused'

````