Skip to main content
DELETE
/
v1
/
settings
/
metadata-indexes
/
entities
/
{entity_name}
/
key
/
{index_key}
Delete a Metadata Index
curl --request DELETE \
  --url https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}/key/{index_key}
import requests

url = "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}/key/{index_key}"

response = requests.delete(url)

print(response.text)
const options = {method: 'DELETE'};

fetch('https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}/key/{index_key}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}/key/{index_key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}/key/{index_key}"

req, _ := http.NewRequest("DELETE", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}/key/{index_key}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes/entities/{entity_name}/key/{index_key}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

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
index_key
string
required

The metadata key used in the index that you want to delete.

Response

Indicates that the metadata index was successfully deleted.