Sign in

v1

latestSwagger 2.02026-07-17332466.5 KB
lists

Create New List

Create New List. If the list already exists "Conflict" will be returned. The provided populated data may be provided unsorted, but should not contain duplicate element IDs.

Required security scopes:

  • api:manage
post/lists

Query parameters

replaceboolean

Replace list if exists.

Request body

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

load_indexboolean

Load Index on server startup

merge_sizeinteger

Merge adjacent Segments with less than this number of entries

metadataobject

Custom metadata. String to String hash.

setstring required

Set used for storage

split_sizeinteger

Split Segments larger than this number of entries

Example request

{
  "id": "highscore-list",
  "load_index": false,
  "merge_size": 500,
  "metadata": {
    "country": "dk",
    "game": "2"
  },
  "populate": [
    {
      "id": 100,
      "payload": {
        "country": "dk",
        "name": "Mark Anthony"
      },
      "score": 100,
      "tie_breaker": 2000
    },
    {
      "id": 100,
      "payload": {
        "country": "dk",
        "name": "Mark Anthony"
      },
      "score": 100,
      "tie_breaker": 2000
    }
  ],
  "set": "storage-set",
  "split_size": 2000
}

Response

OK