---
title: "Reindex list"
method: PUT
path: "/lists/{list_id}/reindex"
tags: ["lists"]
---

# Reindex list

`PUT /lists/{list_id}/reindex`

## Request

- The document declares no server URL.
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/vivino/apis/the-rankdb-api/docs/lists/:list_id/reindex/put.ts> (a function with typed inputs; its response is checked against the schema)

Recreates ID index on entire list

Required security scopes:
  * `api:manage`

## Path parameters

- `list_id` string, required

## Response `200`

OK

- RankdbRanklistFull: Rank List (full view)
  - `avg_segment_elements` number, double, required: Average number of elements per segment
  - `bottom_element` RankdbElement: List Element (default view)
    - `from_bottom` integer, required: Element rank in list from bottom. Bottom element has value 0.
    - `from_top` integer, required: Element rank in list from top. Top element has value 0.
    - `id` integer, required: ID of element
    - `list_id` string, required: The ID of the list to apply the operation on. Can be `a` to `z` (both upper/lower case), `0` to `9` or one of these characters `_-.`
    - `payload` object, required: Custom payload. Stored untouched. On updates null means do not update. `{}` is the empty value.
    - `score` integer, required: Score of the element. Higher score gives higher placement.
    - `tie_breaker` integer, required: Tie breaker, used if score matches for consistent sorting. Higher value = higher placement if score is equal.
    - `updated_at` string, date-time, required: Date of last update
  - `cache_hits` integer, required: Cache hits while segments have been loaded.
  - `cache_misses` integer, required: Cache misses while segments have been loaded.
  - `cache_percent` number, double, required: Cache hit percentage while segments have been loaded.
  - `elements` integer, required: Number of elements in list
  - `id` string, required: The ID of the list to apply the operation on. Can be `a` to `z` (both upper/lower case), `0` to `9` or one of these characters `_-.`
  - `load_index` boolean, required: Load Index on server startup
  - `merge_size` integer, required: Merge adjacent Segments with less than this number of entries
  - `metadata` object, required: Custom metadata. String to String hash.
  - `segments` integer, required: Number of segment in list
  - `set` string, required: Set used for storage
  - `split_size` integer, required: Split Segments larger than this number of entries
  - `top_element` RankdbElement: List Element (default view)
    - `from_bottom` integer, required: Element rank in list from bottom. Bottom element has value 0.
    - `from_top` integer, required: Element rank in list from top. Top element has value 0.
    - `id` integer, required: ID of element
    - `list_id` string, required: The ID of the list to apply the operation on. Can be `a` to `z` (both upper/lower case), `0` to `9` or one of these characters `_-.`
    - `payload` object, required: Custom payload. Stored untouched. On updates null means do not update. `{}` is the empty value.
    - `score` integer, required: Score of the element. Higher score gives higher placement.
    - `tie_breaker` integer, required: Tie breaker, used if score matches for consistent sorting. Higher value = higher placement if score is equal.
    - `updated_at` string, date-time, required: Date of last update

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found

---

[API](https://skmtc.dev/vivino/apis/the-rankdb-api.md) - [All operations](https://skmtc.dev/vivino/apis/the-rankdb-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vivino/apis/the-rankdb-api/revisions/7a45b5309a11?raw)