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

# Listar Índices de Metadatos

> Utilice este endpoint para recuperar todos los índices de metadatos. Opcionalmente puede filtrar los resultados por nombre de entidad.



## OpenAPI

````yaml es/openapi/v3-current/ledger.yaml get /v1/settings/metadata-indexes
openapi: 3.1.0
info:
  title: API de Midaz Ledger
  description: >-
    Referencia completa de la API para los servicios de Midaz Ledger, incluyendo
    gestión de organizaciones, operaciones de ledger, activos, segmentos,
    portafolios, cuentas, tipos de cuenta, transacciones, operaciones, saldos,
    rutas de operación, rutas de transacción e índices de metadatos.
  version: 3.7.8
servers:
  - url: https://ledger.sandbox.lerian.net
security: []
tags:
  - name: Organizations API
  - name: Ledgers API
  - name: Assets API
  - name: Segments API
  - name: Portfolios API
  - name: Account Types API
  - name: Accounts API
  - name: Balances API
  - name: Transactions API
  - name: Operations API
  - name: Operation Routes API
  - name: Transaction Routes API
  - name: Metadata Indexes API
  - name: Holders API
  - name: Instruments API
  - name: Billing Packages API
  - name: Packages API
  - name: Billing Calculation API
  - name: Estimation API
  - name: Encryption API
  - name: Protection API
  - name: Asset Rates API
paths:
  /v1/settings/metadata-indexes:
    get:
      tags:
        - Metadata Indexes API
      summary: Listar Índices de Metadatos
      description: >-
        Utilice este endpoint para recuperar todos los índices de metadatos.
        Opcionalmente puede filtrar los resultados por nombre de entidad.
      parameters:
        - name: entity_name
          in: query
          description: El nombre de la entidad para filtrar los índices de metadatos.
          required: false
          example: transaction
          schema:
            type: string
        - $ref: '#/components/parameters/ContentType'
        - $ref: '#/components/parameters/XRequestId'
        - $ref: '#/components/parameters/Authorization'
      responses:
        '200':
          description: >-
            Indica que la solicitud fue exitosa y la respuesta contiene los
            datos esperados.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetadataIndexWithStatsResponse'
              example:
                - indexName: metadata.tier_1
                  entityName: transaction
                  metadataKey: tier
                  unique: false
                  sparse: true
                  stats:
                    accesses: 150
                    statsSince: '2024-01-15T10:30:00Z'
                - indexName: metadata.externalId_1
                  entityName: account
                  metadataKey: externalId
                  unique: true
                  sparse: false
                  stats:
                    accesses: 1200
                    statsSince: '2024-01-10T08:00:00Z'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0138:
                  $ref: '#/components/examples/Error0138'
          headers: {}
        '401':
          description: No autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0041:
                  $ref: '#/components/examples/Error0041'
                Error0042:
                  $ref: '#/components/examples/Error0042'
        '403':
          description: Prohibido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0043:
                  $ref: '#/components/examples/Error0043'
        '500':
          description: Error Interno del Servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0046:
                  $ref: '#/components/examples/Error0046'
components:
  parameters:
    ContentType:
      name: Content-Type
      in: header
      description: >-
        El tipo de medio del recurso. El valor recomendado es
        `application/json`.
      required: false
      example: application/json
      schema:
        type: string
    XRequestId:
      name: X-Request-Id
      in: header
      description: Un identificador único utilizado para rastrear y seguir cada solicitud.
      required: false
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
        format: uuid
    Authorization:
      name: Authorization
      in: header
      required: false
      schema:
        type: string
      description: >
        Token JWT bearer para autenticación.

        Requerido cuando `PLUGIN_AUTH_ENABLED=true` (obligatorio en despliegues
        multiinquilino).

        Opcional en el modo OSS de inquilino único predeterminado.

        Formato: `Bearer <token>`
  schemas:
    MetadataIndexWithStatsResponse:
      type: object
      description: >-
        El cuerpo de la respuesta para un índice de metadatos incluyendo
        estadísticas de uso.
      required:
        - indexName
        - entityName
        - metadataKey
        - unique
        - sparse
      properties:
        indexName:
          type: string
          description: El nombre del índice en la base de datos.
          examples:
            - metadata.tier_1
        entityName:
          type: string
          description: El nombre de la entidad asociada con el índice.
          examples:
            - transaction
        metadataKey:
          type: string
          description: La clave de metadatos utilizada en el índice.
          examples:
            - tier
        unique:
          type: boolean
          description: Indica si el índice exige unicidad.
          examples:
            - false
        sparse:
          type: boolean
          description: >-
            Indica si el índice es disperso (ignora documentos sin el campo
            indexado).
          examples:
            - true
        stats:
          type: object
          description: Estadísticas de uso del índice.
          required:
            - accesses
          properties:
            accesses:
              type: integer
              description: El número de veces que el índice ha sido accedido.
              examples:
                - 150
            statsSince:
              type: string
              format: date-time
              description: >-
                La fecha y hora desde cuando se están recopilando las
                estadísticas.
              examples:
                - '2024-01-15T10:30:00Z'
    ErrorFormat:
      type: object
      description: El mensaje de error de respuesta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Un identificador único y estable para el error.
        title:
          type: string
          description: Un breve resumen del problema.
        message:
          type: string
          description: Orientación detallada para resolver el error.
        entityType:
          type: string
          description: >-
            El tipo de entidad a la que se refiere el error (p. ej.
            organization, ledger, account, transaction). Opcional.
        fields:
          type: object
          additionalProperties: true
          description: Información adicional sobre los campos que causaron el error.
  examples:
    Error0138:
      summary: Invalid Entity Name
      value:
        code: 138
        title: Invalid Entity Name
        message: >-
          The provided entity name is not valid. Accepted values are:
          organization, ledger, asset, segment, portfolio, account, transaction,
          operation, account_type, operation_route, transaction_route.
    Error0041:
      summary: Token Missing
      value:
        code: '0041'
        title: Token Missing
        message: >-
          A valid token must be provided in the request header. Please include a
          token and try again.
    Error0042:
      summary: Invalid Token
      value:
        code: '0042'
        title: Invalid Token
        message: >-
          The provided token is expired, invalid or malformed. Please provide a
          valid token and try again.
    Error0043:
      summary: Insufficient Privileges
      value:
        code: '0043'
        title: Insufficient Privileges
        message: >-
          You do not have the necessary permissions to perform this action.
          Please contact your administrator if you believe this is an error.
    Error0046:
      summary: Internal Server Error
      value:
        code: '0046'
        title: Internal Server Error
        message: >-
          The server encountered an unexpected error. Please try again later or
          contact support.

````