lists

Verify list

Verify the list and its elements and optionally repair it. All write access to the list is blocked while operation runs.

Required security scopes:

api:manage

put/lists/{list_id}/verify

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/verify/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

list_idstring 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 _-.

Query parameters

clearboolean

Clear list if unable to repair

repairboolean

Attempt to repair list

Response

errorstring

Error, if any encountered

Example response

{
  "error": "not found",
  "list": {
    "id": "highscore-list",
    "load_index": false,
    "merge_size": 500,
    "metadata": {
      "country": "dk",
      "game": "2"
    },
    "set": "storage-set",
    "split_size": 2000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.