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.
Headers
The type of media of the resource. Recommended value is application/json.
A unique identifier used to trace and track each request.
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
The name of the entity for which the metadata index will be created or managed.
organization, ledger, asset, segment, portfolio, account, transaction, operation, account_type, operation_route, transaction_route Body
The request body to create a metadata index.
The metadata key to be indexed. This key must match the metadata field name used in your entities.
100^[a-zA-Z][a-zA-Z0-9_]*$"tier"
Indicates whether the index enforces uniqueness. When set to true, duplicate values for this metadata key will not be allowed.
false
Indicates whether the index is sparse. When set to true, only documents containing the indexed field will be included in the index.
true
Response
Indicates that the metadata index was successfully created and the operation was completed as expected.
The response body for a metadata index.
The name of the index in the database.
"metadata.tier_1"
The name of the entity associated with the index.
"transaction"
The metadata key used in the index.
"tier"
Indicates whether the index enforces uniqueness.
false
Indicates whether the index is sparse (ignores documents without the indexed field).
true

