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

# Create Metadata Index



## OpenAPI

````yaml en/openapi/v3-current/ledger.yaml post /v2/settings/metadata-indexes/entities/{entity_name}
openapi: 3.1.0
info:
  title: Midaz Ledger API
  version: 4.0.0
servers:
  - url: /
security: []
tags:
  - name: Account Types (v1)
  - name: Account Types (v2)
  - name: Accounts (v1)
  - name: Accounts (v2)
  - name: Asset Rates (v1)
  - name: Assets (v1)
  - name: Assets (v2)
  - name: Balances (v1)
  - name: Balances (v2)
  - name: Billing Calculate (v2)
  - name: Billing Packages (v2)
  - name: Composition (v2)
  - name: Encryption (v2)
  - name: Fees (v2)
  - name: Holders (v2)
  - name: Instruments (v2)
  - name: Ledgers (v1)
  - name: Ledgers (v2)
  - name: Metadata Indexes (v1)
  - name: Metadata Indexes (v2)
  - name: Operation Routes (v1)
  - name: Operation Routes (v2)
  - name: Operations (v1)
  - name: Operations (v2)
  - name: Organizations (v1)
  - name: Organizations (v2)
  - name: Packages (v2)
  - name: Portfolios (v1)
  - name: Portfolios (v2)
  - name: Protection (v2)
  - name: Segments (v1)
  - name: Segments (v2)
  - name: Transaction Routes (v1)
  - name: Transaction Routes (v2)
  - name: Transactions (v1)
  - name: Transactions (v2)
paths:
  /v2/settings/metadata-indexes/entities/{entity_name}:
    post:
      tags:
        - Metadata Indexes (v2)
      summary: Create Metadata Index
      operationId: createMetadataIndexV2
      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/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Error
      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
    Error:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      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
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````