> ## 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.

# Crear un Índice de Metadatos

> Usa este endpoint para crear un índice de metadatos para un tipo de entidad específico. Los índices de metadatos mejoran el rendimiento de las consultas al filtrar o buscar por campos de metadatos personalizados.



## OpenAPI

````yaml es/openapi/v3-current/ledger.yaml post /v1/settings/metadata-indexes/entities/{entity_name}
openapi: 3.1.0
info:
  title: API de Midaz Ledger
  version: 4.0.0
servers:
  - url: /
security: []
tags:
  - name: Tipos de cuenta (v1)
  - name: Tipos de cuenta (v2)
  - name: Cuentas (v1)
  - name: Cuentas (v2)
  - name: Tasas de activos (v1)
  - name: Activos (v1)
  - name: Activos (v2)
  - name: Saldos (v1)
  - name: Saldos (v2)
  - name: Cálculo de facturación (v2)
  - name: Paquetes de facturación (v2)
  - name: Composición (v2)
  - name: Cifrado (v2)
  - name: Comisiones (v2)
  - name: Titulares (v2)
  - name: Instrumentos (v2)
  - name: Ledgers (v1)
  - name: Ledgers (v2)
  - name: Índices de metadatos (v1)
  - name: Índices de metadatos (v2)
  - name: Rutas de operaciones (v1)
  - name: Rutas de operaciones (v2)
  - name: Operaciones (v1)
  - name: Operaciones (v2)
  - name: Organizaciones (v1)
  - name: Organizaciones (v2)
  - name: Paquetes (v2)
  - name: Carteras (v1)
  - name: Carteras (v2)
  - name: Protección (v2)
  - name: Segmentos (v1)
  - name: Segmentos (v2)
  - name: Rutas de transacciones (v1)
  - name: Rutas de transacciones (v2)
  - name: Transacciones (v1)
  - name: Transacciones (v2)
paths:
  /v1/settings/metadata-indexes/entities/{entity_name}:
    post:
      tags:
        - Índices de metadatos (v1)
      summary: Crear un Índice de Metadatos
      description: >-
        Usa este endpoint para crear un índice de metadatos para un tipo de
        entidad específico. Los índices de metadatos mejoran el rendimiento de
        las consultas al filtrar o buscar por campos de metadatos
        personalizados.
      operationId: createMetadataIndex
      parameters:
        - description: >-
            Entity name (organization, ledger, segment, account, portfolio,
            asset, account_type, transaction, operation, operation_route,
            transaction_route)
          in: path
          name: entity_name
          required: true
          schema:
            description: >-
              Entity name (organization, ledger, segment, account, portfolio,
              asset, account_type, transaction, operation, operation_route,
              transaction_route)
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMetadataIndexInput'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataIndex'
          description: Created
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyError'
          description: Error
      deprecated: true
      security:
        - BearerAuth: []
components:
  schemas:
    CreateMetadataIndexInput:
      additionalProperties: false
      properties:
        metadataKey:
          examples:
            - tier
          type: string
        sparse:
          examples:
            - true
          type:
            - boolean
            - 'null'
        unique:
          examples:
            - false
          type: boolean
      required:
        - metadataKey
        - unique
        - sparse
      type: object
    MetadataIndex:
      additionalProperties: false
      properties:
        entityName:
          examples:
            - transaction
          type: string
        indexName:
          examples:
            - metadata.tier_1
          type: string
        metadataKey:
          examples:
            - tier
          type: string
        sparse:
          examples:
            - true
          type: boolean
        stats:
          $ref: '#/components/schemas/IndexStats'
        unique:
          examples:
            - false
          type: boolean
      required:
        - indexName
        - entityName
        - metadataKey
        - unique
        - sparse
      type: object
    LegacyError:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable midaz error code. Identical to the code /v2
            returns for the same condition.
          examples:
            - '0065'
          type: string
        entityType:
          description: >-
            The domain entity the error concerns. Present only on
            field-validation errors.
          examples:
            - Account
          type: string
        fields:
          additionalProperties: {}
          description: >-
            Per-field validation detail, keyed by field name. The value is the
            violation message for a known field and the offending value for an
            unexpected one, so it is not always a string. The /v2 contract
            carries these as the 'errors' array.
          type: object
        message:
          description: >-
            Human-readable explanation of this occurrence. The /v2 contract
            carries this as 'detail'.
          type: string
        title:
          description: Short, human-readable summary of the error.
          examples:
            - Invalid Path Parameter
          type: string
      required:
        - title
        - message
        - code
      type: object
    IndexStats:
      additionalProperties: false
      properties:
        accesses:
          examples:
            - 1523
          format: int64
          type: integer
        statsSince:
          examples:
            - '2024-12-01T10:30:00Z'
          format: date-time
          type: string
      required:
        - accesses
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````