v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Metadata Indexes API

List Metadata Indexes

Use this endpoint to retrieve all metadata indexes. You can optionally filter the results by entity name.

get/v1/settings/metadata-indexes

Query parameters

entity_namestring

The name of the entity to filter the metadata indexes.

Headers

Content-Typestring

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

X-Request-Idstring uuid

A unique identifier used to trace and track each request.

Authorizationstring

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>

Response

Indicates that the request was successful and the response contains the expected data.

indexNamestring required

The name of the index in the database.

entityNamestring required

The name of the entity associated with the index.

metadataKeystring required

The metadata key used in the index.

uniqueboolean required

Indicates whether the index enforces uniqueness.

sparseboolean required

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

Example response

[
  {
    "indexName": "metadata.tier_1",
    "entityName": "transaction",
    "metadataKey": "tier",
    "sparse": true,
    "stats": {
      "accesses": 150,
      "statsSince": "2024-01-15T10:30:00Z"
    }
  }
]