Create a Metadata Index

Use this endpoint to create a metadata index for a specific entity type. Metadata indexes improve query performance when filtering or searching by custom metadata fields.

POST /v1/settings/metadata-indexes/entities/{entity_name}

Create a Metadata Index

cURL

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadataKey": "tier",
  "unique": false,
  "sparse": true
}
'

201

Example

{
  "indexName": "metadata.tier_1",
  "entityName": "transaction",
  "metadataKey": "tier",
  "unique": false,
  "sparse": true
}

Headers

Content-Type · string

The type of media of the resource. Recommended value is application/json.

X-Request-Id · string<uuid>

A unique identifier used to trace and track each request.

Authorization · string

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Path Parameters

entity_name · enum<string> · required

The name of the entity for which the metadata index will be created or managed.

Available options: organization, ledger, asset, segment, portfolio, account, transaction, operation, account_type, operation_route, transaction_route

Body

application/json

The request body to create a metadata index.

metadataKey · string · required

The metadata key to be indexed. This key must match the metadata field name used in your entities.

Maximum string length: 100

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

Example:

"tier"

unique · boolean · default: false

Indicates whether the index enforces uniqueness. When set to true, duplicate values for this metadata key will not be allowed.

Example:

false

sparse · boolean · default: true

Indicates whether the index is sparse. When set to true, only documents containing the indexed field will be included in the index.

Example:

true

Response

201

application/json

Indicates that the metadata index was successfully created and the operation was completed as expected.

The response body for a metadata index.

indexName · string · required

The name of the index in the database.

Example:

"metadata.tier_1"

entityName · string · required

The name of the entity associated with the index.

Example:

"transaction"

metadataKey · string · required

The metadata key used in the index.

Example:

"tier"

unique · boolean · required

Indicates whether the index enforces uniqueness.

Example:

false

sparse · boolean · required

Indicates whether the index is sparse (ignores documents without the indexed field).

Example:

true